{
  "openapi": "3.1.0",
  "info": {
    "title": "Moneybird API",
    "description": "The Moneybird API allows you to interact with a Moneybird account in a RESTful manner. For comprehensive and up-to-date information on authentication, endpoints, usage, webhooks, and best practices, please refer to the documentation at [developer.moneybird.com](https://developer.moneybird.com). All details, examples, and guides are available on their respective pages.",
    "version": "v2-20261102-511ae04b86",
    "termsOfService": "https://www.moneybird.nl/terms/",
    "contact": {
      "name": "Moneybird",
      "email": "support@moneybird.com",
      "url": "https://developer.moneybird.com"
    }
  },
  "servers": [
    {
      "url": "https://moneybird.com/api/v2",
      "description": "Production server"
    }
  ],
  "security": [
    {
      "bearerAuth": []
    }
  ],
  "tags": [
    {
      "name": "Administrations",
      "description": "Administrations are the top level entities in Moneybird. Use the following endpoints to get\ninformation about the administrations you have access to."
    },
    {
      "name": "Assets",
      "description": "Assets are significant purchases, like company cars, laptops or furniture, that are used over\nmultiple years. They are recorded to manage depreciation and comply with tax regulations."
    },
    {
      "name": "Contacts",
      "description": "Contacts are the entities in Moneybird that represent your customers, suppliers or other\nbusiness relations. Use the following endpoints to get information about contacts, create\nnew contacts or update existing contacts."
    },
    {
      "name": "Custom fields",
      "description": "Custom fields can be used to add extra information to sales invoices, contacts and identities."
    },
    {
      "name": "Customer contact portal",
      "description": "The customer contact portal allows you to create temporary links to the customer contact\nportal. Allowing your customers to view their invoices, subscriptions and other related information."
    },
    {
      "name": "Document styles",
      "description": "Document styles are used to define the layout of documents, like invoices and estimates. You\ncan have multiple document styles for different purposes."
    },
    {
      "name": "Downloads",
      "description": "Downloads are files that have been generated as exports from your administration. These can be\nCSV exports of contacts, sales invoices, time entries, or various financial reports. Use these\nendpoints to retrieve a list of available downloads and to download the files."
    },
    {
      "name": "Documents: General documents",
      "description": "General documents are documents that are not invoices, estimates, or other specific document\ntypes. They can be used to store other financial documents."
    },
    {
      "name": "Documents: General journal documents",
      "description": "General journal documents are used for manual bookkeeping entries, to correct errors or make\nadjustments."
    },
    {
      "name": "Documents: Purchase invoices",
      "description": "Purchase invoices are invoices you receive from your suppliers."
    },
    {
      "name": "Documents: Receipts",
      "description": "Receipts are proofs of payment for expenses."
    },
    {
      "name": "Documents: Typeless documents",
      "description": "Typeless documents are documents of which the type is not yet known. For example, a document\nuploaded via email or via the bulk uploader. It is not possible to update a typeless\ndocument, except for adding attachments. You will need to set its type first. You cannot set\nthe type of typeless documents using the API yet, but you can do this via the website."
    },
    {
      "name": "Estimates",
      "description": "Estimates (or quotes) are proposals for products or services that you can send to your\nclients."
    },
    {
      "name": "External sales invoices",
      "description": "External sales invoices are invoices created in other systems that you want to import into\nMoneybird for a complete overview of your revenue."
    },
    {
      "name": "Financial accounts",
      "description": "Financial accounts represent your bank accounts, credit cards, private withdrawals/deposits\nand other payment services. They are used to track payments and financial mutations."
    },
    {
      "name": "Financial mutations",
      "description": "Financial mutations are the transactions on your financial accounts."
    },
    {
      "name": "Financial statements",
      "description": "Financial statements are comprised of financial mutations that are booked on a financial\naccount. They provide a detailed record of all transactions for a specific account."
    },
    {
      "name": "Identities",
      "description": "Identities are the different profiles or trade names under which you can send documents from\nyour administration."
    },
    {
      "name": "Ledger accounts",
      "description": "Ledger accounts are the categories in your bookkeeping, like revenue, costs, assets, and\nliabilities."
    },
    {
      "name": "Payments",
      "description": "Payments are records of money being transferred for invoices."
    },
    {
      "name": "Products",
      "description": "Products are the goods or services you sell. You can add them to invoices and estimates."
    },
    {
      "name": "Projects",
      "description": "Projects allow you to group time entries and financials for specific projects you are working\non."
    },
    {
      "name": "Purchase transactions",
      "description": "Purchase transactions are outgoing payments you initiate from Moneybird"
    },
    {
      "name": "Recurring sales invoices",
      "description": "Recurring sales invoices are templates for invoices that are sent automatically at a\nrecurring interval."
    },
    {
      "name": "Reports",
      "description": "Reports provide analytical data about your administration, such as revenue and expense\nbreakdowns by various dimensions like projects, contacts, or time periods."
    },
    {
      "name": "Sales invoices",
      "description": "Sales invoices are the invoices you send to your customers for products or services you have\ndelivered."
    },
    {
      "name": "Subscription templates",
      "description": "Subscription templates define the products and prices for subscriptions."
    },
    {
      "name": "Subscriptions",
      "description": "Subscriptions allow you to automatically invoice customers on a recurring basis for the\nservices you provide."
    },
    {
      "name": "Task lists",
      "description": "Task lists help you organize and track work within an administration. They contain\ngroups of tasks that can be assigned to users and tracked for completion."
    },
    {
      "name": "Task list templates",
      "description": "Task list templates are reusable blueprints for creating task lists with predefined\ngroups and tasks."
    },
    {
      "name": "Tax rates",
      "description": "Tax rates are the VAT tariffs that apply to your products and services."
    },
    {
      "name": "Time entries",
      "description": "Time entries are used to track time spent on projects, which can then be billed to\ncustomers."
    },
    {
      "name": "Users",
      "description": "Administrations can have multiple users. Use the following endpoints to get information about\nthe users in an administration."
    },
    {
      "name": "Verifications",
      "description": "Verifications are used to retrieve all verified information within an administration, such as\ne-mail addresses, bank account numbers, Chamber of Commerce numbers, and tax numbers."
    },
    {
      "name": "Webhooks",
      "description": "Webhooks are a way to subscribe to events that happen in Moneybird. When an event occurs,\nMoneybird will send a POST request to the URL you provided. This way, you can keep your own\nsystem in sync with Moneybird.\n\nFor example, you can subscribe to the `contact_created` event to receive a notification when\na new contact is created in Moneybird.\n\nFor a full list of available events and event groups, see the [webhook events documentation](https://developer.moneybird.com/webhooks/events)."
    },
    {
      "name": "Workflows",
      "description": "Workflows determine the settings of the invoice and estimate workflow. Use the following\nto get information about the workflows in an administration."
    }
  ],
  "paths": {
    "/administrations{format}": {
      "get": {
        "summary": "List all administrations",
        "description": "Lists all administrations the current user has access to.",
        "tags": [
          "Administrations"
        ],
        "security": [
          {
            "bearerAuth": []
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/format"
          }
        ],
        "responses": {
          "200": {
            "description": "A list of administrations",
            "content": {
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "$ref": "#/components/schemas/administration_response"
                  }
                },
                "examples": {
                  "ReturnsAccessTypeUserWhenHavingDirectAccessToTheAdministration": {
                    "summary": "Returns access type user when having direct access to the administration",
                    "value": [
                      {
                        "id": "179362188211184160",
                        "name": "Parkietje B.V.",
                        "language": "nl",
                        "currency": "EUR",
                        "country": "NL",
                        "time_zone": "Europe/Amsterdam",
                        "access": "user",
                        "suspended": false,
                        "period_locked_until": null,
                        "period_start_date": "2026-01-01"
                      }
                    ]
                  },
                  "ValidatesThatAUserHasAccessToMultipleAdministrationsViaDifferentWays": {
                    "summary": "Validates that a user has access to multiple administrations via different ways",
                    "value": [
                      {
                        "id": "179362188286732003",
                        "name": "Administratie",
                        "language": "nl",
                        "currency": "EUR",
                        "country": "NL",
                        "time_zone": "Europe/Amsterdam",
                        "access": "accountant_company",
                        "suspended": false,
                        "period_locked_until": null,
                        "period_start_date": "2026-01-01"
                      },
                      {
                        "id": 123,
                        "name": "Parkietje B.V.",
                        "language": "nl",
                        "currency": "EUR",
                        "country": "NL",
                        "time_zone": "Europe/Amsterdam",
                        "access": "user",
                        "suspended": false,
                        "period_locked_until": null,
                        "period_start_date": "2026-01-01"
                      }
                    ]
                  },
                  "ReturnAListOfAdministrationsThatUserHasAccessTo": {
                    "summary": "Return a list of administrations that user has access to",
                    "value": [
                      {
                        "id": "179362188247880352",
                        "name": "Administratie",
                        "language": "nl",
                        "currency": "EUR",
                        "country": "NL",
                        "time_zone": "Europe/Amsterdam",
                        "access": "user",
                        "suspended": false,
                        "period_locked_until": null,
                        "period_start_date": "2026-01-01"
                      },
                      {
                        "id": 123,
                        "name": "Parkietje B.V.",
                        "language": "nl",
                        "currency": "EUR",
                        "country": "NL",
                        "time_zone": "Europe/Amsterdam",
                        "access": "user",
                        "suspended": false,
                        "period_locked_until": null,
                        "period_start_date": "2026-01-01"
                      }
                    ]
                  }
                }
              }
            }
          }
        },
        "operationId": "get_administrations"
      }
    },
    "/{administration_id}/assets/{id}/disposals{format}": {
      "post": {
        "summary": "Create a disposal",
        "description": "Creates a disposal for the asset at the given date.\nRequires the asset to not have a disposal already.\nFurthermore, the asset must be fully depreciated so the value of the asset at the disposal date must be zero.\n\n### Required scope(s)\n `documents`",
        "tags": [
          "Assets"
        ],
        "security": [
          {
            "bearerAuth": [
              "documents"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/administration_id"
          },
          {
            "name": "id",
            "in": "path",
            "required": true,
            "schema": {
              "$ref": "#/components/schemas/identifier"
            }
          },
          {
            "$ref": "#/components/parameters/format"
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/*": {
              "schema": {
                "type": "object",
                "unevaluatedProperties": false,
                "properties": {
                  "date": {
                    "type": "string",
                    "format": "date",
                    "description": "Has to be after the purchase date of the asset, and cannot be in the future or in the locked period of the administration."
                  },
                  "reason": {
                    "type": "string",
                    "enum": [
                      "out_of_use",
                      "sold",
                      "private_withdrawal",
                      "divested"
                    ]
                  }
                },
                "required": [
                  "date",
                  "reason"
                ]
              },
              "examples": {
                "AddsADisposal": {
                  "summary": "Adds a disposal",
                  "value": {
                    "date": "2026-11-02",
                    "reason": "out_of_use"
                  }
                }
              }
            }
          }
        },
        "responses": {
          "201": {
            "description": "A disposal",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/disposal_response"
                },
                "examples": {
                  "AddsADisposal": {
                    "summary": "Adds a disposal",
                    "value": {
                      "date": "2026-11-02",
                      "reason": "out_of_use",
                      "externally_booked": false,
                      "asset_id": "502689259610703199",
                      "reinvestment_reserve_sale": null
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "Bad request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/symbolic_error"
                },
                "examples": {
                  "ReturnsA400IfTheReasonIsInvalid": {
                    "summary": "Returns a 400 if the reason is invalid",
                    "value": {
                      "error": "reason does not have a valid value"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Not found",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/symbolic_error"
                },
                "examples": {
                  "ReturnsA404IfTheAssetDoesNotExist": {
                    "summary": "Returns a 404 if the asset does not exist",
                    "value": {
                      "error": "Record not found for model name: asset"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "Unprocessable entity",
            "content": {
              "application/json": {
                "schema": {
                  "anyOf": [
                    {
                      "$ref": "#/components/schemas/symbolic_error"
                    },
                    {
                      "$ref": "#/components/schemas/non_symbolic_error"
                    }
                  ]
                },
                "examples": {
                  "ReturnsA422TheAssetIsNotInvalid": {
                    "summary": "Returns a 422 the asset is not invalid",
                    "value": {
                      "error": {
                        "date": [
                          "is invalid, asset is not fully depreciated on this date"
                        ]
                      },
                      "details": {
                        "date": [
                          {
                            "error": "invalid_asset_not_fully_depreciated"
                          }
                        ]
                      }
                    }
                  }
                }
              }
            }
          }
        },
        "operationId": "post_administration_id_assets_id_disposals"
      }
    },
    "/{administration_id}/assets/{id}/reinvestment_reserve_purchase{format}": {
      "post": {
        "summary": "Create a reinvestment reserve purchase",
        "description": "Records that part of the asset's purchase value is funded from the\nreinvestment reserve (\"herinvesteringsreserve\"). The amount cannot exceed\nthe asset's depreciatable value (purchase value minus residual value), and\nthe asset's purchase date may not lie in the locked period. An asset can\nhave only one reinvestment reserve purchase.\n\n### Required scope(s)\n `documents`",
        "tags": [
          "Assets"
        ],
        "security": [
          {
            "bearerAuth": [
              "documents"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/administration_id"
          },
          {
            "name": "id",
            "in": "path",
            "required": true,
            "schema": {
              "$ref": "#/components/schemas/identifier"
            }
          },
          {
            "$ref": "#/components/parameters/format"
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/*": {
              "schema": {
                "type": "object",
                "unevaluatedProperties": false,
                "properties": {
                  "amount": {
                    "$ref": "#/components/schemas/money",
                    "description": "The amount taken from the reinvestment reserve."
                  }
                },
                "required": [
                  "amount"
                ]
              },
              "examples": {
                "CreatesAReinvestmentReservePurchase": {
                  "summary": "Creates a reinvestment reserve purchase",
                  "value": {
                    "amount": 100
                  }
                }
              }
            }
          }
        },
        "responses": {
          "201": {
            "description": "A reinvestment reserve purchase",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/reinvestment_reserve_purchase_response"
                },
                "examples": {
                  "CreatesAReinvestmentReservePurchase": {
                    "summary": "Creates a reinvestment reserve purchase",
                    "value": {
                      "id": "502689247783814940",
                      "amount": "100.0",
                      "date": "2026-06-01",
                      "asset_id": "502689247467144945"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "Bad request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/symbolic_error"
                },
                "examples": {
                  "ReturnsA400IfTheAmountIsNegative": {
                    "summary": "Returns a 400 if the amount is negative",
                    "value": {
                      "error": "Amount does not have a valid value"
                    }
                  },
                  "ReturnsA400IfTheAmountIsMissing": {
                    "summary": "Returns a 400 if the amount is missing",
                    "value": {
                      "error": "Amount is missing, Amount does not have a valid value"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Not found",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/symbolic_error"
                },
                "examples": {
                  "ReturnsA404IfTheAssetDoesNotExist": {
                    "summary": "Returns a 404 if the asset does not exist",
                    "value": {
                      "error": "Record not found for model name: asset"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "Unprocessable entity",
            "content": {
              "application/json": {
                "schema": {
                  "anyOf": [
                    {
                      "$ref": "#/components/schemas/symbolic_error"
                    },
                    {
                      "$ref": "#/components/schemas/non_symbolic_error"
                    }
                  ]
                },
                "examples": {
                  "ReturnsA422IfTheAmountExceedsTheDepreciatableValue": {
                    "summary": "Returns a 422 if the amount exceeds the depreciatable value",
                    "value": {
                      "error": {
                        "amount": [
                          "cannot exceed the purchase value minus the residual value",
                          "cannot exceed the available reinvestment reserve"
                        ]
                      },
                      "details": {
                        "amount": [
                          {
                            "error": "exceeds_depreciatable_value"
                          },
                          {
                            "error": "exceeds_available_reserve"
                          }
                        ]
                      }
                    }
                  }
                }
              }
            }
          }
        },
        "operationId": "post_administration_id_assets_id_reinvestment_reserve_purchase"
      },
      "delete": {
        "summary": "Delete a reinvestment reserve purchase",
        "description": "Removes the reinvestment reserve purchase from the asset.\n\n### Required scope(s)\n `documents`",
        "tags": [
          "Assets"
        ],
        "security": [
          {
            "bearerAuth": [
              "documents"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/administration_id"
          },
          {
            "name": "id",
            "in": "path",
            "required": true,
            "schema": {
              "$ref": "#/components/schemas/identifier"
            }
          },
          {
            "$ref": "#/components/parameters/format"
          }
        ],
        "responses": {
          "204": {
            "description": "Reinvestment reserve purchase deleted"
          },
          "404": {
            "description": "Not found",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/symbolic_error"
                },
                "examples": {
                  "ReturnsA404IfTheAssetDoesNotExist": {
                    "summary": "Returns a 404 if the asset does not exist",
                    "value": {
                      "error": "Record not found for model name: asset"
                    }
                  },
                  "ReturnsA404IfTheAssetHasNoReinvestmentReservePurchase": {
                    "summary": "Returns a 404 if the asset has no reinvestment reserve purchase",
                    "value": {
                      "error": "Not Found"
                    }
                  }
                }
              }
            }
          }
        },
        "operationId": "delete_administration_id_assets_id_reinvestment_reserve_purchase"
      }
    },
    "/{administration_id}/assets/{id}/reinvestment_reserve_sale{format}": {
      "post": {
        "summary": "Create a reinvestment reserve sale",
        "description": "Books the book result of the asset's disposal to the reinvestment reserve\n(\"herinvesteringsreserve\"). Requires the asset to have a disposal without a\nreinvestment reserve sale, and the disposal date may not lie in the locked\nperiod.\n\n### Required scope(s)\n `documents`",
        "tags": [
          "Assets"
        ],
        "security": [
          {
            "bearerAuth": [
              "documents"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/administration_id"
          },
          {
            "name": "id",
            "in": "path",
            "required": true,
            "schema": {
              "$ref": "#/components/schemas/identifier"
            }
          },
          {
            "$ref": "#/components/parameters/format"
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/*": {
              "schema": {
                "type": "object",
                "unevaluatedProperties": false,
                "properties": {
                  "amount": {
                    "$ref": "#/components/schemas/money",
                    "description": "The amount of the book result booked to the reinvestment reserve."
                  }
                },
                "required": [
                  "amount"
                ]
              },
              "examples": {
                "CreatesAReinvestmentReserveSale": {
                  "summary": "Creates a reinvestment reserve sale",
                  "value": {
                    "amount": 100
                  }
                }
              }
            }
          }
        },
        "responses": {
          "201": {
            "description": "A reinvestment reserve sale",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/reinvestment_reserve_sale_response"
                },
                "examples": {
                  "CreatesAReinvestmentReserveSale": {
                    "summary": "Creates a reinvestment reserve sale",
                    "value": {
                      "id": "502689261509674542",
                      "amount": "100.0",
                      "date": "2026-11-02",
                      "disposal_id": "502689261491848742"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "Bad request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/symbolic_error"
                },
                "examples": {
                  "ReturnsA400IfTheAmountIsNegative": {
                    "summary": "Returns a 400 if the amount is negative",
                    "value": {
                      "error": "Amount does not have a valid value"
                    }
                  },
                  "ReturnsA400IfTheAmountIsMissing": {
                    "summary": "Returns a 400 if the amount is missing",
                    "value": {
                      "error": "Amount is missing, Amount does not have a valid value"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Not found",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/symbolic_error"
                },
                "examples": {
                  "ReturnsA404IfTheAssetDoesNotExist": {
                    "summary": "Returns a 404 if the asset does not exist",
                    "value": {
                      "error": "Record not found for model name: asset"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "Unprocessable entity",
            "content": {
              "application/json": {
                "schema": {
                  "anyOf": [
                    {
                      "$ref": "#/components/schemas/symbolic_error"
                    },
                    {
                      "$ref": "#/components/schemas/non_symbolic_error"
                    }
                  ]
                },
                "examples": {
                  "ReturnsA422IfTheAssetHasNoDisposal": {
                    "summary": "Returns a 422 if the asset has no disposal",
                    "value": {
                      "error": "Asset has no disposal"
                    }
                  }
                }
              }
            }
          }
        },
        "operationId": "post_administration_id_assets_id_reinvestment_reserve_sale"
      },
      "delete": {
        "summary": "Delete a reinvestment reserve sale",
        "description": "Removes the reinvestment reserve sale from the asset's disposal.\n\n### Required scope(s)\n `documents`",
        "tags": [
          "Assets"
        ],
        "security": [
          {
            "bearerAuth": [
              "documents"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/administration_id"
          },
          {
            "name": "id",
            "in": "path",
            "required": true,
            "schema": {
              "$ref": "#/components/schemas/identifier"
            }
          },
          {
            "$ref": "#/components/parameters/format"
          }
        ],
        "responses": {
          "204": {
            "description": "Reinvestment reserve sale deleted"
          },
          "404": {
            "description": "Not found",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/symbolic_error"
                },
                "examples": {
                  "ReturnsA404IfTheAssetDoesNotExist": {
                    "summary": "Returns a 404 if the asset does not exist",
                    "value": {
                      "error": "Record not found for model name: asset"
                    }
                  },
                  "ReturnsA404IfTheAssetSDisposalHasNoReinvestmentReserveSale": {
                    "summary": "Returns a 404 if the asset's disposal has no reinvestment reserve sale",
                    "value": {
                      "error": "Not Found"
                    }
                  },
                  "ReturnsA404IfTheAssetHasNoDisposal": {
                    "summary": "Returns a 404 if the asset has no disposal",
                    "value": {
                      "error": "Not Found"
                    }
                  }
                }
              }
            }
          }
        },
        "operationId": "delete_administration_id_assets_id_reinvestment_reserve_sale"
      }
    },
    "/{administration_id}/assets/{id}/sources/{source_id}{format}": {
      "delete": {
        "summary": "Delete a source",
        "description": "Deletes a source from an asset. Does not delete the detail or the asset\n\n### Required scope(s)\n `documents`",
        "tags": [
          "Assets"
        ],
        "security": [
          {
            "bearerAuth": [
              "documents"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/administration_id"
          },
          {
            "name": "id",
            "in": "path",
            "required": true,
            "schema": {
              "$ref": "#/components/schemas/identifier"
            }
          },
          {
            "name": "source_id",
            "in": "path",
            "required": true,
            "schema": {
              "$ref": "#/components/schemas/identifier"
            }
          },
          {
            "$ref": "#/components/parameters/format"
          }
        ],
        "responses": {
          "204": {
            "description": "Source deleted"
          },
          "404": {
            "description": "Not found",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/symbolic_error"
                },
                "examples": {
                  "ReturnsA404IfTheSourceDoesNotExist": {
                    "summary": "Returns a 404 if the source does not exist",
                    "value": {
                      "error": "Record not found for model name: Source"
                    }
                  },
                  "ReturnsA404IfTheAssetDoesNotExist": {
                    "summary": "Returns a 404 if the asset does not exist",
                    "value": {
                      "error": "Record not found for model name: asset"
                    }
                  }
                }
              }
            }
          }
        },
        "operationId": "delete_administration_id_assets_id_sources_source_id"
      }
    },
    "/{administration_id}/assets/{id}/sources{format}": {
      "post": {
        "summary": "Add a source to an asset",
        "description": "Adds a detail or general journal document entry as a source to an asset.\nThe booking must have the same ledger account as the asset.\n\n### Required scope(s)\n `documents`",
        "tags": [
          "Assets"
        ],
        "security": [
          {
            "bearerAuth": [
              "documents"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/administration_id"
          },
          {
            "name": "id",
            "in": "path",
            "required": true,
            "schema": {
              "$ref": "#/components/schemas/identifier"
            }
          },
          {
            "$ref": "#/components/parameters/format"
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/*": {
              "schema": {
                "type": "object",
                "unevaluatedProperties": false,
                "oneOf": [
                  {
                    "required": [
                      "detail_id"
                    ],
                    "properties": {
                      "detail_id": {
                        "$ref": "#/components/schemas/identifier"
                      }
                    }
                  },
                  {
                    "required": [
                      "general_journal_document_entry_id"
                    ],
                    "properties": {
                      "general_journal_document_entry_id": {
                        "$ref": "#/components/schemas/identifier"
                      }
                    }
                  }
                ]
              },
              "examples": {
                "CreatesANewDetailSource": {
                  "summary": "Creates a new detail source",
                  "value": {
                    "detail_id": 502689252850533800
                  }
                },
                "CreatesANewGeneralJournalDocumentSource": {
                  "summary": "Creates a new general journal document source",
                  "value": {
                    "general_journal_document_entry_id": 502689254218925700
                  }
                }
              }
            }
          }
        },
        "responses": {
          "201": {
            "description": "A detail that is added as a source to an asset",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/source_response"
                },
                "examples": {
                  "CreatesANewDetailSource": {
                    "summary": "Creates a new detail source",
                    "value": {
                      "id": "502689252868359623",
                      "asset_id": "502689252550641050",
                      "detail_id": "502689252850533830"
                    }
                  },
                  "CreatesANewGeneralJournalDocumentSource": {
                    "summary": "Creates a new general journal document source",
                    "value": {
                      "id": "502689254229411458",
                      "asset_id": "502689253899109973",
                      "general_journal_document_entry_id": "502689254218925697"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "Bad request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/symbolic_error"
                },
                "examples": {
                  "ReturnsA400IfTheDetailIdIsNotAInteger": {
                    "summary": "Returns a 400 if the detail id is not a integer",
                    "value": {
                      "error": "detail_id is invalid"
                    }
                  },
                  "ReturnsA400IfTheGeneralJournalDocumentEntryIdIsNotAnInteger": {
                    "summary": "Returns a 400 if the general journal document entry id is not an integer",
                    "value": {
                      "error": "general_journal_document_entry_id is invalid"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Not found",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/symbolic_error"
                },
                "examples": {
                  "ReturnsA404IfTheAssetDoesNotExist": {
                    "summary": "Returns a 404 if the asset does not exist",
                    "value": {
                      "error": "Record not found for model name: asset"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "Unprocessable entity",
            "content": {
              "application/json": {
                "schema": {
                  "anyOf": [
                    {
                      "$ref": "#/components/schemas/symbolic_error"
                    },
                    {
                      "$ref": "#/components/schemas/non_symbolic_error"
                    }
                  ]
                },
                "examples": {
                  "ReturnsA422IfTheDetailIsNotValid": {
                    "summary": "Returns a 422 if the detail is not valid",
                    "value": {
                      "error": {
                        "booking": [
                          "The ledger account of the source must be equal to the ledger account of the asset"
                        ]
                      },
                      "details": {
                        "booking": [
                          {
                            "error": "not_equal_to_asset_ledger_account"
                          }
                        ]
                      }
                    }
                  },
                  "ReturnsA422IfTheEntryHasADifferentLedgerAccountThanTheAsset": {
                    "summary": "Returns a 422 if the entry has a different ledger account than the asset",
                    "value": {
                      "error": {
                        "booking": [
                          "The ledger account of the source must be equal to the ledger account of the asset"
                        ]
                      },
                      "details": {
                        "booking": [
                          {
                            "error": "not_equal_to_asset_ledger_account"
                          }
                        ]
                      }
                    }
                  }
                }
              }
            }
          }
        },
        "operationId": "post_administration_id_assets_id_sources"
      }
    },
    "/{administration_id}/assets/{id}/value_changes/arbitrary{format}": {
      "post": {
        "summary": "Create an arbitrary value change",
        "description": "Creates an arbitrary value change for the asset at the given date.\nIf the amount is larger than the value of the asset at the given date, a 422 error will be returned.\nAny existing linear value changes after the given date will be removed.\n\n### Required scope(s)\n `documents`",
        "tags": [
          "Assets"
        ],
        "security": [
          {
            "bearerAuth": [
              "documents"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/administration_id"
          },
          {
            "name": "id",
            "in": "path",
            "required": true,
            "schema": {
              "$ref": "#/components/schemas/identifier"
            }
          },
          {
            "$ref": "#/components/parameters/format"
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/*": {
              "schema": {
                "type": "object",
                "unevaluatedProperties": false,
                "properties": {
                  "date": {
                    "type": "string",
                    "format": "date",
                    "description": "Has to be after the purchase date of the asset, and cannot be in the future or in the locked period of the administration."
                  },
                  "amount": {
                    "$ref": "#/components/schemas/money",
                    "description": "Note that a negative amount means the asset decreases in value while a positive amount means the asset increases in value."
                  },
                  "description": {
                    "type": "string"
                  },
                  "externally_booked": {
                    "type": "boolean",
                    "description": "Set to true if the value change is already externally booked and doesn't need to be booked by Moneybird.",
                    "default": false
                  }
                },
                "required": [
                  "date",
                  "amount",
                  "description"
                ]
              },
              "examples": {
                "AddsAArbitraryValueChange": {
                  "summary": "Adds a arbitrary value change",
                  "value": {
                    "date": "2026-11-02",
                    "amount": -10,
                    "externally_booked": true,
                    "description": "some description"
                  }
                }
              }
            }
          }
        },
        "responses": {
          "201": {
            "description": "A value change",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/value_change_response"
                },
                "examples": {
                  "AddsAArbitraryValueChange": {
                    "summary": "Adds a arbitrary value change",
                    "value": {
                      "type": "arbitrary",
                      "date": "2026-11-02",
                      "amount": "-10.0",
                      "description": "some description",
                      "externally_booked": true,
                      "asset_id": "502689257797715067"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "Bad request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/symbolic_error"
                },
                "examples": {
                  "ReturnsA400IfTheDateIsNotAValidDate": {
                    "summary": "Returns a 400 if the date is not a valid date",
                    "value": {
                      "error": "Date is invalid"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Not found",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/symbolic_error"
                },
                "examples": {
                  "ReturnsA404IfTheAssetDoesNotExist": {
                    "summary": "Returns a 404 if the asset does not exist",
                    "value": {
                      "error": "Record not found for model name: asset"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "Unprocessable entity",
            "content": {
              "application/json": {
                "schema": {
                  "anyOf": [
                    {
                      "$ref": "#/components/schemas/symbolic_error"
                    },
                    {
                      "$ref": "#/components/schemas/non_symbolic_error"
                    }
                  ]
                },
                "examples": {
                  "ReturnsA422IfTheValueChangeIsInvalid": {
                    "summary": "Returns a 422 if the value change is invalid",
                    "value": {
                      "error": {
                        "date": [
                          "can not be before the commissioning date of the asset"
                        ]
                      },
                      "details": {
                        "date": [
                          {
                            "error": "cannot_be_before_purchase_date"
                          }
                        ]
                      }
                    }
                  }
                }
              }
            }
          }
        },
        "operationId": "post_administration_id_assets_id_value_changes_arbitrary"
      }
    },
    "/{administration_id}/assets/{id}/value_changes/divestment{format}": {
      "post": {
        "summary": "Create a divestment value change",
        "description": "Creates a divestment value change for the asset at the given date.\nThe remaining value of the asset will be taken from the balance sheet and the profit will be booked as book result.\nThe amount of the value change will automatically be set to the value of the asset at the given date.\nIf the value change is created successfully, a disposal will be created for the asset.\nAny existing linear value changes after the given date will be removed.\n\n### Required scope(s)\n `documents`",
        "tags": [
          "Assets"
        ],
        "security": [
          {
            "bearerAuth": [
              "documents"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/administration_id"
          },
          {
            "name": "id",
            "in": "path",
            "required": true,
            "schema": {
              "$ref": "#/components/schemas/identifier"
            }
          },
          {
            "$ref": "#/components/parameters/format"
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/*": {
              "schema": {
                "type": "object",
                "unevaluatedProperties": false,
                "properties": {
                  "date": {
                    "type": "string",
                    "format": "date",
                    "description": "Has to be after the purchase date of the asset, and cannot be in the future or in the locked period of the administration."
                  }
                },
                "required": [
                  "date"
                ]
              },
              "examples": {
                "AddsADivestmentValueChange": {
                  "summary": "Adds a divestment value change",
                  "value": {
                    "date": "2026-11-02"
                  }
                }
              }
            }
          }
        },
        "responses": {
          "201": {
            "description": "A value change",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/value_change_response"
                },
                "examples": {
                  "AddsADivestmentValueChange": {
                    "summary": "Adds a divestment value change",
                    "value": {
                      "type": "divestment",
                      "date": "2026-11-02",
                      "amount": "-12145.67",
                      "description": null,
                      "externally_booked": false,
                      "asset_id": "502689246301128297"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "Bad request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/symbolic_error"
                },
                "examples": {
                  "ReturnsA400IfTheDateIsNotAValidDate": {
                    "summary": "Returns a 400 if the date is not a valid date",
                    "value": {
                      "error": "Date is invalid"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Not found",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/symbolic_error"
                },
                "examples": {
                  "ReturnsA404IfTheAssetDoesNotExist": {
                    "summary": "Returns a 404 if the asset does not exist",
                    "value": {
                      "error": "Record not found for model name: asset"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "Unprocessable entity",
            "content": {
              "application/json": {
                "schema": {
                  "anyOf": [
                    {
                      "$ref": "#/components/schemas/symbolic_error"
                    },
                    {
                      "$ref": "#/components/schemas/non_symbolic_error"
                    }
                  ]
                },
                "examples": {
                  "ReturnsA422IfTheValueChangeIsInvalid": {
                    "summary": "Returns a 422 if the value change is invalid",
                    "value": {
                      "error": {
                        "date": [
                          "can not be before the commissioning date of the asset",
                          "must be after the last arbitrary depreciation"
                        ]
                      },
                      "details": {
                        "date": [
                          {
                            "error": "cannot_be_before_purchase_date"
                          },
                          {
                            "error": "after_arbitrary_changes"
                          }
                        ]
                      }
                    }
                  }
                }
              }
            }
          }
        },
        "operationId": "post_administration_id_assets_id_value_changes_divestment"
      }
    },
    "/{administration_id}/assets/{id}/value_changes/full_depreciation{format}": {
      "post": {
        "summary": "Create a full depreciation value change",
        "description": "Creates a full depreciation value change for the asset at the given date.\nThe remaining value of the asset will be taken from the balance sheet.\nThe amount of the value change will automatically be set to the value of the asset at the given date.\nIf the value change is created successfully, a disposal will be created for the asset.\nAny existing linear value changes after the given date will be removed.\n\n### Required scope(s)\n `documents`",
        "tags": [
          "Assets"
        ],
        "security": [
          {
            "bearerAuth": [
              "documents"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/administration_id"
          },
          {
            "name": "id",
            "in": "path",
            "required": true,
            "schema": {
              "$ref": "#/components/schemas/identifier"
            }
          },
          {
            "$ref": "#/components/parameters/format"
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/*": {
              "schema": {
                "type": "object",
                "unevaluatedProperties": false,
                "properties": {
                  "date": {
                    "type": "string",
                    "format": "date",
                    "description": "Has to be after the purchase date of the asset, and cannot be in the future or in the locked period of the administration."
                  },
                  "description": {
                    "type": "string"
                  }
                },
                "required": [
                  "date",
                  "description"
                ]
              },
              "examples": {
                "AddsAFullDepreciationValueChange": {
                  "summary": "Adds a full depreciation value change",
                  "value": {
                    "date": "2026-11-02",
                    "description": "some description"
                  }
                }
              }
            }
          }
        },
        "responses": {
          "201": {
            "description": "A value change",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/value_change_response"
                },
                "examples": {
                  "AddsAFullDepreciationValueChange": {
                    "summary": "Adds a full depreciation value change",
                    "value": {
                      "type": "full_depreciation",
                      "date": "2026-11-02",
                      "amount": "-12145.67",
                      "description": "some description",
                      "externally_booked": false,
                      "asset_id": "502689251460121860"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "Bad request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/symbolic_error"
                },
                "examples": {
                  "ReturnsA400IfTheDateIsNotAValidDate": {
                    "summary": "Returns a 400 if the date is not a valid date",
                    "value": {
                      "error": "Date is invalid"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Not found",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/symbolic_error"
                },
                "examples": {
                  "ReturnsA404IfTheAssetDoesNotExist": {
                    "summary": "Returns a 404 if the asset does not exist",
                    "value": {
                      "error": "Record not found for model name: asset"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "Unprocessable entity",
            "content": {
              "application/json": {
                "schema": {
                  "anyOf": [
                    {
                      "$ref": "#/components/schemas/symbolic_error"
                    },
                    {
                      "$ref": "#/components/schemas/non_symbolic_error"
                    }
                  ]
                },
                "examples": {
                  "ReturnsA422IfTheValueChangeIsInvalid": {
                    "summary": "Returns a 422 if the value change is invalid",
                    "value": {
                      "error": {
                        "date": [
                          "can not be before the commissioning date of the asset",
                          "must be after the last arbitrary depreciation"
                        ]
                      },
                      "details": {
                        "date": [
                          {
                            "error": "cannot_be_before_purchase_date"
                          },
                          {
                            "error": "after_arbitrary_changes"
                          }
                        ]
                      }
                    }
                  }
                }
              }
            }
          }
        },
        "operationId": "post_administration_id_assets_id_value_changes_full_depreciation"
      }
    },
    "/{administration_id}/assets/{id}/value_changes/manual{format}": {
      "post": {
        "summary": "Create a manual value change",
        "description": "Creates a manual value change for the asset at the given date.\nIf the amount is larger than the value of the asset at the given date, a 422 error will be returned.\n\n### Required scope(s)\n `documents`",
        "tags": [
          "Assets"
        ],
        "security": [
          {
            "bearerAuth": [
              "documents"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/administration_id"
          },
          {
            "name": "id",
            "in": "path",
            "required": true,
            "schema": {
              "$ref": "#/components/schemas/identifier"
            }
          },
          {
            "$ref": "#/components/parameters/format"
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/*": {
              "schema": {
                "type": "object",
                "unevaluatedProperties": false,
                "properties": {
                  "date": {
                    "type": "string",
                    "format": "date",
                    "description": "Has to be after the purchase date of the asset, and cannot be in the future or in the locked period of the administration."
                  },
                  "amount": {
                    "$ref": "#/components/schemas/money",
                    "description": "Note that a negative amount means the asset decreases in value while a positive amount means the asset increases in value."
                  },
                  "description": {
                    "type": "string"
                  },
                  "externally_booked": {
                    "type": "boolean",
                    "description": "Set to true if the value change is already externally booked and doesn't need to be booked by Moneybird.",
                    "default": false
                  }
                },
                "required": [
                  "date",
                  "amount",
                  "description"
                ]
              },
              "examples": {
                "AddsAManualValueChange": {
                  "summary": "Adds a manual value change",
                  "value": {
                    "date": "2026-11-02",
                    "amount": -10,
                    "externally_booked": true,
                    "description": "some description"
                  }
                }
              }
            }
          }
        },
        "responses": {
          "201": {
            "description": "A value change",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/value_change_response"
                },
                "examples": {
                  "AddsAManualValueChange": {
                    "summary": "Adds a manual value change",
                    "value": {
                      "type": "manual",
                      "date": "2026-11-02",
                      "amount": "-10.0",
                      "description": "some description",
                      "externally_booked": true,
                      "asset_id": "502689249813857318"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "Bad request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/symbolic_error"
                },
                "examples": {
                  "ReturnsA400IfTheDateIsNotAValidDate": {
                    "summary": "Returns a 400 if the date is not a valid date",
                    "value": {
                      "error": "Date is invalid"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Not found",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/symbolic_error"
                },
                "examples": {
                  "ReturnsA404IfTheAssetDoesNotExist": {
                    "summary": "Returns a 404 if the asset does not exist",
                    "value": {
                      "error": "Record not found for model name: asset"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "Unprocessable entity",
            "content": {
              "application/json": {
                "schema": {
                  "anyOf": [
                    {
                      "$ref": "#/components/schemas/symbolic_error"
                    },
                    {
                      "$ref": "#/components/schemas/non_symbolic_error"
                    }
                  ]
                },
                "examples": {
                  "ReturnsA422IfTheValueChangeIsInvalid": {
                    "summary": "Returns a 422 if the value change is invalid",
                    "value": {
                      "error": {
                        "date": [
                          "can not be before the commissioning date of the asset"
                        ]
                      },
                      "details": {
                        "date": [
                          {
                            "error": "cannot_be_before_purchase_date"
                          }
                        ]
                      }
                    }
                  }
                }
              }
            }
          }
        },
        "operationId": "post_administration_id_assets_id_value_changes_manual"
      }
    },
    "/{administration_id}/assets/{id}/value_changes/retroactive_linear_value_changes{format}": {
      "post": {
        "summary": "Create linear value changes retroactively",
        "description": "Creates linear value changes that were not created yet.\nUse this if a new asset has just been created or if an arbitrary value change was created and the missing linear value changes need to be recalculated and recreated.\nThis will create missing value changes for all months between the purchase date of the asset or the date of the last arbitrary value change and the last month of the administration.\nRequires a asset with a value change plan (so no assets that belong to a land or building category).\nAlso requires that the asset has remaining value, has missing value changes at the end of some months and that all missing linear value changes are outside the locked period.\nThis process will be performed asynchronously so no result will be returned. Use `Get /assets/:id` to check the result after a while.\n\n### Required scope(s)\n `documents`",
        "tags": [
          "Assets"
        ],
        "security": [
          {
            "bearerAuth": [
              "documents"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/administration_id"
          },
          {
            "name": "id",
            "in": "path",
            "required": true,
            "schema": {
              "$ref": "#/components/schemas/identifier"
            }
          },
          {
            "$ref": "#/components/parameters/format"
          }
        ],
        "responses": {
          "204": {
            "$ref": "#/components/responses/204_no_content"
          },
          "404": {
            "description": "Not found",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/symbolic_error"
                },
                "examples": {
                  "ReturnsA404IfTheAssetDoesNotExist": {
                    "summary": "Returns a 404 if the asset does not exist",
                    "value": {
                      "error": "Record not found for model name: asset"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "Unprocessable entity",
            "content": {
              "application/json": {
                "schema": {
                  "anyOf": [
                    {
                      "$ref": "#/components/schemas/symbolic_error"
                    },
                    {
                      "$ref": "#/components/schemas/non_symbolic_error"
                    }
                  ]
                },
                "examples": {
                  "ReturnsA422IfTheAssetHasNoValueChangePlan": {
                    "summary": "Returns a 422 if the asset has no value change plan",
                    "value": {
                      "error": "Asset has no value change plan"
                    }
                  },
                  "ReturnsA422IfTheAssetIsNotValidWithRetroactiveValueChangesScope": {
                    "summary": "Returns a 422 if the asset is not valid with retroactive value changes scope",
                    "value": {
                      "error": "The value change plan of the asset is not active"
                    }
                  }
                }
              }
            }
          }
        },
        "operationId": "post_administration_id_assets_id_value_changes_retroactive_linear_value_changes"
      }
    },
    "/{administration_id}/assets/{id}{format}": {
      "get": {
        "summary": "Get an asset by ID",
        "description": "Returns the asset with the given ID.\n\n### Required scope(s)\n `documents`",
        "tags": [
          "Assets"
        ],
        "security": [
          {
            "bearerAuth": [
              "documents"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/administration_id"
          },
          {
            "name": "id",
            "in": "path",
            "required": true,
            "schema": {
              "$ref": "#/components/schemas/identifier"
            }
          },
          {
            "$ref": "#/components/parameters/format"
          }
        ],
        "responses": {
          "200": {
            "description": "An asset",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/asset_response"
                },
                "examples": {
                  "ExposesCalculatedPurchaseValueReducedByTheAppliedReinvestmentReservePurchase": {
                    "summary": "Exposes calculated purchase value reduced by the applied reinvestment reserve purchase",
                    "value": {
                      "id": "502689251811394886",
                      "ledger_account_id": "502689251806152005",
                      "name": "Asset 1",
                      "purchase_date": "2026-06-01",
                      "purchase_value": "1000.0",
                      "calculated_purchase_value": "700.0",
                      "current_value": "700.0",
                      "value_change_plan": null,
                      "disposal": null,
                      "value_changes": [],
                      "sources": [],
                      "reinvestment_reserve_purchase": {
                        "id": "502689251822929224",
                        "amount": "300.0",
                        "date": "2026-06-01",
                        "asset_id": "502689251811394886"
                      }
                    }
                  },
                  "ReturnsTheAsset": {
                    "summary": "Returns the asset",
                    "value": {
                      "id": "502689251879552337",
                      "ledger_account_id": "502689251874309456",
                      "name": "Asset 1",
                      "purchase_date": "2026-06-01",
                      "purchase_value": "12345.67",
                      "calculated_purchase_value": "12345.67",
                      "current_value": "12145.67",
                      "value_change_plan": {
                        "lifespan_in_years": 5,
                        "residual_value": "10.0",
                        "active": true,
                        "monthly_depreciation": "216.71"
                      },
                      "disposal": null,
                      "value_changes": [
                        {
                          "type": "arbitrary",
                          "date": "2026-07-01",
                          "amount": "-50.0",
                          "description": "Value change 1",
                          "externally_booked": false,
                          "asset_id": "502689251879552337"
                        },
                        {
                          "type": "arbitrary",
                          "date": "2026-08-01",
                          "amount": "-50.0",
                          "description": "Value change 2",
                          "externally_booked": false,
                          "asset_id": "502689251879552337"
                        },
                        {
                          "type": "arbitrary",
                          "date": "2026-09-01",
                          "amount": "-50.0",
                          "description": "Value change 3",
                          "externally_booked": false,
                          "asset_id": "502689251879552337"
                        },
                        {
                          "type": "arbitrary",
                          "date": "2026-10-01",
                          "amount": "-50.0",
                          "description": "Value change 4",
                          "externally_booked": false,
                          "asset_id": "502689251879552337"
                        }
                      ],
                      "sources": [],
                      "reinvestment_reserve_purchase": null
                    }
                  },
                  "ReturnsTheAssetWithADisposal": {
                    "summary": "Returns the asset with a disposal",
                    "value": {
                      "id": "502689252255991165",
                      "ledger_account_id": "502689252248651132",
                      "name": "Asset 1",
                      "purchase_date": "2020-11-02",
                      "purchase_value": "12345.67",
                      "calculated_purchase_value": "12345.67",
                      "current_value": "0.0",
                      "value_change_plan": {
                        "lifespan_in_years": 5,
                        "residual_value": "10.0",
                        "active": false,
                        "monthly_depreciation": "205.59"
                      },
                      "disposal": {
                        "date": "2026-11-02",
                        "reason": "out_of_use",
                        "externally_booked": false,
                        "asset_id": "502689252255991165",
                        "reinvestment_reserve_sale": null
                      },
                      "value_changes": [
                        {
                          "type": "manual",
                          "date": "2026-11-02",
                          "amount": "-12345.67",
                          "description": "Depreciation",
                          "externally_booked": false,
                          "asset_id": "502689252255991165"
                        }
                      ],
                      "sources": [],
                      "reinvestment_reserve_purchase": null
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Not found",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/symbolic_error"
                },
                "examples": {
                  "ReturnsA404IfTheAssetDoesNotExist": {
                    "summary": "Returns a 404 if the asset does not exist",
                    "value": {
                      "error": "Record not found for model name: asset"
                    }
                  }
                }
              }
            }
          }
        },
        "operationId": "get_administration_id_assets_id"
      },
      "patch": {
        "summary": "Update an asset",
        "description": "Updates the asset with the given ID.\nIf the asset is active (the purchase date is in the past), only the `name` can be updated.\n\n### Required scope(s)\n `documents`",
        "tags": [
          "Assets"
        ],
        "security": [
          {
            "bearerAuth": [
              "documents"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/administration_id"
          },
          {
            "name": "id",
            "in": "path",
            "required": true,
            "schema": {
              "$ref": "#/components/schemas/identifier"
            }
          },
          {
            "$ref": "#/components/parameters/format"
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/*": {
              "schema": {
                "type": "object",
                "unevaluatedProperties": false,
                "properties": {
                  "asset": {
                    "type": "object",
                    "unevaluatedProperties": false,
                    "properties": {
                      "name": {
                        "type": "string",
                        "description": "The name of the asset"
                      },
                      "ledger_account_id": {
                        "$ref": "#/components/schemas/identifier",
                        "description": "The ID of the ledger account"
                      },
                      "purchase_date": {
                        "type": "string",
                        "description": "The purchase date of the asset"
                      },
                      "purchase_value": {
                        "$ref": "#/components/schemas/money",
                        "description": "The purchase value of the asset"
                      },
                      "value_change_plan_attributes": {
                        "unevaluatedProperties": false,
                        "properties": {
                          "lifespan_in_years": {
                            "$ref": "#/components/schemas/number",
                            "description": "The lifespan of the asset in years"
                          },
                          "residual_value": {
                            "$ref": "#/components/schemas/money",
                            "description": "The residual value of the asset at the end of the lifespan"
                          }
                        }
                      }
                    }
                  }
                },
                "required": [
                  "asset"
                ]
              },
              "examples": {
                "AllowsUpdatingEveryAttributeOfAPlannedAsset": {
                  "summary": "Allows updating every attribute of a planned asset",
                  "value": {
                    "asset": {
                      "name": "New Name",
                      "ledger_account_id": 502689254843877060,
                      "purchase_date": "2026-11-02",
                      "purchase_value": 10000,
                      "value_change_plan_attributes": {
                        "lifespan_in_years": 10,
                        "residual_value": 500
                      }
                    }
                  }
                },
                "UpdatesTheAsset": {
                  "summary": "Updates the asset",
                  "value": {
                    "asset": {
                      "name": "New Name"
                    }
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Asset updated",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/asset_response"
                },
                "examples": {
                  "AllowsUpdatingEveryAttributeOfAPlannedAsset": {
                    "summary": "Allows updating every attribute of a planned asset",
                    "value": {
                      "id": "502689254852265697",
                      "ledger_account_id": "502689254843877087",
                      "name": "New Name",
                      "purchase_date": "2026-11-02",
                      "purchase_value": "10000.0",
                      "calculated_purchase_value": "10000.0",
                      "current_value": "10000.0",
                      "value_change_plan": {
                        "lifespan_in_years": 10,
                        "residual_value": "500.0",
                        "active": true,
                        "monthly_depreciation": "79.17"
                      },
                      "disposal": null,
                      "value_changes": [],
                      "sources": [],
                      "reinvestment_reserve_purchase": null
                    }
                  },
                  "UpdatesTheAsset": {
                    "summary": "Updates the asset",
                    "value": {
                      "id": "502689255244433174",
                      "ledger_account_id": "502689255238141717",
                      "name": "New Name",
                      "purchase_date": "2026-06-01",
                      "purchase_value": "12345.67",
                      "calculated_purchase_value": "12345.67",
                      "current_value": "12145.67",
                      "value_change_plan": {
                        "lifespan_in_years": 5,
                        "residual_value": "10.0",
                        "active": true,
                        "monthly_depreciation": "216.71"
                      },
                      "disposal": null,
                      "value_changes": [
                        {
                          "type": "arbitrary",
                          "date": "2026-07-01",
                          "amount": "-50.0",
                          "description": "Value change 1",
                          "externally_booked": false,
                          "asset_id": "502689255244433174"
                        },
                        {
                          "type": "arbitrary",
                          "date": "2026-08-01",
                          "amount": "-50.0",
                          "description": "Value change 2",
                          "externally_booked": false,
                          "asset_id": "502689255244433174"
                        },
                        {
                          "type": "arbitrary",
                          "date": "2026-09-01",
                          "amount": "-50.0",
                          "description": "Value change 3",
                          "externally_booked": false,
                          "asset_id": "502689255244433174"
                        },
                        {
                          "type": "arbitrary",
                          "date": "2026-10-01",
                          "amount": "-50.0",
                          "description": "Value change 4",
                          "externally_booked": false,
                          "asset_id": "502689255244433174"
                        }
                      ],
                      "sources": [],
                      "reinvestment_reserve_purchase": null
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "Bad request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/symbolic_error"
                },
                "examples": {
                  "ReturnsA400IfTheInputAttributesAreInvalid": {
                    "summary": "Returns a 400 if the input attributes are invalid",
                    "value": {
                      "error": "asset[purchase_value] does not have a valid value"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Not found",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/symbolic_error"
                },
                "examples": {
                  "ReturnsA404IfTheAssetDoesNotExist": {
                    "summary": "Returns a 404 if the asset does not exist",
                    "value": {
                      "error": "Record not found for model name: asset"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "Unprocessable entity",
            "content": {
              "application/json": {
                "schema": {
                  "anyOf": [
                    {
                      "$ref": "#/components/schemas/symbolic_error"
                    },
                    {
                      "$ref": "#/components/schemas/non_symbolic_error"
                    }
                  ]
                },
                "examples": {
                  "ReturnsA422IfAnActiveAssetGetsAnInvalidAttributeUpdate": {
                    "summary": "Returns a 422 if an active asset gets an invalid attribute update",
                    "value": {
                      "error": {
                        "base": [
                          "Cannot update asset when it has value changes"
                        ]
                      },
                      "details": {
                        "base": [
                          {
                            "error": "cannot_update_with_value_changes"
                          }
                        ]
                      }
                    }
                  }
                }
              }
            }
          }
        },
        "operationId": "patch_administration_id_assets_id"
      },
      "delete": {
        "summary": "Delete an asset",
        "description": "Deletes the asset with the given ID.\n\n### Required scope(s)\n `documents`",
        "tags": [
          "Assets"
        ],
        "security": [
          {
            "bearerAuth": [
              "documents"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/administration_id"
          },
          {
            "name": "id",
            "in": "path",
            "required": true,
            "schema": {
              "$ref": "#/components/schemas/identifier"
            }
          },
          {
            "$ref": "#/components/parameters/format"
          }
        ],
        "responses": {
          "204": {
            "description": "Asset deleted"
          },
          "404": {
            "description": "Not found",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/symbolic_error"
                },
                "examples": {
                  "ReturnsA404IfTheAssetDoesNotExist": {
                    "summary": "Returns a 404 if the asset does not exist",
                    "value": {
                      "error": "Record not found for model name: asset"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "Unprocessable entity",
            "content": {
              "application/json": {
                "schema": {
                  "anyOf": [
                    {
                      "$ref": "#/components/schemas/symbolic_error"
                    },
                    {
                      "$ref": "#/components/schemas/non_symbolic_error"
                    }
                  ]
                },
                "examples": {
                  "ReturnsA422IfTheAssetIsInTheLockedPeriod": {
                    "summary": "Returns a 422 if the asset is in the locked period",
                    "value": {
                      "error": "Asset cannot be deleted because there are journal entries in the locked period of the administration."
                    }
                  }
                }
              }
            }
          }
        },
        "operationId": "delete_administration_id_assets_id"
      }
    },
    "/{administration_id}/assets{format}": {
      "get": {
        "summary": "List all assets",
        "description": "Returns a list of all assets.\nThe list is paginated. Use the `per_page` and `page` parameters to control the pagination.\n\n### Required scope(s)\n `documents`",
        "tags": [
          "Assets"
        ],
        "security": [
          {
            "bearerAuth": [
              "documents"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/administration_id"
          },
          {
            "$ref": "#/components/parameters/format"
          },
          {
            "name": "ledger_account_id",
            "in": "query",
            "required": false,
            "schema": {
              "$ref": "#/components/schemas/identifier"
            },
            "description": "Filter on the ID of the ledger account",
            "examples": {
              "ReturnsAListOfAssetsFilteredByLedgerAccount": {
                "summary": "Returns a list of assets filtered by ledger account",
                "value": "502689245031302566"
              }
            }
          },
          {
            "name": "active",
            "in": "query",
            "required": false,
            "schema": {
              "type": [
                "boolean",
                "string"
              ],
              "default": true
            },
            "description": "Whether to include only active assets",
            "examples": {
              "ReturnsAListOfAllAssets": {
                "summary": "Returns a list of all assets",
                "value": "false"
              }
            }
          },
          {
            "$ref": "#/components/parameters/per_page"
          },
          {
            "$ref": "#/components/parameters/page"
          }
        ],
        "responses": {
          "200": {
            "description": "A list of assets",
            "content": {
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "$ref": "#/components/schemas/asset_response"
                  }
                },
                "examples": {
                  "ReturnsAListOfAllAssets": {
                    "summary": "Returns a list of all assets",
                    "value": [
                      {
                        "id": "502689243443758239",
                        "ledger_account_id": "502689243435369630",
                        "name": "Asset 1",
                        "purchase_date": "2026-06-01",
                        "purchase_value": "12345.67",
                        "calculated_purchase_value": "12345.67",
                        "current_value": "12145.67",
                        "value_change_plan": {
                          "lifespan_in_years": 5,
                          "residual_value": "10.0",
                          "active": true,
                          "monthly_depreciation": "216.71"
                        },
                        "disposal": null,
                        "value_changes": [
                          {
                            "type": "arbitrary",
                            "date": "2026-07-01",
                            "amount": "-50.0",
                            "description": "Value change 1",
                            "externally_booked": false,
                            "asset_id": "502689243443758239"
                          },
                          {
                            "type": "arbitrary",
                            "date": "2026-08-01",
                            "amount": "-50.0",
                            "description": "Value change 2",
                            "externally_booked": false,
                            "asset_id": "502689243443758239"
                          },
                          {
                            "type": "arbitrary",
                            "date": "2026-09-01",
                            "amount": "-50.0",
                            "description": "Value change 3",
                            "externally_booked": false,
                            "asset_id": "502689243443758239"
                          },
                          {
                            "type": "arbitrary",
                            "date": "2026-10-01",
                            "amount": "-50.0",
                            "description": "Value change 4",
                            "externally_booked": false,
                            "asset_id": "502689243443758239"
                          }
                        ],
                        "sources": [],
                        "reinvestment_reserve_purchase": null
                      },
                      {
                        "id": "502689243771962571",
                        "ledger_account_id": "502689243767768266",
                        "name": "Asset 2",
                        "purchase_date": "2020-11-02",
                        "purchase_value": "12345.67",
                        "calculated_purchase_value": "12345.67",
                        "current_value": "0.0",
                        "value_change_plan": {
                          "lifespan_in_years": 5,
                          "residual_value": "10.0",
                          "active": false,
                          "monthly_depreciation": "205.59"
                        },
                        "disposal": {
                          "date": "2026-11-02",
                          "reason": "out_of_use",
                          "externally_booked": false,
                          "asset_id": "502689243771962571",
                          "reinvestment_reserve_sale": null
                        },
                        "value_changes": [
                          {
                            "type": "manual",
                            "date": "2026-11-02",
                            "amount": "-12345.67",
                            "description": "Depreciation",
                            "externally_booked": false,
                            "asset_id": "502689243771962571"
                          }
                        ],
                        "sources": [],
                        "reinvestment_reserve_purchase": null
                      }
                    ]
                  },
                  "ReturnsAPaginatedListOfAssets": {
                    "summary": "Returns a paginated list of assets",
                    "value": [
                      {
                        "id": "502689244142109965",
                        "ledger_account_id": "502689244136867084",
                        "name": "Asset 2",
                        "purchase_date": "2020-11-02",
                        "purchase_value": "12345.67",
                        "calculated_purchase_value": "12345.67",
                        "current_value": "0.0",
                        "value_change_plan": {
                          "lifespan_in_years": 5,
                          "residual_value": "10.0",
                          "active": false,
                          "monthly_depreciation": "205.59"
                        },
                        "disposal": {
                          "date": "2026-11-02",
                          "reason": "out_of_use",
                          "externally_booked": false,
                          "asset_id": "502689244142109965",
                          "reinvestment_reserve_sale": null
                        },
                        "value_changes": [
                          {
                            "type": "manual",
                            "date": "2026-11-02",
                            "amount": "-12345.67",
                            "description": "Depreciation",
                            "externally_booked": false,
                            "asset_id": "502689244142109965"
                          }
                        ],
                        "sources": [],
                        "reinvestment_reserve_purchase": null
                      }
                    ]
                  },
                  "ReturnsAListOfActiveAssets": {
                    "summary": "Returns a list of active assets",
                    "value": [
                      {
                        "id": "502689244214461731",
                        "ledger_account_id": "502689244208170274",
                        "name": "Asset 1",
                        "purchase_date": "2026-06-01",
                        "purchase_value": "12345.67",
                        "calculated_purchase_value": "12345.67",
                        "current_value": "12145.67",
                        "value_change_plan": {
                          "lifespan_in_years": 5,
                          "residual_value": "10.0",
                          "active": true,
                          "monthly_depreciation": "216.71"
                        },
                        "disposal": null,
                        "value_changes": [
                          {
                            "type": "arbitrary",
                            "date": "2026-07-01",
                            "amount": "-50.0",
                            "description": "Value change 1",
                            "externally_booked": false,
                            "asset_id": "502689244214461731"
                          },
                          {
                            "type": "arbitrary",
                            "date": "2026-08-01",
                            "amount": "-50.0",
                            "description": "Value change 2",
                            "externally_booked": false,
                            "asset_id": "502689244214461731"
                          },
                          {
                            "type": "arbitrary",
                            "date": "2026-09-01",
                            "amount": "-50.0",
                            "description": "Value change 3",
                            "externally_booked": false,
                            "asset_id": "502689244214461731"
                          },
                          {
                            "type": "arbitrary",
                            "date": "2026-10-01",
                            "amount": "-50.0",
                            "description": "Value change 4",
                            "externally_booked": false,
                            "asset_id": "502689244214461731"
                          }
                        ],
                        "sources": [],
                        "reinvestment_reserve_purchase": null
                      }
                    ]
                  },
                  "ReturnsAListOfAssetsFilteredByLedgerAccount": {
                    "summary": "Returns a list of assets filtered by ledger account",
                    "value": [
                      {
                        "id": "502689245036545447",
                        "ledger_account_id": "502689245031302566",
                        "name": "Asset 3",
                        "purchase_date": "2026-06-01",
                        "purchase_value": "12345.67",
                        "calculated_purchase_value": "12345.67",
                        "current_value": "12145.67",
                        "value_change_plan": {
                          "lifespan_in_years": 5,
                          "residual_value": "10.0",
                          "active": true,
                          "monthly_depreciation": "216.71"
                        },
                        "disposal": null,
                        "value_changes": [
                          {
                            "type": "arbitrary",
                            "date": "2026-07-01",
                            "amount": "-50.0",
                            "description": "Value change 1",
                            "externally_booked": false,
                            "asset_id": "502689245036545447"
                          },
                          {
                            "type": "arbitrary",
                            "date": "2026-08-01",
                            "amount": "-50.0",
                            "description": "Value change 2",
                            "externally_booked": false,
                            "asset_id": "502689245036545447"
                          },
                          {
                            "type": "arbitrary",
                            "date": "2026-09-01",
                            "amount": "-50.0",
                            "description": "Value change 3",
                            "externally_booked": false,
                            "asset_id": "502689245036545447"
                          },
                          {
                            "type": "arbitrary",
                            "date": "2026-10-01",
                            "amount": "-50.0",
                            "description": "Value change 4",
                            "externally_booked": false,
                            "asset_id": "502689245036545447"
                          }
                        ],
                        "sources": [],
                        "reinvestment_reserve_purchase": null
                      }
                    ]
                  }
                }
              }
            }
          }
        },
        "operationId": "get_administration_id_assets"
      },
      "post": {
        "summary": "Create a new asset",
        "description": "Creates a new asset.\n\nAn asset on a land or building ledger account never has a depreciation plan. Leave out\n`value_change_plan_attributes` for those. Every other ledger account requires one.\n\n### Required scope(s)\n `documents`",
        "tags": [
          "Assets"
        ],
        "security": [
          {
            "bearerAuth": [
              "documents"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/administration_id"
          },
          {
            "$ref": "#/components/parameters/format"
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/*": {
              "schema": {
                "type": "object",
                "unevaluatedProperties": false,
                "properties": {
                  "asset": {
                    "type": "object",
                    "unevaluatedProperties": false,
                    "properties": {
                      "name": {
                        "type": "string",
                        "description": "The name of the asset"
                      },
                      "ledger_account_id": {
                        "$ref": "#/components/schemas/identifier",
                        "description": "The ID of the ledger account"
                      },
                      "purchase_date": {
                        "type": "string",
                        "description": "The purchase date of the asset"
                      },
                      "purchase_value": {
                        "$ref": "#/components/schemas/money",
                        "description": "The purchase value of the asset"
                      },
                      "value_change_plan_attributes": {
                        "description": "The depreciation plan of the asset. Required, except on a land or building ledger account, where a depreciation plan is not allowed.",
                        "unevaluatedProperties": false,
                        "properties": {
                          "lifespan_in_years": {
                            "$ref": "#/components/schemas/number",
                            "description": "The lifespan of the asset in years"
                          },
                          "residual_value": {
                            "$ref": "#/components/schemas/money",
                            "description": "The residual value of the asset at the end of the lifespan",
                            "default": 0
                          }
                        },
                        "required": [
                          "lifespan_in_years"
                        ]
                      }
                    },
                    "required": [
                      "name",
                      "ledger_account_id",
                      "purchase_date",
                      "purchase_value"
                    ]
                  }
                }
              },
              "examples": {
                "CreatesANewAsset": {
                  "summary": "Creates a new asset",
                  "value": {
                    "asset": {
                      "name": "Test Asset",
                      "ledger_account_id": 502689247249041100,
                      "purchase_date": "2026-11-02",
                      "purchase_value": 1000,
                      "value_change_plan_attributes": {
                        "lifespan_in_years": 5,
                        "residual_value": 100
                      }
                    }
                  }
                },
                "CreatesANewAssetWithoutADepreciationPlan": {
                  "summary": "Creates a new asset without a depreciation plan",
                  "value": {
                    "asset": {
                      "name": "Test Asset",
                      "ledger_account_id": 502689247367530240,
                      "purchase_date": "2026-11-02",
                      "purchase_value": 1000
                    }
                  }
                }
              }
            }
          }
        },
        "responses": {
          "201": {
            "description": "Asset created",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/asset_response"
                },
                "examples": {
                  "CreatesANewAsset": {
                    "summary": "Creates a new asset",
                    "value": {
                      "id": "502689247262672602",
                      "ledger_account_id": "502689247249041113",
                      "name": "Test Asset",
                      "purchase_date": "2026-11-02",
                      "purchase_value": "1000.0",
                      "calculated_purchase_value": "1000.0",
                      "current_value": "1000.0",
                      "value_change_plan": {
                        "lifespan_in_years": 5,
                        "residual_value": "100.0",
                        "active": true,
                        "monthly_depreciation": "15.0"
                      },
                      "disposal": null,
                      "value_changes": [],
                      "sources": [],
                      "reinvestment_reserve_purchase": null
                    }
                  },
                  "CreatesANewAssetWithoutADepreciationPlan": {
                    "summary": "Creates a new asset without a depreciation plan",
                    "value": {
                      "id": "502689247381161703",
                      "ledger_account_id": "502689247367530213",
                      "name": "Test Asset",
                      "purchase_date": "2026-11-02",
                      "purchase_value": "1000.0",
                      "calculated_purchase_value": "1000.0",
                      "current_value": "1000.0",
                      "value_change_plan": null,
                      "disposal": null,
                      "value_changes": [],
                      "sources": [],
                      "reinvestment_reserve_purchase": null
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "Bad request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/symbolic_error"
                },
                "examples": {
                  "ReturnsA400IfTheRequestWhenParametersAreMissing": {
                    "summary": "Returns a 400 if the request when parameters are missing",
                    "value": {
                      "error": "asset[name] is missing"
                    }
                  },
                  "ReturnsA400IfThePurchaseDateIsNotAValidDate": {
                    "summary": "Returns a 400 if the purchase date is not a valid date",
                    "value": {
                      "error": "asset[purchase_date] is invalid"
                    }
                  },
                  "ReturnsA400IfTheParametersAreIncorrect": {
                    "summary": "Returns a 400 if the parameters are incorrect",
                    "value": {
                      "error": "asset[purchase_value] does not have a valid value, asset[value_change_plan_attributes][lifespan_in_years] does not have a valid value, asset[value_change_plan_attributes][residual_value] does not have a valid value"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "Unprocessable entity",
            "content": {
              "application/json": {
                "schema": {
                  "anyOf": [
                    {
                      "$ref": "#/components/schemas/symbolic_error"
                    },
                    {
                      "$ref": "#/components/schemas/non_symbolic_error"
                    }
                  ]
                },
                "examples": {
                  "ReturnsA422IfTheAssetIsNotValid": {
                    "summary": "Returns a 422 if the asset is not valid",
                    "value": {
                      "error": {
                        "ledger_account": [
                          "is invalid"
                        ]
                      },
                      "details": {
                        "ledger_account": [
                          {
                            "error": "invalid"
                          }
                        ]
                      }
                    }
                  },
                  "ReturnsA422IfTheLedgerAccountHangsUnderAnotherCategory": {
                    "summary": "Returns a 422 if the ledger account hangs under another category",
                    "value": {
                      "error": {
                        "ledger_account": [
                          "cannot be a sub-category. Depreciation then lands in a different place on the balance sheet than the purchase value. Add a new category via 'Fixed assets'."
                        ]
                      },
                      "details": {
                        "ledger_account": [
                          {
                            "error": "cannot_be_a_child"
                          }
                        ]
                      }
                    }
                  },
                  "ReturnsA422IfADepreciationPlanIsNotAllowedForTheLedgerAccount": {
                    "summary": "Returns a 422 if a depreciation plan is not allowed for the ledger account",
                    "value": {
                      "error": {
                        "value_change_plan.base": [
                          "Depreciations are not possible with this ledger account"
                        ]
                      },
                      "details": {
                        "value_change_plan.base": [
                          {
                            "error": "value_change_plan_not_allowed_for_ledger_account"
                          }
                        ]
                      }
                    }
                  },
                  "ReturnsA422IfADepreciationPlanIsRequiredForTheLedgerAccount": {
                    "summary": "Returns a 422 if a depreciation plan is required for the ledger account",
                    "value": {
                      "error": {
                        "value_change_plan": [
                          "can't be blank"
                        ]
                      },
                      "details": {
                        "value_change_plan": [
                          {
                            "error": "blank"
                          }
                        ]
                      }
                    }
                  }
                }
              }
            }
          }
        },
        "operationId": "post_administration_id_assets"
      }
    },
    "/{administration_id}/contacts/customer_id/{customer_id}{format}": {
      "get": {
        "summary": "Get contact by customer id",
        "description": "Returns all information about a contact by the given customer id\n\n### Required scope(s)\n Any of: `estimates`, `sales_invoices`, `documents`, `bank` or `settings`",
        "tags": [
          "Contacts"
        ],
        "security": [
          {
            "bearerAuth": [
              "estimates"
            ]
          },
          {
            "bearerAuth": [
              "sales_invoices"
            ]
          },
          {
            "bearerAuth": [
              "documents"
            ]
          },
          {
            "bearerAuth": [
              "bank"
            ]
          },
          {
            "bearerAuth": [
              "settings"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/administration_id"
          },
          {
            "name": "customer_id",
            "in": "path",
            "required": true,
            "description": "The customer number of the contact, not the contact's id.",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/format"
          }
        ],
        "responses": {
          "200": {
            "description": "A contact",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/contact_response"
                },
                "examples": {
                  "ReturnAContact": {
                    "summary": "Return a contact",
                    "value": {
                      "id": "502689188632593617",
                      "administration_id": 123,
                      "company_name": "Foobar Holding B.V.",
                      "firstname": null,
                      "lastname": "Appleseed",
                      "address1": "Hoofdstraat 12",
                      "address2": "",
                      "zipcode": "1234 AB",
                      "city": "Amsterdam",
                      "country": "NL",
                      "phone": "",
                      "delivery_method": "Email",
                      "customer_id": "1",
                      "tax_number": "",
                      "chamber_of_commerce": "",
                      "bank_account": "",
                      "is_trusted": false,
                      "max_transfer_amount": null,
                      "attention": "",
                      "email": "info@example.com",
                      "email_ubl": true,
                      "send_invoices_to_attention": "",
                      "send_invoices_to_email": "info@example.com",
                      "send_estimates_to_attention": "",
                      "send_estimates_to_email": "info@example.com",
                      "direct_debit": false,
                      "sepa_active": false,
                      "sepa_iban": "",
                      "sepa_iban_account_name": "",
                      "sepa_bic": "",
                      "sepa_mandate_id": "",
                      "sepa_mandate_date": null,
                      "sepa_sequence_type": "RCUR",
                      "credit_card_number": "",
                      "credit_card_reference": "",
                      "credit_card_type": null,
                      "tax_number_validated_at": null,
                      "tax_number_valid": null,
                      "invoice_workflow_id": null,
                      "estimate_workflow_id": null,
                      "si_identifier": "",
                      "si_identifier_type": null,
                      "moneybird_payments_mandate": false,
                      "created_at": "2026-11-02T12:16:30.055Z",
                      "updated_at": "2026-11-02T12:16:30.069Z",
                      "version": 1793621790,
                      "sales_invoices_url": "https://moneybird.dev/123/sales_invoices/9f41d6d329130d9b5162affa6f10ecde7fb6fa8ad7951dd1f99395d42cd4a796/all",
                      "notes": [],
                      "custom_fields": [],
                      "contact_people": [
                        {
                          "id": "502689188636787923",
                          "contact_id": "502689188632593617",
                          "administration_id": 123,
                          "firstname": "John",
                          "lastname": "Appleseed",
                          "phone": null,
                          "email": null,
                          "department": null,
                          "created_at": "2026-11-02T12:16:30.058Z",
                          "updated_at": "2026-11-02T12:16:30.058Z",
                          "version": 1793621790
                        }
                      ],
                      "archived": false,
                      "events": [
                        {
                          "administration_id": 123,
                          "user_id": "502689108256097381",
                          "action": "contact_created",
                          "link_entity_id": null,
                          "link_entity_type": null,
                          "data": {},
                          "created_at": "2026-11-02T12:16:30.064Z",
                          "updated_at": "2026-11-02T12:16:30.064Z"
                        }
                      ]
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Not found",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/symbolic_error"
                },
                "examples": {
                  "Returns404WhenContactDoesNotExist": {
                    "summary": "Returns 404 when contact does not exist",
                    "value": {
                      "error": "record not found",
                      "symbolic": {
                        "customer_id": "not_found"
                      }
                    }
                  }
                }
              }
            }
          }
        },
        "operationId": "get_administration_id_contacts_customer_id_customer_id"
      }
    },
    "/{administration_id}/contacts/doubles{format}": {
      "get": {
        "summary": "List possible duplicate contacts",
        "description": "Returns groups of contacts in the administration that are considered possible duplicates of each other.\n\nPages are sized by the total number of contacts across the groups they contain, not by the number of groups. A group is never split across two pages, so a page can contain more contacts than the target page size when the group that fills it up is larger than that.\n\nOnly available once this feature has been enabled for the administration.\n\n### Required scope(s)\n Any of: `estimates`, `sales_invoices`, `documents`, `bank` or `settings`",
        "tags": [
          "Contacts"
        ],
        "security": [
          {
            "bearerAuth": [
              "estimates"
            ]
          },
          {
            "bearerAuth": [
              "sales_invoices"
            ]
          },
          {
            "bearerAuth": [
              "documents"
            ]
          },
          {
            "bearerAuth": [
              "bank"
            ]
          },
          {
            "bearerAuth": [
              "settings"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/administration_id"
          },
          {
            "$ref": "#/components/parameters/format"
          },
          {
            "$ref": "#/components/parameters/page"
          }
        ],
        "responses": {
          "200": {
            "description": "A page of possible duplicate contact groups",
            "content": {
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "type": "object",
                    "unevaluatedProperties": false,
                    "properties": {
                      "contacts": {
                        "type": "array",
                        "items": {
                          "$ref": "#/components/schemas/simple_contact_response"
                        }
                      }
                    }
                  }
                },
                "examples": {
                  "GroupsContactsThatShareAChamberOfCommerceNumber": {
                    "summary": "Groups contacts that share a chamber of commerce number",
                    "value": [
                      {
                        "contacts": [
                          {
                            "id": "502689293761775325",
                            "administration_id": 123,
                            "company_name": "Relation 1",
                            "firstname": null,
                            "lastname": null,
                            "address1": null,
                            "address2": null,
                            "zipcode": null,
                            "city": null,
                            "country": "NL",
                            "phone": null,
                            "delivery_method": "Email",
                            "customer_id": "customer-1",
                            "tax_number": null,
                            "chamber_of_commerce": "12345678",
                            "bank_account": null,
                            "is_trusted": false,
                            "max_transfer_amount": null,
                            "attention": null,
                            "email": "contact1@example.com",
                            "email_ubl": false,
                            "send_invoices_to_attention": null,
                            "send_invoices_to_email": "contact1@example.com",
                            "send_estimates_to_attention": null,
                            "send_estimates_to_email": null,
                            "direct_debit": false,
                            "sepa_active": false,
                            "sepa_iban": null,
                            "sepa_iban_account_name": null,
                            "sepa_bic": null,
                            "sepa_mandate_id": null,
                            "sepa_mandate_date": null,
                            "sepa_sequence_type": "RCUR",
                            "credit_card_number": null,
                            "credit_card_reference": null,
                            "credit_card_type": null,
                            "tax_number_validated_at": null,
                            "tax_number_valid": null,
                            "invoice_workflow_id": null,
                            "estimate_workflow_id": null,
                            "si_identifier": null,
                            "si_identifier_type": null,
                            "moneybird_payments_mandate": false,
                            "created_at": "2026-11-02T12:18:10.312Z",
                            "updated_at": "2026-11-02T12:18:10.312Z",
                            "version": 1793621890,
                            "sales_invoices_url": "https://moneybird.dev/123/sales_invoices/0000000000000000000000000000000000000000000000000000000000000001/all",
                            "notes": [],
                            "custom_fields": [],
                            "contact_people": [],
                            "archived": false
                          },
                          {
                            "id": "502689293764921055",
                            "administration_id": 123,
                            "company_name": "Relation 2",
                            "firstname": null,
                            "lastname": null,
                            "address1": null,
                            "address2": null,
                            "zipcode": null,
                            "city": null,
                            "country": "NL",
                            "phone": null,
                            "delivery_method": "Email",
                            "customer_id": "customer-2",
                            "tax_number": null,
                            "chamber_of_commerce": "12345678",
                            "bank_account": null,
                            "is_trusted": false,
                            "max_transfer_amount": null,
                            "attention": null,
                            "email": "contact2@example.com",
                            "email_ubl": false,
                            "send_invoices_to_attention": null,
                            "send_invoices_to_email": "contact2@example.com",
                            "send_estimates_to_attention": null,
                            "send_estimates_to_email": null,
                            "direct_debit": false,
                            "sepa_active": false,
                            "sepa_iban": null,
                            "sepa_iban_account_name": null,
                            "sepa_bic": null,
                            "sepa_mandate_id": null,
                            "sepa_mandate_date": null,
                            "sepa_sequence_type": "RCUR",
                            "credit_card_number": null,
                            "credit_card_reference": null,
                            "credit_card_type": null,
                            "tax_number_validated_at": null,
                            "tax_number_valid": null,
                            "invoice_workflow_id": null,
                            "estimate_workflow_id": null,
                            "si_identifier": null,
                            "si_identifier_type": null,
                            "moneybird_payments_mandate": false,
                            "created_at": "2026-11-02T12:18:10.316Z",
                            "updated_at": "2026-11-02T12:18:10.316Z",
                            "version": 1793621890,
                            "sales_invoices_url": "https://moneybird.dev/123/sales_invoices/0000000000000000000000000000000000000000000000000000000000000002/all",
                            "notes": [],
                            "custom_fields": [],
                            "contact_people": [],
                            "archived": false
                          }
                        ]
                      }
                    ]
                  },
                  "ReturnsNoGroupsWhenNothingMatches": {
                    "summary": "Returns no groups when nothing matches",
                    "value": []
                  }
                }
              }
            }
          },
          "400": {
            "description": "Bad request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/symbolic_error"
                },
                "examples": {
                  "ReturnsAnErrorForAPageNumberBelow1": {
                    "summary": "Returns an error for a page number below 1",
                    "value": {
                      "error": "page does not have a valid value"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Forbidden",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/symbolic_error"
                },
                "examples": {
                  "ReturnsForbiddenWhenTheFeatureIsNotActiveForTheAdministration": {
                    "summary": "Returns forbidden when the feature is not active for the administration",
                    "value": {
                      "error": "This feature is not active for this administration"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "Service Unavailable",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/symbolic_error"
                },
                "examples": {
                  "ReturnsACleanErrorInsteadOfAGeneric500WhenTheDatabaseGivesUp": {
                    "summary": "Returns a clean error instead of a generic 500 when the database gives up",
                    "value": {
                      "error": "Finding duplicate contacts took too long. Try again later."
                    }
                  }
                }
              }
            }
          }
        },
        "operationId": "get_administration_id_contacts_doubles"
      }
    },
    "/{administration_id}/contacts/filter{format}": {
      "get": {
        "summary": "Filter contacts",
        "description": "Returns a paginated list of all contacts in the administration.\n\n### Required scope(s)\n Any of: `estimates`, `sales_invoices`, `documents`, `bank` or `settings`",
        "tags": [
          "Contacts"
        ],
        "security": [
          {
            "bearerAuth": [
              "estimates"
            ]
          },
          {
            "bearerAuth": [
              "sales_invoices"
            ]
          },
          {
            "bearerAuth": [
              "documents"
            ]
          },
          {
            "bearerAuth": [
              "bank"
            ]
          },
          {
            "bearerAuth": [
              "settings"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/administration_id"
          },
          {
            "$ref": "#/components/parameters/format"
          },
          {
            "name": "filter",
            "in": "query",
            "required": false,
            "description": "Filters are `key:value` terms separated by commas (e.g. `first_name:henk,contact_type:company`). Any filter you pass replaces the defaults below entirely, so include every key you need. Available filters:\n\n| **Filter** | **Type** | **Default** | **Description** |\n| - | - | - | - |\n| created_after | `String` | | Select contacts created after the given time (exclusive). ISO 8601 formatted string. The time to compare with is in UTC timezone |\n| updated_after | `String` | | Select contacts updated after the given time (exclusive). ISO 8601 formatted string. The time to compare with is in UTC timezone |\n| first_name | `String` | | Select contacts with the given first name. Case-insensitive |\n| last_name | `String` | | Select contacts with the given last name. Case-insensitive |\n| estimate_workflow_id | `Integer` | | Filters contacts by a single Estimate workflow |\n| invoice_workflow_id | `Integer` | | Filters contacts by a single Invoice workflow |\n| contact_type | `String` | | The contact type. Possible values `all`, `company`, `private_individual` |\n| delivery_method | `String` | | The delivery method for invoices. Possible values. Possible values `all`, `email`, `post`, `manual`, `peppol`, `simplerinvoicing` |\n| trusted_type | `String` | | Whether the contact is trusted. Possible values `all`, `trusted`, `not_trusted` |\n| mandate_type | `String` | | The direct debit mandate of the contact. Possible values `all`, `manual` (the SEPA mandate fields are filled in), `adyen` (an accepted Moneybird mandate), `none` (no mandate at all) |",
            "schema": {
              "type": "string"
            },
            "examples": {
              "AllowsFilteringByFirstname": {
                "summary": "Allows filtering by firstname",
                "value": "first_name:piet"
              },
              "ReturnsAllContactsCreatedAfterGivenDatetime": {
                "summary": "Returns all contacts created after given datetime",
                "value": "created_after:2026-11-01 12:16:30 UTC"
              },
              "ReturnsOnlyContactsUpdatedAfterGivenDatetime": {
                "summary": "Returns only contacts updated after given datetime",
                "value": "updated_after:2026-11-02 12:16:36 UTC"
              }
            }
          },
          {
            "name": "query",
            "in": "query",
            "required": false,
            "description": "Free-text search across name, contact people, email, phone, customer id, tax number, chamber of commerce, IBAN, and address fields.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "include_archived",
            "in": "query",
            "required": false,
            "schema": {
              "type": [
                "boolean",
                "string"
              ]
            }
          },
          {
            "$ref": "#/components/parameters/page"
          },
          {
            "$ref": "#/components/parameters/per_page"
          }
        ],
        "responses": {
          "200": {
            "description": "A list of contacts",
            "content": {
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "$ref": "#/components/schemas/contact_response"
                  }
                },
                "examples": {
                  "AllowsFilteringByFirstname": {
                    "summary": "Allows filtering by firstname",
                    "value": [
                      {
                        "id": "502689189383374212",
                        "administration_id": 123,
                        "company_name": "Relation 1",
                        "firstname": "Piet",
                        "lastname": null,
                        "address1": null,
                        "address2": null,
                        "zipcode": null,
                        "city": null,
                        "country": "NL",
                        "phone": null,
                        "delivery_method": "Email",
                        "customer_id": "customer-2",
                        "tax_number": null,
                        "chamber_of_commerce": null,
                        "bank_account": null,
                        "is_trusted": false,
                        "max_transfer_amount": null,
                        "attention": null,
                        "email": "contact1@example.com",
                        "email_ubl": false,
                        "send_invoices_to_attention": null,
                        "send_invoices_to_email": "contact1@example.com",
                        "send_estimates_to_attention": null,
                        "send_estimates_to_email": null,
                        "direct_debit": false,
                        "sepa_active": false,
                        "sepa_iban": null,
                        "sepa_iban_account_name": null,
                        "sepa_bic": null,
                        "sepa_mandate_id": null,
                        "sepa_mandate_date": null,
                        "sepa_sequence_type": "RCUR",
                        "credit_card_number": null,
                        "credit_card_reference": null,
                        "credit_card_type": null,
                        "tax_number_validated_at": null,
                        "tax_number_valid": null,
                        "invoice_workflow_id": null,
                        "estimate_workflow_id": null,
                        "si_identifier": null,
                        "si_identifier_type": null,
                        "moneybird_payments_mandate": false,
                        "created_at": "2026-11-02T12:16:30.770Z",
                        "updated_at": "2026-11-02T12:16:30.773Z",
                        "version": 1793621790,
                        "sales_invoices_url": "https://moneybird.dev/123/sales_invoices/0000000000000000000000000000000000000000000000000000000000000002/all",
                        "notes": [],
                        "custom_fields": [],
                        "contact_people": [],
                        "archived": false,
                        "events": []
                      }
                    ]
                  },
                  "ReturnsAllContactsCreatedAfterGivenDatetime": {
                    "summary": "Returns all contacts created after given datetime",
                    "value": [
                      {
                        "id": "502689189477746072",
                        "administration_id": 123,
                        "company_name": "Foobar Holding B.V.",
                        "firstname": null,
                        "lastname": "Appleseed",
                        "address1": "Hoofdstraat 12",
                        "address2": "",
                        "zipcode": "1234 AB",
                        "city": "Amsterdam",
                        "country": "NL",
                        "phone": "",
                        "delivery_method": "Email",
                        "customer_id": "1",
                        "tax_number": "",
                        "chamber_of_commerce": "",
                        "bank_account": "",
                        "is_trusted": false,
                        "max_transfer_amount": null,
                        "attention": "",
                        "email": "info@example.com",
                        "email_ubl": true,
                        "send_invoices_to_attention": "",
                        "send_invoices_to_email": "info@example.com",
                        "send_estimates_to_attention": "",
                        "send_estimates_to_email": "info@example.com",
                        "direct_debit": false,
                        "sepa_active": false,
                        "sepa_iban": "",
                        "sepa_iban_account_name": "",
                        "sepa_bic": "",
                        "sepa_mandate_id": "",
                        "sepa_mandate_date": null,
                        "sepa_sequence_type": "RCUR",
                        "credit_card_number": "",
                        "credit_card_reference": "",
                        "credit_card_type": null,
                        "tax_number_validated_at": null,
                        "tax_number_valid": null,
                        "invoice_workflow_id": null,
                        "estimate_workflow_id": null,
                        "si_identifier": "",
                        "si_identifier_type": null,
                        "moneybird_payments_mandate": false,
                        "created_at": "2026-11-02T12:16:30.860Z",
                        "updated_at": "2026-11-02T12:16:30.872Z",
                        "version": 1793621790,
                        "sales_invoices_url": "https://moneybird.dev/123/sales_invoices/8f86aa696318f26ac7ae4c259d70d08c055fc5f7323e27b6209e400c49b188d9/all",
                        "notes": [],
                        "custom_fields": [],
                        "contact_people": [
                          {
                            "id": "502689189480891802",
                            "contact_id": "502689189477746072",
                            "administration_id": 123,
                            "firstname": "John",
                            "lastname": "Appleseed",
                            "phone": null,
                            "email": null,
                            "department": null,
                            "created_at": "2026-11-02T12:16:30.863Z",
                            "updated_at": "2026-11-02T12:16:30.863Z",
                            "version": 1793621790
                          }
                        ],
                        "archived": false,
                        "events": [
                          {
                            "administration_id": 123,
                            "user_id": "502689108256097381",
                            "action": "contact_created",
                            "link_entity_id": null,
                            "link_entity_type": null,
                            "data": {},
                            "created_at": "2026-11-02T12:16:30.868Z",
                            "updated_at": "2026-11-02T12:16:30.868Z"
                          }
                        ]
                      },
                      {
                        "id": "502689189496620447",
                        "administration_id": 123,
                        "company_name": "Foobar Holding B.V.",
                        "firstname": null,
                        "lastname": null,
                        "address1": "1 Infinite Loop",
                        "address2": "",
                        "zipcode": "123456",
                        "city": "Redmond",
                        "country": "NL",
                        "phone": "",
                        "delivery_method": "Email",
                        "customer_id": "2",
                        "tax_number": "",
                        "chamber_of_commerce": "",
                        "bank_account": "NL50TEST0166567191",
                        "is_trusted": false,
                        "max_transfer_amount": null,
                        "attention": "",
                        "email": "info@example.com",
                        "email_ubl": true,
                        "send_invoices_to_attention": "",
                        "send_invoices_to_email": "info@example.com",
                        "send_estimates_to_attention": "",
                        "send_estimates_to_email": "info@example.com",
                        "direct_debit": false,
                        "sepa_active": true,
                        "sepa_iban": "NL50TEST0166567191",
                        "sepa_iban_account_name": "Foobar Holding B.V.",
                        "sepa_bic": "RABONL2U",
                        "sepa_mandate_id": "MAN12313",
                        "sepa_mandate_date": "2014-01-01",
                        "sepa_sequence_type": "RCUR",
                        "credit_card_number": "",
                        "credit_card_reference": "",
                        "credit_card_type": null,
                        "tax_number_validated_at": null,
                        "tax_number_valid": null,
                        "invoice_workflow_id": null,
                        "estimate_workflow_id": null,
                        "si_identifier": "",
                        "si_identifier_type": null,
                        "moneybird_payments_mandate": false,
                        "created_at": "2026-11-02T12:16:30.878Z",
                        "updated_at": "2026-11-02T12:16:30.878Z",
                        "version": 1793621790,
                        "sales_invoices_url": "https://moneybird.dev/123/sales_invoices/ec5b1b97d822d1726de609e187f94384f972ed542e15b31f8c3401a6693dea2e/all",
                        "notes": [],
                        "custom_fields": [],
                        "contact_people": [
                          {
                            "id": "502689189498717601",
                            "contact_id": "502689189496620447",
                            "administration_id": 123,
                            "firstname": "John",
                            "lastname": "Doe",
                            "phone": null,
                            "email": null,
                            "department": null,
                            "created_at": "2026-11-02T12:16:30.881Z",
                            "updated_at": "2026-11-02T12:16:30.881Z",
                            "version": 1793621790
                          }
                        ],
                        "archived": false,
                        "events": [
                          {
                            "administration_id": 123,
                            "user_id": "502689108256097381",
                            "action": "contact_created",
                            "link_entity_id": null,
                            "link_entity_type": null,
                            "data": {},
                            "created_at": "2026-11-02T12:16:30.886Z",
                            "updated_at": "2026-11-02T12:16:30.886Z"
                          }
                        ]
                      },
                      {
                        "id": "502689189510251941",
                        "administration_id": 123,
                        "company_name": "Foobar Holding B.V.",
                        "firstname": null,
                        "lastname": null,
                        "address1": "Hoofdstraat 12",
                        "address2": null,
                        "zipcode": "1234AB",
                        "city": "Amsterdam",
                        "country": "NL",
                        "phone": null,
                        "delivery_method": "Email",
                        "customer_id": "customer-1",
                        "tax_number": null,
                        "chamber_of_commerce": null,
                        "bank_account": null,
                        "is_trusted": false,
                        "max_transfer_amount": null,
                        "attention": null,
                        "email": "info@example.com",
                        "email_ubl": true,
                        "send_invoices_to_attention": null,
                        "send_invoices_to_email": "info@example.com",
                        "send_estimates_to_attention": null,
                        "send_estimates_to_email": "info@example.com",
                        "direct_debit": false,
                        "sepa_active": false,
                        "sepa_iban": null,
                        "sepa_iban_account_name": null,
                        "sepa_bic": null,
                        "sepa_mandate_id": null,
                        "sepa_mandate_date": null,
                        "sepa_sequence_type": "RCUR",
                        "credit_card_number": null,
                        "credit_card_reference": null,
                        "credit_card_type": null,
                        "tax_number_validated_at": null,
                        "tax_number_valid": null,
                        "invoice_workflow_id": null,
                        "estimate_workflow_id": null,
                        "si_identifier": null,
                        "si_identifier_type": null,
                        "moneybird_payments_mandate": false,
                        "created_at": "2026-11-02T12:16:30.892Z",
                        "updated_at": "2026-11-02T12:16:30.892Z",
                        "version": 1793621790,
                        "sales_invoices_url": "https://moneybird.dev/123/sales_invoices/0000000000000000000000000000000000000000000000000000000000000001/all",
                        "notes": [],
                        "custom_fields": [],
                        "contact_people": [],
                        "archived": false,
                        "events": []
                      }
                    ]
                  },
                  "ReturnsOnlyContactsUpdatedAfterGivenDatetime": {
                    "summary": "Returns only contacts updated after given datetime",
                    "value": [
                      {
                        "id": "502689189636081080",
                        "administration_id": 123,
                        "company_name": "Foobar Holding B.V.",
                        "firstname": null,
                        "lastname": "foo",
                        "address1": "Hoofdstraat 12",
                        "address2": "",
                        "zipcode": "1234 AB",
                        "city": "Amsterdam",
                        "country": "NL",
                        "phone": "",
                        "delivery_method": "Email",
                        "customer_id": "1",
                        "tax_number": "",
                        "chamber_of_commerce": "",
                        "bank_account": "",
                        "is_trusted": false,
                        "max_transfer_amount": null,
                        "attention": "",
                        "email": "info@example.com",
                        "email_ubl": true,
                        "send_invoices_to_attention": "",
                        "send_invoices_to_email": "info@example.com",
                        "send_estimates_to_attention": "",
                        "send_estimates_to_email": "info@example.com",
                        "direct_debit": false,
                        "sepa_active": false,
                        "sepa_iban": "",
                        "sepa_iban_account_name": "",
                        "sepa_bic": "",
                        "sepa_mandate_id": "",
                        "sepa_mandate_date": null,
                        "sepa_sequence_type": "RCUR",
                        "credit_card_number": "",
                        "credit_card_reference": "",
                        "credit_card_type": null,
                        "tax_number_validated_at": null,
                        "tax_number_valid": null,
                        "invoice_workflow_id": null,
                        "estimate_workflow_id": null,
                        "si_identifier": "",
                        "si_identifier_type": null,
                        "moneybird_payments_mandate": false,
                        "created_at": "2026-11-02T12:16:31.011Z",
                        "updated_at": "2026-11-02T12:17:36.048Z",
                        "version": 1793621856,
                        "sales_invoices_url": "https://moneybird.dev/123/sales_invoices/5634e577b5c0ce1d0358756c3185d19e0da3050dda2e1f4e8e68bc23c4e6c3f7/all",
                        "notes": [],
                        "custom_fields": [],
                        "contact_people": [
                          {
                            "id": "502689189639226810",
                            "contact_id": "502689189636081080",
                            "administration_id": 123,
                            "firstname": "John",
                            "lastname": "Appleseed",
                            "phone": null,
                            "email": null,
                            "department": null,
                            "created_at": "2026-11-02T12:16:31.015Z",
                            "updated_at": "2026-11-02T12:16:31.015Z",
                            "version": 1793621791
                          }
                        ],
                        "archived": false,
                        "events": [
                          {
                            "administration_id": 123,
                            "user_id": "502689108256097381",
                            "action": "contact_created",
                            "link_entity_id": null,
                            "link_entity_type": null,
                            "data": {},
                            "created_at": "2026-11-02T12:16:31.020Z",
                            "updated_at": "2026-11-02T12:16:31.020Z"
                          }
                        ]
                      }
                    ]
                  }
                }
              }
            }
          }
        },
        "operationId": "get_administration_id_contacts_filter"
      }
    },
    "/{administration_id}/contacts/synchronization{format}": {
      "get": {
        "summary": "List all ids and versions",
        "description": "Returns all contacts in the administration. The list contains the contact id and the version of the contact.\nCheck if the version of the contact is newer than the version you have stored locally, use the `POST`\nvariant for fetching contacts with the given ids.\n\n### Required scope(s)\n Any of: `estimates`, `sales_invoices`, `documents`, `bank` or `settings`",
        "tags": [
          "Contacts"
        ],
        "security": [
          {
            "bearerAuth": [
              "estimates"
            ]
          },
          {
            "bearerAuth": [
              "sales_invoices"
            ]
          },
          {
            "bearerAuth": [
              "documents"
            ]
          },
          {
            "bearerAuth": [
              "bank"
            ]
          },
          {
            "bearerAuth": [
              "settings"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/administration_id"
          },
          {
            "$ref": "#/components/parameters/format"
          },
          {
            "name": "filter",
            "in": "query",
            "required": false,
            "description": "Comma-separated `key:value` filter terms. Same syntax as `GET /contacts/filter` — see that operation's description for the available keys.",
            "schema": {
              "type": "string"
            },
            "examples": {
              "RetrievesTheIdSForSynchronizationWithAFilter": {
                "summary": "Retrieves the id's for synchronization with a filter",
                "value": "first_name:henk"
              }
            }
          },
          {
            "name": "include_archived",
            "in": "query",
            "required": false,
            "schema": {
              "type": [
                "boolean",
                "string"
              ]
            }
          }
        ],
        "responses": {
          "200": {
            "description": "IDs and versions of records",
            "content": {
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "type": "object",
                    "unevaluatedProperties": false,
                    "properties": {
                      "id": {
                        "type": [
                          "integer",
                          "string"
                        ]
                      },
                      "version": {
                        "type": [
                          "integer",
                          "string"
                        ]
                      }
                    }
                  }
                },
                "examples": {
                  "ReturnAListOfIdSAndVersionIdS": {
                    "summary": "Return a list of id's and version id's",
                    "value": [
                      {
                        "id": "502689189050975531",
                        "version": 1793621790
                      },
                      {
                        "id": "502689189079287090",
                        "version": 1793621790
                      }
                    ]
                  },
                  "RetrievesTheIdSForSynchronizationWithAFilter": {
                    "summary": "Retrieves the id's for synchronization with a filter",
                    "value": [
                      {
                        "id": "502689189153736006",
                        "version": 1793621790
                      }
                    ]
                  }
                }
              }
            }
          }
        },
        "operationId": "get_administration_id_contacts_synchronization"
      },
      "post": {
        "summary": "Fetch contacts with given ids",
        "x-query": true,
        "description": "Given a list of contact ids, returns the contact information belonging to the contacts.\nReturns a maximum of 100 contacts, even if more ids are provided.\n\n### Required scope(s)\n Any of: `estimates`, `sales_invoices`, `documents`, `bank` or `settings`",
        "tags": [
          "Contacts"
        ],
        "security": [
          {
            "bearerAuth": [
              "estimates"
            ]
          },
          {
            "bearerAuth": [
              "sales_invoices"
            ]
          },
          {
            "bearerAuth": [
              "documents"
            ]
          },
          {
            "bearerAuth": [
              "bank"
            ]
          },
          {
            "bearerAuth": [
              "settings"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/administration_id"
          },
          {
            "$ref": "#/components/parameters/format"
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/*": {
              "schema": {
                "unevaluatedProperties": false,
                "type": "object",
                "properties": {
                  "ids": {
                    "type": "array",
                    "items": {
                      "type": [
                        "integer",
                        "string"
                      ]
                    }
                  }
                },
                "required": [
                  "ids"
                ]
              },
              "examples": {
                "ReturnAListOfGivenIds": {
                  "summary": "Return a list of given ids",
                  "value": {
                    "ids": [
                      502689190419367550,
                      502689190439290500
                    ]
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "A list of contacts",
            "content": {
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "$ref": "#/components/schemas/contact_response"
                  }
                },
                "examples": {
                  "ReturnAListOfGivenIds": {
                    "summary": "Return a list of given ids",
                    "value": [
                      {
                        "id": "502689190419367524",
                        "administration_id": 123,
                        "company_name": "Bar Foo",
                        "firstname": null,
                        "lastname": null,
                        "address1": "Hoofdstraat 12",
                        "address2": "",
                        "zipcode": "1234AB",
                        "city": "Amsterdam",
                        "country": "NL",
                        "phone": "",
                        "delivery_method": "Email",
                        "customer_id": "3",
                        "tax_number": "",
                        "chamber_of_commerce": "",
                        "bank_account": "",
                        "is_trusted": false,
                        "max_transfer_amount": null,
                        "attention": "",
                        "email": "info@example.com",
                        "email_ubl": true,
                        "send_invoices_to_attention": "",
                        "send_invoices_to_email": "info@example.com",
                        "send_estimates_to_attention": "",
                        "send_estimates_to_email": "info@example.com",
                        "direct_debit": false,
                        "sepa_active": false,
                        "sepa_iban": "",
                        "sepa_iban_account_name": "",
                        "sepa_bic": "",
                        "sepa_mandate_id": "",
                        "sepa_mandate_date": null,
                        "sepa_sequence_type": "RCUR",
                        "credit_card_number": "",
                        "credit_card_reference": "",
                        "credit_card_type": null,
                        "tax_number_validated_at": null,
                        "tax_number_valid": null,
                        "invoice_workflow_id": null,
                        "estimate_workflow_id": null,
                        "si_identifier": "",
                        "si_identifier_type": null,
                        "moneybird_payments_mandate": false,
                        "created_at": "2026-11-02T12:16:31.759Z",
                        "updated_at": "2026-11-02T12:16:31.759Z",
                        "version": 1793621791,
                        "sales_invoices_url": "https://moneybird.dev/123/sales_invoices/05bb66ce2a597630d3a0f063dcde3975400a1b2650a003bf35188f9f133eebba/all",
                        "notes": [],
                        "custom_fields": [],
                        "contact_people": [
                          {
                            "id": "502689190423561830",
                            "contact_id": "502689190419367524",
                            "administration_id": 123,
                            "firstname": "John",
                            "lastname": "Appleseed",
                            "phone": null,
                            "email": null,
                            "department": null,
                            "created_at": "2026-11-02T12:16:31.762Z",
                            "updated_at": "2026-11-02T12:16:31.762Z",
                            "version": 1793621791
                          }
                        ],
                        "archived": false,
                        "events": [
                          {
                            "administration_id": 123,
                            "user_id": "502689108256097381",
                            "action": "contact_created",
                            "link_entity_id": null,
                            "link_entity_type": null,
                            "data": {},
                            "created_at": "2026-11-02T12:16:31.766Z",
                            "updated_at": "2026-11-02T12:16:31.766Z"
                          }
                        ]
                      },
                      {
                        "id": "502689190439290476",
                        "administration_id": 123,
                        "company_name": "Foo Bar",
                        "firstname": null,
                        "lastname": null,
                        "address1": "Hoofdstraat 12",
                        "address2": "",
                        "zipcode": "1234AB",
                        "city": "Amsterdam",
                        "country": "NL",
                        "phone": "",
                        "delivery_method": "Email",
                        "customer_id": "4",
                        "tax_number": "",
                        "chamber_of_commerce": "",
                        "bank_account": "",
                        "is_trusted": false,
                        "max_transfer_amount": null,
                        "attention": "",
                        "email": "info@example.com",
                        "email_ubl": true,
                        "send_invoices_to_attention": "",
                        "send_invoices_to_email": "info@example.com",
                        "send_estimates_to_attention": "",
                        "send_estimates_to_email": "info@example.com",
                        "direct_debit": false,
                        "sepa_active": false,
                        "sepa_iban": "",
                        "sepa_iban_account_name": "",
                        "sepa_bic": "",
                        "sepa_mandate_id": "",
                        "sepa_mandate_date": null,
                        "sepa_sequence_type": "RCUR",
                        "credit_card_number": "",
                        "credit_card_reference": "",
                        "credit_card_type": null,
                        "tax_number_validated_at": null,
                        "tax_number_valid": null,
                        "invoice_workflow_id": null,
                        "estimate_workflow_id": null,
                        "si_identifier": "",
                        "si_identifier_type": null,
                        "moneybird_payments_mandate": false,
                        "created_at": "2026-11-02T12:16:31.777Z",
                        "updated_at": "2026-11-02T12:16:31.777Z",
                        "version": 1793621791,
                        "sales_invoices_url": "https://moneybird.dev/123/sales_invoices/863355f21645f1126fd6680145bf2fa378a3914dead5998f246e88f3881356d3/all",
                        "notes": [],
                        "custom_fields": [],
                        "contact_people": [
                          {
                            "id": "502689190441387630",
                            "contact_id": "502689190439290476",
                            "administration_id": 123,
                            "firstname": "Mark",
                            "lastname": "van Vliet",
                            "phone": null,
                            "email": null,
                            "department": null,
                            "created_at": "2026-11-02T12:16:31.780Z",
                            "updated_at": "2026-11-02T12:16:31.780Z",
                            "version": 1793621791
                          }
                        ],
                        "archived": false,
                        "events": [
                          {
                            "administration_id": 123,
                            "user_id": "502689108256097381",
                            "action": "contact_created",
                            "link_entity_id": null,
                            "link_entity_type": null,
                            "data": {},
                            "created_at": "2026-11-02T12:16:31.784Z",
                            "updated_at": "2026-11-02T12:16:31.784Z"
                          }
                        ]
                      }
                    ]
                  }
                }
              }
            }
          },
          "400": {
            "description": "Bad request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/symbolic_error"
                },
                "examples": {
                  "ReturnsA400StatusWhenIdsAreNotProvided": {
                    "summary": "Returns a 400 status when ids are not provided",
                    "value": {
                      "error": "Ids is required",
                      "symbolic": {
                        "ids": "required"
                      }
                    }
                  }
                }
              }
            }
          }
        },
        "operationId": "post_administration_id_contacts_synchronization"
      }
    },
    "/{administration_id}/contacts/{contact_id}/contact_people/{id}{format}": {
      "get": {
        "summary": "Get contact person",
        "description": "Returns all information about a contact person.\n\n### Required scope(s)\n Any of: `estimates`, `sales_invoices`, `documents`, `bank` or `settings`",
        "tags": [
          "Contacts"
        ],
        "security": [
          {
            "bearerAuth": [
              "estimates"
            ]
          },
          {
            "bearerAuth": [
              "sales_invoices"
            ]
          },
          {
            "bearerAuth": [
              "documents"
            ]
          },
          {
            "bearerAuth": [
              "bank"
            ]
          },
          {
            "bearerAuth": [
              "settings"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/administration_id"
          },
          {
            "name": "contact_id",
            "in": "path",
            "required": true,
            "schema": {
              "$ref": "#/components/schemas/identifier"
            }
          },
          {
            "name": "id",
            "in": "path",
            "required": true,
            "schema": {
              "$ref": "#/components/schemas/identifier"
            }
          },
          {
            "$ref": "#/components/parameters/format"
          }
        ],
        "responses": {
          "200": {
            "description": "A contact person",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/contact_person_response"
                },
                "examples": {
                  "ReturnAContactPerson": {
                    "summary": "Return a contact person",
                    "value": {
                      "id": "502689191855916992",
                      "contact_id": "502689191851722686",
                      "administration_id": 123,
                      "firstname": "John",
                      "lastname": "Appleseed",
                      "phone": null,
                      "email": null,
                      "department": null,
                      "created_at": "2026-11-02T12:16:33.129Z",
                      "updated_at": "2026-11-02T12:16:33.129Z",
                      "version": 1793621793
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Not found",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/symbolic_error"
                },
                "examples": {
                  "Returns404WhenContactPersonDoesNotExist": {
                    "summary": "Returns 404 when contact person does not exist",
                    "value": {
                      "error": "record not found",
                      "symbolic": {
                        "id": "not_found"
                      }
                    }
                  }
                }
              }
            }
          }
        },
        "operationId": "get_administration_id_contacts_contact_id_contact_people_id"
      },
      "patch": {
        "summary": "Update a contact person",
        "description": "When updating a contact, you only need to provide the information you want to change. Attributes you don't\nprovide in the request will not be updated.\n\n### Required scope(s)\n Any of: `estimates`, `sales_invoices`, `documents`, `bank` or `settings`",
        "tags": [
          "Contacts"
        ],
        "security": [
          {
            "bearerAuth": [
              "estimates"
            ]
          },
          {
            "bearerAuth": [
              "sales_invoices"
            ]
          },
          {
            "bearerAuth": [
              "documents"
            ]
          },
          {
            "bearerAuth": [
              "bank"
            ]
          },
          {
            "bearerAuth": [
              "settings"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/administration_id"
          },
          {
            "name": "contact_id",
            "in": "path",
            "required": true,
            "schema": {
              "$ref": "#/components/schemas/identifier"
            }
          },
          {
            "name": "id",
            "in": "path",
            "required": true,
            "schema": {
              "$ref": "#/components/schemas/identifier"
            }
          },
          {
            "$ref": "#/components/parameters/format"
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/*": {
              "schema": {
                "unevaluatedProperties": false,
                "type": "object",
                "properties": {
                  "contact_person": {
                    "type": "object",
                    "unevaluatedProperties": false,
                    "properties": {
                      "firstname": {
                        "type": "string"
                      },
                      "lastname": {
                        "type": "string"
                      },
                      "phone": {
                        "type": "string"
                      },
                      "email": {
                        "type": "string",
                        "description": "Should be a valid email addresses."
                      },
                      "department": {
                        "type": "string"
                      }
                    },
                    "required": []
                  }
                },
                "required": []
              },
              "examples": {
                "UpdateAContactPerson": {
                  "summary": "Update a contact person",
                  "value": {
                    "contact_person": {
                      "firstname": "John",
                      "lastname": "Doe"
                    }
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Contact person updated",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/contact_person_response"
                },
                "examples": {
                  "UpdateAContactPerson": {
                    "summary": "Update a contact person",
                    "value": {
                      "id": "502689190306121289",
                      "contact_id": "502689190302975559",
                      "administration_id": 123,
                      "firstname": "John",
                      "lastname": "Doe",
                      "phone": null,
                      "email": null,
                      "department": null,
                      "created_at": "2026-11-02T12:16:31.651Z",
                      "updated_at": "2026-11-02T12:16:31.690Z",
                      "version": 1793621791
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Not found",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/symbolic_error"
                },
                "examples": {
                  "ReturnsA404StatusWhenTheContactPersonIsNotFound": {
                    "summary": "Returns a 404 status when the contact person is not found",
                    "value": {
                      "error": "contact person not found",
                      "symbolic": {
                        "contact_person_id": "not_found"
                      }
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "Unprocessable entity",
            "content": {
              "application/json": {
                "schema": {
                  "anyOf": [
                    {
                      "$ref": "#/components/schemas/symbolic_error"
                    },
                    {
                      "$ref": "#/components/schemas/non_symbolic_error"
                    }
                  ]
                },
                "examples": {
                  "ReturnsA422StatusWhenWrongParamsAreProvided": {
                    "summary": "Returns a 422 status when wrong params are provided",
                    "value": {
                      "error": {
                        "firstname": [
                          "can't be blank"
                        ],
                        "lastname": [
                          "can't be blank"
                        ]
                      },
                      "details": {
                        "firstname": [
                          {
                            "error": "blank"
                          }
                        ],
                        "lastname": [
                          {
                            "error": "blank"
                          }
                        ]
                      }
                    }
                  }
                }
              }
            }
          }
        },
        "operationId": "patch_administration_id_contacts_contact_id_contact_people_id"
      },
      "delete": {
        "summary": "Delete a contact person",
        "description": "Deletes a contact person.\n\n### Required scope(s)\n Any of: `estimates`, `sales_invoices`, `documents`, `bank` or `settings`",
        "tags": [
          "Contacts"
        ],
        "security": [
          {
            "bearerAuth": [
              "estimates"
            ]
          },
          {
            "bearerAuth": [
              "sales_invoices"
            ]
          },
          {
            "bearerAuth": [
              "documents"
            ]
          },
          {
            "bearerAuth": [
              "bank"
            ]
          },
          {
            "bearerAuth": [
              "settings"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/administration_id"
          },
          {
            "name": "contact_id",
            "in": "path",
            "required": true,
            "schema": {
              "$ref": "#/components/schemas/identifier"
            }
          },
          {
            "name": "id",
            "in": "path",
            "required": true,
            "schema": {
              "$ref": "#/components/schemas/identifier"
            }
          },
          {
            "$ref": "#/components/parameters/format"
          }
        ],
        "responses": {
          "204": {
            "description": "Contact person deleted"
          },
          "404": {
            "description": "Not found",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/symbolic_error"
                },
                "examples": {
                  "ReturnsA404StatusWhenTheContactPersonIsNotFound": {
                    "summary": "Returns a 404 status when the contact person is not found",
                    "value": {
                      "error": "record not found",
                      "symbolic": {
                        "id": "not_found"
                      }
                    }
                  }
                }
              }
            }
          }
        },
        "operationId": "delete_administration_id_contacts_contact_id_contact_people_id"
      }
    },
    "/{administration_id}/contacts/{contact_id}/contact_people{format}": {
      "post": {
        "summary": "Create a new contact person",
        "description": "Creating a new contact person in the administration requires at least a `contact_person` hash including `firstname` and `lastname`.\n\n### Required scope(s)\n Any of: `estimates`, `sales_invoices`, `documents`, `bank` or `settings`",
        "tags": [
          "Contacts"
        ],
        "security": [
          {
            "bearerAuth": [
              "estimates"
            ]
          },
          {
            "bearerAuth": [
              "sales_invoices"
            ]
          },
          {
            "bearerAuth": [
              "documents"
            ]
          },
          {
            "bearerAuth": [
              "bank"
            ]
          },
          {
            "bearerAuth": [
              "settings"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/administration_id"
          },
          {
            "name": "contact_id",
            "in": "path",
            "required": true,
            "schema": {
              "$ref": "#/components/schemas/identifier"
            }
          },
          {
            "$ref": "#/components/parameters/format"
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/*": {
              "schema": {
                "unevaluatedProperties": false,
                "type": "object",
                "properties": {
                  "contact_person": {
                    "type": "object",
                    "unevaluatedProperties": false,
                    "properties": {
                      "firstname": {
                        "type": "string"
                      },
                      "lastname": {
                        "type": "string"
                      },
                      "phone": {
                        "type": "string"
                      },
                      "email": {
                        "type": "string",
                        "description": "Should be a valid email addresses."
                      },
                      "department": {
                        "type": "string"
                      }
                    },
                    "required": []
                  }
                },
                "required": []
              },
              "examples": {
                "CreateANewContactPersonWithAllParams": {
                  "summary": "Create a new contact person with all params",
                  "value": {
                    "contact_person": {
                      "firstname": "John",
                      "lastname": "Doe",
                      "phone": "123456789",
                      "email": "johndoe@moneybird.com",
                      "department": "Sales"
                    }
                  }
                },
                "CreateANewContactPersonWithMinimumParams": {
                  "summary": "Create a new contact person with minimum params",
                  "value": {
                    "contact_person": {
                      "firstname": "John",
                      "lastname": "Doe"
                    }
                  }
                }
              }
            }
          }
        },
        "responses": {
          "201": {
            "description": "Contact person created",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/contact_person_response"
                },
                "examples": {
                  "CreateANewContactPersonWithAllParams": {
                    "summary": "Create a new contact person with all params",
                    "value": {
                      "id": "502689188810851578",
                      "contact_id": "502689188775199981",
                      "administration_id": 123,
                      "firstname": "John",
                      "lastname": "Doe",
                      "phone": "123456789",
                      "email": "johndoe@moneybird.com",
                      "department": "Sales",
                      "created_at": "2026-11-02T12:16:30.225Z",
                      "updated_at": "2026-11-02T12:16:30.225Z",
                      "version": 1793621790
                    }
                  },
                  "CreateANewContactPersonWithMinimumParams": {
                    "summary": "Create a new contact person with minimum params",
                    "value": {
                      "id": "502689189022663975",
                      "contact_id": "502689188982818074",
                      "administration_id": 123,
                      "firstname": "John",
                      "lastname": "Doe",
                      "phone": null,
                      "email": null,
                      "department": null,
                      "created_at": "2026-11-02T12:16:30.426Z",
                      "updated_at": "2026-11-02T12:16:30.426Z",
                      "version": 1793621790
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "Unprocessable entity",
            "content": {
              "application/json": {
                "schema": {
                  "anyOf": [
                    {
                      "$ref": "#/components/schemas/symbolic_error"
                    },
                    {
                      "$ref": "#/components/schemas/non_symbolic_error"
                    }
                  ]
                },
                "examples": {
                  "ReturnsA422StatusWhenWrongParamsAreProvided": {
                    "summary": "Returns a 422 status when wrong params are provided",
                    "value": {
                      "error": {
                        "firstname": [
                          "can't be blank"
                        ],
                        "lastname": [
                          "can't be blank"
                        ]
                      },
                      "details": {
                        "firstname": [
                          {
                            "error": "blank"
                          }
                        ],
                        "lastname": [
                          {
                            "error": "blank"
                          }
                        ]
                      }
                    }
                  },
                  "ReturnsA422StatusWhenAWrongContactPersonIdIsProvided": {
                    "summary": "Returns a 422 status when a wrong contact person id is provided",
                    "value": {
                      "error": {
                        "contact": [
                          "must exist"
                        ]
                      },
                      "details": {
                        "contact": [
                          {
                            "error": "blank"
                          }
                        ]
                      }
                    }
                  }
                }
              }
            }
          }
        },
        "operationId": "post_administration_id_contacts_contact_id_contact_people"
      }
    },
    "/{administration_id}/contacts/{contact_id}/moneybird_payments_mandate/url{format}": {
      "post": {
        "summary": "Request an URL for setting up a Moneybird Payments mandate",
        "description": "Obtains an URL for setting up a Moneybird Payments mandate. You must provide\nthis URL to your contact to set-up the mandate. Your contact is required to\nmake a 15 cent payment. Every generated URL using this endpoint is valid\nfor 14 days after creation. Only available when Moneybird Payments is enabled\nfor the administration.\n\n### Required scope(s)\n `sales_invoices` and `settings`",
        "tags": [
          "Contacts"
        ],
        "security": [
          {
            "bearerAuth": [
              "sales_invoices",
              "settings"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/administration_id"
          },
          {
            "name": "contact_id",
            "in": "path",
            "required": true,
            "schema": {
              "$ref": "#/components/schemas/identifier"
            }
          },
          {
            "$ref": "#/components/parameters/format"
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/*": {
              "schema": {
                "unevaluatedProperties": false,
                "type": "object",
                "properties": {
                  "mandate_request": {
                    "type": "object",
                    "unevaluatedProperties": false,
                    "properties": {
                      "identity_id": {
                        "$ref": "#/components/schemas/identifier",
                        "description": "Should be a valid identity id."
                      },
                      "workflow_id": {
                        "$ref": "#/components/schemas/identifier",
                        "description": "Should be a valid workflow id. Restricts the available payment methods to the methods available for the selected workflow."
                      }
                    },
                    "required": []
                  }
                },
                "required": []
              },
              "examples": {
                "RequestsANewMoneybirdPaymentsMandateUrlWithACustomWorkflowId": {
                  "summary": "Requests a new moneybird payments mandate url with a custom workflow id",
                  "value": {
                    "mandate_request": {
                      "workflow_id": 502689190991890200
                    }
                  }
                },
                "RequestsANewMoneybirdPaymentsMandateUrl": {
                  "summary": "Requests a new moneybird payments mandate url",
                  "value": {}
                }
              }
            }
          }
        },
        "responses": {
          "201": {
            "description": "A URL for setting up a Moneybird Payments mandate",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "url": {
                      "type": "string"
                    }
                  }
                },
                "examples": {
                  "RequestsANewMoneybirdPaymentsMandateUrlWithACustomWorkflowId": {
                    "summary": "Requests a new moneybird payments mandate url with a custom workflow id",
                    "value": {
                      "url": "https://moneybird.dev/123/mandate_requests/zICBpl9yYWlsc4KkZGF0YdlXNTAyNjg5MTA4MjU2MDk3MzgxIDUwMjY4OTE5MDkzNzM2NDIwNCA1MDI2ODkxMDg2NTY2NTM0MTkKICAgICAgYWR5ZW4gNTAyNjg5MTkwOTkxODkwMTczo2V4cMcLB85q-vQgzhNBzZoA--a7872faa57b83563f93d7ee7dbb3529741ae7ea3"
                    }
                  },
                  "RequestsANewMoneybirdPaymentsMandateUrl": {
                    "summary": "Requests a new moneybird payments mandate url",
                    "value": {
                      "url": "https://moneybird.dev/123/mandate_requests/zICBpl9yYWlsc4KkZGF0YdlFNTAyNjg5MTA4MjU2MDk3MzgxIDUwMjY4OTE5MTAyODU5MDM0MSA1MDI2ODkxMDg2NTY2NTM0MTkKICAgICAgYWR5ZW4go2V4cMcLB85q-vQgzhi_07QA--d61cfaf41f291e5b7e2009d4af8998e6174185e1"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Error code",
            "content": {
              "application/json": {
                "schema": {
                  "type": "integer"
                },
                "examples": {
                  "DoesNotAllowAccessIfMoneybirdPaymentsIsDisabledForTheAdministration": {
                    "summary": "Does not allow access if moneybird payments is disabled for the administration",
                    "value": 403
                  },
                  "ReturnsA403StatusWhenAWrongContactIdIsProvided": {
                    "summary": "Returns a 403 status when a wrong contact id is provided",
                    "value": 403
                  }
                }
              }
            }
          }
        },
        "operationId": "post_administration_id_contacts_contact_id_moneybird_payments_mandate_url"
      }
    },
    "/{administration_id}/contacts/{contact_id}/moneybird_payments_mandate{format}": {
      "get": {
        "summary": "Get Moneybird Payments mandate",
        "description": "Returns information about the stored Moneybird Payments mandate. Only\navailable when Moneybird Payments is enabled for the administration.\n\n### Required scope(s)\n Any of: `estimates`, `sales_invoices`, `documents`, `bank` or `settings`",
        "tags": [
          "Contacts"
        ],
        "security": [
          {
            "bearerAuth": [
              "estimates"
            ]
          },
          {
            "bearerAuth": [
              "sales_invoices"
            ]
          },
          {
            "bearerAuth": [
              "documents"
            ]
          },
          {
            "bearerAuth": [
              "bank"
            ]
          },
          {
            "bearerAuth": [
              "settings"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/administration_id"
          },
          {
            "name": "contact_id",
            "in": "path",
            "required": true,
            "schema": {
              "$ref": "#/components/schemas/identifier"
            }
          },
          {
            "$ref": "#/components/parameters/format"
          }
        ],
        "responses": {
          "200": {
            "description": "A Moneybird Payments mandate",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/recurring_contract_response"
                },
                "examples": {
                  "ReturnsLimitedInformationIfMandateExistsButOnlyLimitedInformationIsAvailable": {
                    "summary": "Returns limited information if mandate exists, but only limited information is available",
                    "value": {
                      "type": "mccorporatecredit",
                      "sepa_mandate": false,
                      "bank": null,
                      "iban": null,
                      "bic": null,
                      "iban_account_name": null,
                      "card_expiry_month": "3",
                      "card_expiry_year": "2030",
                      "card_final_digits": "0010",
                      "created_at": "2022-04-11T09:17:56.000Z"
                    }
                  },
                  "ReturnsInformationAboutTheStoredMoneybirdPaymentsMandate": {
                    "summary": "Returns information about the stored moneybird payments mandate",
                    "value": {
                      "type": "idealtestissuer5",
                      "sepa_mandate": true,
                      "bank": "Test Issuer 5",
                      "iban": "NL81TEST0536169128",
                      "bic": "TESTNL05",
                      "iban_account_name": "E. Klaassen",
                      "card_expiry_month": null,
                      "card_expiry_year": null,
                      "card_final_digits": null,
                      "created_at": "2022-04-07T13:31:09.000Z"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Error code",
            "content": {
              "application/json": {
                "schema": {
                  "type": "integer"
                },
                "examples": {
                  "DoesNotAllowAccessIfMoneybirdPaymentsIsDisabledForTheAdministration": {
                    "summary": "Does not allow access if moneybird payments is disabled for the administration",
                    "value": 403
                  }
                }
              }
            }
          },
          "404": {
            "description": "Error code",
            "content": {
              "application/json": {
                "schema": {
                  "type": "integer"
                },
                "examples": {
                  "DoesReturnNotFoundWhenThereIsNoMoneybirdPaymentsMandateFound": {
                    "summary": "Does return not found when there is no moneybird payments mandate found",
                    "value": 404
                  },
                  "Returns404ForAContactBelongingToAnotherAdministration": {
                    "summary": "Returns 404 for a contact belonging to another administration",
                    "value": 404
                  }
                }
              }
            }
          }
        },
        "operationId": "get_administration_id_contacts_contact_id_moneybird_payments_mandate"
      },
      "post": {
        "summary": "Request a new Moneybird Payments mandate",
        "description": "Sends a request for a Moneybird Payments mandate to a contact via e-mail.\nYour contact will receive an email containing a link to authorise direct\ndebit payments through Moneybird Payments. Your contact is required to\nmake a 15 cent payment. Only available when Moneybird Payments is enabled\nfor the administration.\n\n### Required scope(s)\n `sales_invoices` and `settings`",
        "tags": [
          "Contacts"
        ],
        "security": [
          {
            "bearerAuth": [
              "sales_invoices",
              "settings"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/administration_id"
          },
          {
            "name": "contact_id",
            "in": "path",
            "required": true,
            "schema": {
              "$ref": "#/components/schemas/identifier"
            }
          },
          {
            "$ref": "#/components/parameters/format"
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/*": {
              "schema": {
                "unevaluatedProperties": false,
                "type": "object",
                "properties": {
                  "mandate_request": {
                    "type": "object",
                    "unevaluatedProperties": false,
                    "properties": {
                      "email_message": {
                        "type": "string"
                      },
                      "identity_id": {
                        "$ref": "#/components/schemas/identifier",
                        "description": "Should be a valid identity id."
                      },
                      "workflow_id": {
                        "$ref": "#/components/schemas/identifier",
                        "description": "Should be a valid workflow id. Restricts the available payment methods to the methods available for the selected workflow."
                      }
                    },
                    "required": []
                  }
                },
                "required": []
              },
              "examples": {
                "RequestsANewMoneybirdPaymentsMandate": {
                  "summary": "Requests a new moneybird payments mandate",
                  "value": {}
                },
                "AllowsSettingAWorkflowId": {
                  "summary": "Allows setting a workflow id",
                  "value": {
                    "mandate_request": {
                      "workflow_id": 502689193364817200
                    }
                  }
                },
                "AllowsForACustomMessageWithinTheRequestE-mail": {
                  "summary": "Allows for a custom message within the request e-mail",
                  "value": {
                    "mandate_request": {
                      "email_message": "We use direct debit for our services, for which we require your authorisation. You can authorise us for direct debit through the button below. This requires you to make a one-time payment of 15 cents. This way we can verify your bank account."
                    }
                  }
                }
              }
            }
          }
        },
        "responses": {
          "204": {
            "description": "Moneybird Payments mandate requested"
          },
          "403": {
            "description": "Error code",
            "content": {
              "application/json": {
                "schema": {
                  "type": "integer"
                },
                "examples": {
                  "DoesNotAllowAccessIfMoneybirdPaymentsIsDisabledForTheAdministration": {
                    "summary": "Does not allow access if moneybird payments is disabled for the administration",
                    "value": 403
                  },
                  "ReturnsA403StatusWhenAWrongContactIdIsProvided": {
                    "summary": "Returns a 403 status when a wrong contact id is provided",
                    "value": 403
                  }
                }
              }
            }
          }
        },
        "operationId": "post_administration_id_contacts_contact_id_moneybird_payments_mandate"
      },
      "delete": {
        "summary": "Delete a stored Moneybird Payments mandate",
        "description": "Deletes the stored Moneybird Payments mandate for the contact. Only\navailable when Moneybird Payments is enabled for the administration.\n\n### Required scope(s)\n Any of: `estimates`, `sales_invoices`, `documents`, `bank` or `settings`",
        "tags": [
          "Contacts"
        ],
        "security": [
          {
            "bearerAuth": [
              "estimates"
            ]
          },
          {
            "bearerAuth": [
              "sales_invoices"
            ]
          },
          {
            "bearerAuth": [
              "documents"
            ]
          },
          {
            "bearerAuth": [
              "bank"
            ]
          },
          {
            "bearerAuth": [
              "settings"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/administration_id"
          },
          {
            "name": "contact_id",
            "in": "path",
            "required": true,
            "schema": {
              "$ref": "#/components/schemas/identifier"
            }
          },
          {
            "$ref": "#/components/parameters/format"
          }
        ],
        "responses": {
          "204": {
            "description": "Contact deleted"
          },
          "403": {
            "description": "Error code",
            "content": {
              "application/json": {
                "schema": {
                  "type": "integer"
                },
                "examples": {
                  "DoesNotAllowAccessIfMoneybirdPaymentsIsDisabledForTheAdministration": {
                    "summary": "Does not allow access if moneybird payments is disabled for the administration",
                    "value": 403
                  },
                  "ReturnsA403StatusWhenAWrongContactIdIsProvided": {
                    "summary": "Returns a 403 status when a wrong contact id is provided",
                    "value": 403
                  }
                }
              }
            }
          }
        },
        "operationId": "delete_administration_id_contacts_contact_id_moneybird_payments_mandate"
      }
    },
    "/{administration_id}/contacts/{contact_id}/notes/{id}{format}": {
      "delete": {
        "summary": "Destroys note from entity",
        "description": "Deletes a note from the contact.\n\n### Required scope(s)\n Any of: `estimates`, `sales_invoices`, `documents`, `bank` or `settings`",
        "tags": [
          "Contacts"
        ],
        "security": [
          {
            "bearerAuth": [
              "estimates"
            ]
          },
          {
            "bearerAuth": [
              "sales_invoices"
            ]
          },
          {
            "bearerAuth": [
              "documents"
            ]
          },
          {
            "bearerAuth": [
              "bank"
            ]
          },
          {
            "bearerAuth": [
              "settings"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/administration_id"
          },
          {
            "name": "contact_id",
            "in": "path",
            "required": true,
            "schema": {
              "$ref": "#/components/schemas/identifier"
            }
          },
          {
            "name": "id",
            "in": "path",
            "required": true,
            "schema": {
              "$ref": "#/components/schemas/identifier"
            }
          },
          {
            "$ref": "#/components/parameters/format"
          }
        ],
        "responses": {
          "204": {
            "description": "Note deleted"
          },
          "400": {
            "description": "Bad request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/symbolic_error"
                },
                "examples": {
                  "ReturnsA400StatusWhenUserHasNoPermissionsToNotes": {
                    "summary": "Returns a 400 status when user has no permissions to notes",
                    "value": {
                      "error": "User has no permissions to notes for Contact",
                      "symbolic": {
                        "user": "insufficient_permissions"
                      }
                    }
                  }
                }
              }
            }
          }
        },
        "operationId": "delete_administration_id_contacts_contact_id_notes_id"
      }
    },
    "/{administration_id}/contacts/{contact_id}/notes{format}": {
      "post": {
        "summary": "Adds note to entity",
        "description": "Adds a note to the contact.\n\n### Required scope(s)\n Any of: `estimates`, `sales_invoices`, `documents`, `bank` or `settings`",
        "tags": [
          "Contacts"
        ],
        "security": [
          {
            "bearerAuth": [
              "estimates"
            ]
          },
          {
            "bearerAuth": [
              "sales_invoices"
            ]
          },
          {
            "bearerAuth": [
              "documents"
            ]
          },
          {
            "bearerAuth": [
              "bank"
            ]
          },
          {
            "bearerAuth": [
              "settings"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/administration_id"
          },
          {
            "name": "contact_id",
            "in": "path",
            "required": true,
            "schema": {
              "$ref": "#/components/schemas/identifier"
            }
          },
          {
            "$ref": "#/components/parameters/format"
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/*": {
              "schema": {
                "unevaluatedProperties": false,
                "type": "object",
                "properties": {
                  "note": {
                    "type": "object",
                    "unevaluatedProperties": false,
                    "properties": {
                      "note": {
                        "type": "string",
                        "description": "**Required**. Text for the note or to-do."
                      },
                      "todo": {
                        "type": [
                          "boolean",
                          "string"
                        ],
                        "description": "If `true` the note is a to-do."
                      },
                      "assignee_id": {
                        "$ref": "#/components/schemas/identifier",
                        "description": "Assign to-do to user. Should be a valid user id. If assignee_id is provided the note will be a to-do."
                      }
                    },
                    "required": []
                  }
                },
                "required": []
              },
              "examples": {
                "CreateANote": {
                  "summary": "Create a note",
                  "value": {
                    "note": {
                      "note": "Text of the note",
                      "assignee_id": 502689190772737700,
                      "todo": true
                    }
                  }
                }
              }
            }
          }
        },
        "responses": {
          "201": {
            "description": "Note created",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/note_response"
                },
                "examples": {
                  "CreateANote": {
                    "summary": "Create a note",
                    "value": {
                      "id": "502689190787417801",
                      "administration_id": 123,
                      "entity_id": "502689190738134715",
                      "entity_type": "Contact",
                      "user_id": "502689108256097381",
                      "assignee_id": "502689190772737735",
                      "todo": true,
                      "note": "Text of the note",
                      "completed_at": null,
                      "completed_by_id": null,
                      "todo_type": null,
                      "data": {},
                      "created_at": "2026-11-02T12:16:32.109Z",
                      "updated_at": "2026-11-02T12:16:32.109Z"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "Bad request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/symbolic_error"
                },
                "examples": {
                  "ReturnsA400StatusWhenAWrongContactIdIsProvided": {
                    "summary": "Returns a 400 status when a wrong contact id is provided",
                    "value": {
                      "error": "Entity is invalid; User has no permissions to notes for Contact",
                      "symbolic": {
                        "entity": "not_found",
                        "user": "insufficient_permissions"
                      }
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "Unprocessable entity",
            "content": {
              "application/json": {
                "schema": {
                  "anyOf": [
                    {
                      "$ref": "#/components/schemas/symbolic_error"
                    },
                    {
                      "$ref": "#/components/schemas/non_symbolic_error"
                    }
                  ]
                },
                "examples": {
                  "ReturnsA422StatusWhenWrongParamsAreProvided": {
                    "summary": "Returns a 422 status when wrong params are provided",
                    "value": {
                      "error": {
                        "note": [
                          "can't be blank"
                        ],
                        "todo_type": [
                          "can't be blank"
                        ]
                      },
                      "details": {
                        "note": [
                          {
                            "error": "blank"
                          }
                        ],
                        "todo_type": [
                          {
                            "error": "blank"
                          }
                        ]
                      }
                    }
                  }
                }
              }
            }
          }
        },
        "operationId": "post_administration_id_contacts_contact_id_notes"
      }
    },
    "/{administration_id}/contacts/{id}/additional_charges{format}": {
      "post": {
        "summary": "Create an additional charge to be invoiced at start of next period",
        "description": "At the end of the current period, the additional charges for a contact are merged\nwhere possible and an invoice will be created for them. The invoice will be scheduled\nfor sending at the first day of the next month.\n\n### Required scope(s)\n `sales_invoices`",
        "tags": [
          "Contacts"
        ],
        "security": [
          {
            "bearerAuth": [
              "sales_invoices"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/administration_id"
          },
          {
            "name": "id",
            "in": "path",
            "required": true,
            "schema": {
              "$ref": "#/components/schemas/identifier"
            }
          },
          {
            "$ref": "#/components/parameters/format"
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/*": {
              "schema": {
                "type": "object",
                "unevaluatedProperties": false,
                "properties": {
                  "product_id": {
                    "$ref": "#/components/schemas/identifier"
                  },
                  "amount": {
                    "type": [
                      "string",
                      "integer"
                    ],
                    "description": "The quantity on the invoice line, e.g. `1` or `5 x`."
                  },
                  "price": {
                    "$ref": "#/components/schemas/money",
                    "description": "The price per unit. Defaults to the price of the product for this contact at the start of the period."
                  },
                  "period": {
                    "type": "string",
                    "description": "The period the charge applies to, e.g. `20250101..20250131`, `202501..202503` or `this_month`."
                  },
                  "description": {
                    "type": "string"
                  },
                  "identifier": {
                    "type": "string",
                    "description": "Your own reference for this charge."
                  }
                },
                "required": [
                  "product_id",
                  "amount",
                  "period",
                  "description"
                ]
              },
              "examples": {
                "CreatesAUsageCharge": {
                  "summary": "Creates a usage charge",
                  "value": {
                    "product_id": 502689186391786500,
                    "amount": "5 x",
                    "price": 100,
                    "period": "20210601..20210630",
                    "description": "Transaction Costs"
                  }
                }
              }
            }
          }
        },
        "responses": {
          "201": {
            "description": "Subscription additional charge created",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/subscription_additional_charge_response"
                },
                "examples": {
                  "CreatesAUsageCharge": {
                    "summary": "Creates a usage charge",
                    "value": {
                      "id": "502689186403320848",
                      "administration_id": 123,
                      "contact_id": "502689186357183490",
                      "subscription_id": null,
                      "product_id": "502689186391786510",
                      "detail_id": null,
                      "amount": "5 x",
                      "price": "100.0",
                      "period": "202106..202106",
                      "description": "Transaction Costs"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "Bad request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/symbolic_error"
                },
                "examples": {
                  "ReturnsA400StatusWhenASubscriptionIdIsProvided": {
                    "summary": "Returns a 400 status when a subscription id is provided",
                    "value": {
                      "error": "contact_id or subscription_id is required",
                      "symbolic": {
                        "contact_id": "required"
                      }
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Not found",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/symbolic_error"
                },
                "examples": {
                  "ReturnsA404StatusWhenAWrongProductIdIsProvided": {
                    "summary": "Returns a 404 status when a wrong product id is provided",
                    "value": {
                      "error": "Product not found",
                      "symbolic": {
                        "product_id": "not_found"
                      }
                    }
                  }
                }
              }
            }
          }
        },
        "operationId": "post_administration_id_contacts_id_additional_charges"
      },
      "get": {
        "summary": "Get additional charges",
        "description": "Get the additional charges of the given contact.\n\n### Required scope(s)\n `sales_invoices`",
        "tags": [
          "Contacts"
        ],
        "security": [
          {
            "bearerAuth": [
              "sales_invoices"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/administration_id"
          },
          {
            "name": "id",
            "in": "path",
            "required": true,
            "schema": {
              "$ref": "#/components/schemas/identifier"
            }
          },
          {
            "$ref": "#/components/parameters/format"
          },
          {
            "name": "include_billed",
            "in": "query",
            "required": false,
            "schema": {
              "type": [
                "boolean",
                "string"
              ],
              "description": "If true, includes the additional charges that have already been billed. Default is false."
            },
            "examples": {
              "DoesReturnBilledAdditionalChargesIfIncludeBilledIsTrue": {
                "summary": "Does return billed additional charges if include billed is true",
                "value": "true"
              }
            }
          }
        ],
        "responses": {
          "200": {
            "description": "A list of additional charges",
            "content": {
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "$ref": "#/components/schemas/subscription_additional_charge_response"
                  }
                },
                "examples": {
                  "ViewsAdditionalChargesOfAContact": {
                    "summary": "Views additional charges of a contact",
                    "value": [
                      {
                        "id": "502689191624181647",
                        "administration_id": 123,
                        "contact_id": "502689191582238594",
                        "subscription_id": null,
                        "product_id": "502689191623133070",
                        "detail_id": null,
                        "amount": "1 x",
                        "price": "100.0",
                        "period": "202106..202106",
                        "description": "Transaction Costs"
                      }
                    ]
                  },
                  "DoesReturnBilledAdditionalChargesIfIncludeBilledIsTrue": {
                    "summary": "Does return billed additional charges if include billed is true",
                    "value": [
                      {
                        "id": "502689191688144799",
                        "administration_id": 123,
                        "contact_id": "502689191656687506",
                        "subscription_id": null,
                        "product_id": "502689191687096222",
                        "detail_id": null,
                        "amount": "1 x",
                        "price": "100.0",
                        "period": "202106..202106",
                        "description": "Transaction Costs"
                      },
                      {
                        "id": "502689191727990695",
                        "administration_id": 123,
                        "contact_id": "502689191656687506",
                        "subscription_id": null,
                        "product_id": "502689191691290528",
                        "detail_id": "502689191723796390",
                        "amount": "1 x",
                        "price": "100.0",
                        "period": "202106..202106",
                        "description": "Transaction Costs"
                      }
                    ]
                  }
                }
              }
            }
          },
          "404": {
            "$ref": "#/components/responses/404_not_found"
          }
        },
        "operationId": "get_administration_id_contacts_id_additional_charges"
      }
    },
    "/{administration_id}/contacts/{id}/archive{format}": {
      "patch": {
        "summary": "Archive a contact",
        "description": "Archives a contact.\n\n### Required scope(s)\n Any of: `estimates`, `sales_invoices`, `documents`, `bank` or `settings`",
        "tags": [
          "Contacts"
        ],
        "security": [
          {
            "bearerAuth": [
              "estimates"
            ]
          },
          {
            "bearerAuth": [
              "sales_invoices"
            ]
          },
          {
            "bearerAuth": [
              "documents"
            ]
          },
          {
            "bearerAuth": [
              "bank"
            ]
          },
          {
            "bearerAuth": [
              "settings"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/administration_id"
          },
          {
            "name": "id",
            "in": "path",
            "required": true,
            "schema": {
              "$ref": "#/components/schemas/identifier"
            }
          },
          {
            "$ref": "#/components/parameters/format"
          }
        ],
        "responses": {
          "204": {
            "description": "Contact archived"
          },
          "400": {
            "description": "Bad request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/symbolic_error"
                },
                "examples": {
                  "ReturnsA400StatusWhenTheContactIsAlreadyArchived": {
                    "summary": "Returns a 400 status when the contact is already archived",
                    "value": {
                      "error": "Contact can not be archived",
                      "symbolic": {
                        "id": "can_not_be_archived"
                      }
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Not found",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/symbolic_error"
                },
                "examples": {
                  "ReturnsA404StatusWhenTheContactIsNotFound": {
                    "summary": "Returns a 404 status when the contact is not found",
                    "value": {
                      "error": "record not found",
                      "symbolic": {
                        "id": "not_found"
                      }
                    }
                  }
                }
              }
            }
          }
        },
        "operationId": "patch_administration_id_contacts_id_archive"
      }
    },
    "/{administration_id}/contacts/{id}{format}": {
      "get": {
        "summary": "Get contact",
        "description": "Returns all information about a contact.\n\n### Required scope(s)\n Any of: `estimates`, `sales_invoices`, `documents`, `bank` or `settings`",
        "tags": [
          "Contacts"
        ],
        "security": [
          {
            "bearerAuth": [
              "estimates"
            ]
          },
          {
            "bearerAuth": [
              "sales_invoices"
            ]
          },
          {
            "bearerAuth": [
              "documents"
            ]
          },
          {
            "bearerAuth": [
              "bank"
            ]
          },
          {
            "bearerAuth": [
              "settings"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/administration_id"
          },
          {
            "name": "id",
            "in": "path",
            "required": true,
            "schema": {
              "$ref": "#/components/schemas/identifier"
            }
          },
          {
            "$ref": "#/components/parameters/format"
          },
          {
            "name": "include_archived",
            "in": "query",
            "required": false,
            "schema": {
              "type": [
                "boolean",
                "string"
              ]
            }
          }
        ],
        "responses": {
          "200": {
            "description": "A contact",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/contact_response"
                },
                "examples": {
                  "ReturnAContact": {
                    "summary": "Return a contact",
                    "value": {
                      "id": "502689189232379224",
                      "administration_id": 123,
                      "company_name": "Foobar Holding B.V.",
                      "firstname": null,
                      "lastname": "Appleseed",
                      "address1": "Hoofdstraat 12",
                      "address2": "",
                      "zipcode": "1234 AB",
                      "city": "Amsterdam",
                      "country": "NL",
                      "phone": "",
                      "delivery_method": "Email",
                      "customer_id": "1",
                      "tax_number": "",
                      "chamber_of_commerce": "",
                      "bank_account": "",
                      "is_trusted": false,
                      "max_transfer_amount": null,
                      "attention": "",
                      "email": "info@example.com",
                      "email_ubl": true,
                      "send_invoices_to_attention": "",
                      "send_invoices_to_email": "info@example.com",
                      "send_estimates_to_attention": "",
                      "send_estimates_to_email": "info@example.com",
                      "direct_debit": false,
                      "sepa_active": false,
                      "sepa_iban": "",
                      "sepa_iban_account_name": "",
                      "sepa_bic": "",
                      "sepa_mandate_id": "",
                      "sepa_mandate_date": null,
                      "sepa_sequence_type": "RCUR",
                      "credit_card_number": "",
                      "credit_card_reference": "",
                      "credit_card_type": null,
                      "tax_number_validated_at": null,
                      "tax_number_valid": null,
                      "invoice_workflow_id": null,
                      "estimate_workflow_id": null,
                      "si_identifier": "",
                      "si_identifier_type": null,
                      "moneybird_payments_mandate": false,
                      "created_at": "2026-11-02T12:16:30.626Z",
                      "updated_at": "2026-11-02T12:16:30.638Z",
                      "version": 1793621790,
                      "sales_invoices_url": "https://moneybird.dev/123/sales_invoices/58a5de6d58e03f839fa1a0102698c8a82f1d42704f13d9f132d0712fa24326d5/all",
                      "notes": [],
                      "custom_fields": [],
                      "contact_people": [
                        {
                          "id": "502689189235524954",
                          "contact_id": "502689189232379224",
                          "administration_id": 123,
                          "firstname": "John",
                          "lastname": "Appleseed",
                          "phone": null,
                          "email": null,
                          "department": null,
                          "created_at": "2026-11-02T12:16:30.629Z",
                          "updated_at": "2026-11-02T12:16:30.629Z",
                          "version": 1793621790
                        }
                      ],
                      "archived": false,
                      "events": [
                        {
                          "administration_id": 123,
                          "user_id": "502689108256097381",
                          "action": "contact_created",
                          "link_entity_id": null,
                          "link_entity_type": null,
                          "data": {},
                          "created_at": "2026-11-02T12:16:30.634Z",
                          "updated_at": "2026-11-02T12:16:30.634Z"
                        }
                      ]
                    }
                  },
                  "ReturnsSepaIbanAsBankAccount": {
                    "summary": "Returns sepa iban as bank account",
                    "value": {
                      "id": "502689189286905190",
                      "administration_id": 123,
                      "company_name": "Foobar Holding B.V.",
                      "firstname": null,
                      "lastname": "Appleseed",
                      "address1": "Hoofdstraat 12",
                      "address2": "",
                      "zipcode": "1234 AB",
                      "city": "Amsterdam",
                      "country": "NL",
                      "phone": "",
                      "delivery_method": "Email",
                      "customer_id": "1",
                      "tax_number": "",
                      "chamber_of_commerce": "",
                      "bank_account": "NL50TEST0166567191",
                      "is_trusted": false,
                      "max_transfer_amount": null,
                      "attention": "",
                      "email": "info@example.com",
                      "email_ubl": true,
                      "send_invoices_to_attention": "",
                      "send_invoices_to_email": "info@example.com",
                      "send_estimates_to_attention": "",
                      "send_estimates_to_email": "info@example.com",
                      "direct_debit": false,
                      "sepa_active": false,
                      "sepa_iban": "NL50TEST0166567191",
                      "sepa_iban_account_name": "",
                      "sepa_bic": "",
                      "sepa_mandate_id": "",
                      "sepa_mandate_date": null,
                      "sepa_sequence_type": "RCUR",
                      "credit_card_number": "",
                      "credit_card_reference": "",
                      "credit_card_type": null,
                      "tax_number_validated_at": null,
                      "tax_number_valid": null,
                      "invoice_workflow_id": null,
                      "estimate_workflow_id": null,
                      "si_identifier": "",
                      "si_identifier_type": null,
                      "moneybird_payments_mandate": false,
                      "created_at": "2026-11-02T12:16:30.679Z",
                      "updated_at": "2026-11-02T12:16:30.709Z",
                      "version": 1793621790,
                      "sales_invoices_url": "https://moneybird.dev/123/sales_invoices/6e88442301439d60d6452a8bc4ac5d95dc4dc7fe95bc984a31094c20f36e9604/all",
                      "notes": [],
                      "custom_fields": [],
                      "contact_people": [
                        {
                          "id": "502689189290050920",
                          "contact_id": "502689189286905190",
                          "administration_id": 123,
                          "firstname": "John",
                          "lastname": "Appleseed",
                          "phone": null,
                          "email": null,
                          "department": null,
                          "created_at": "2026-11-02T12:16:30.682Z",
                          "updated_at": "2026-11-02T12:16:30.682Z",
                          "version": 1793621790
                        }
                      ],
                      "archived": false,
                      "events": [
                        {
                          "administration_id": 123,
                          "user_id": "502689108256097381",
                          "action": "contact_created",
                          "link_entity_id": null,
                          "link_entity_type": null,
                          "data": {},
                          "created_at": "2026-11-02T12:16:30.687Z",
                          "updated_at": "2026-11-02T12:16:30.687Z"
                        }
                      ]
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Not found",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/symbolic_error"
                },
                "examples": {
                  "Returns404WhenContactDoesNotExist": {
                    "summary": "Returns 404 when contact does not exist",
                    "value": {
                      "error": "record not found",
                      "symbolic": {
                        "id": "not_found"
                      }
                    }
                  }
                }
              }
            }
          }
        },
        "operationId": "get_administration_id_contacts_id"
      },
      "patch": {
        "summary": "Update a contact",
        "description": "When updating a contact, you only need to provide the information you want to change. Attributes you don't\nprovide in the request will not be updated. Optional attributes can be removed by setting them to an empty string value.\n\n### Required scope(s)\n Any of: `estimates`, `sales_invoices`, `documents`, `bank` or `settings`",
        "tags": [
          "Contacts"
        ],
        "security": [
          {
            "bearerAuth": [
              "estimates"
            ]
          },
          {
            "bearerAuth": [
              "sales_invoices"
            ]
          },
          {
            "bearerAuth": [
              "documents"
            ]
          },
          {
            "bearerAuth": [
              "bank"
            ]
          },
          {
            "bearerAuth": [
              "settings"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/administration_id"
          },
          {
            "name": "id",
            "in": "path",
            "required": true,
            "schema": {
              "$ref": "#/components/schemas/identifier"
            }
          },
          {
            "$ref": "#/components/parameters/format"
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/*": {
              "schema": {
                "unevaluatedProperties": false,
                "type": "object",
                "properties": {
                  "contact": {
                    "type": "object",
                    "unevaluatedProperties": false,
                    "properties": {
                      "company_name": {
                        "type": "string",
                        "description": "A contact requires a non-blank `company_name`, `firstname` or `lastname`."
                      },
                      "address1": {
                        "type": "string",
                        "description": "Primary street address of the contact."
                      },
                      "address2": {
                        "type": "string",
                        "description": "Secondary address line (e.g. apartment number, building name)."
                      },
                      "zipcode": {
                        "type": "string",
                        "description": "Postal code or ZIP code of the contact's address."
                      },
                      "city": {
                        "type": "string",
                        "description": "City or town of the contact's address."
                      },
                      "country": {
                        "type": "string",
                        "description": "ISO two-character country code, e.g. NL or DE."
                      },
                      "phone": {
                        "type": "string",
                        "description": "Phone number of the contact."
                      },
                      "delivery_method": {
                        "type": "string",
                        "description": "Can be `Email`, `Simplerinvoicing`, `Peppol`, `Manual` or `Post`."
                      },
                      "email_ubl": {
                        "type": [
                          "boolean",
                          "string"
                        ],
                        "description": "When `true`, a UBL (Universal Business Language) XML file is attached when emailing invoices to this contact. Enables machine-readable invoice processing."
                      },
                      "customer_id": {
                        "type": "string",
                        "description": "Will be assigned automatically if empty. Should be unique for the administration."
                      },
                      "tax_number": {
                        "type": "string",
                        "description": "The tax identification number (VAT number) of the contact, e.g. `NL123456789B01`."
                      },
                      "firstname": {
                        "type": "string",
                        "description": "A contact requires a non-blank `company_name`, `firstname` or `lastname`."
                      },
                      "lastname": {
                        "type": "string",
                        "description": "A contact requires a non-blank `company_name`, `firstname` or `lastname`."
                      },
                      "chamber_of_commerce": {
                        "type": "string",
                        "description": "The CoC (Chamber of Commerce) registration number of the contact's business."
                      },
                      "bank_account": {
                        "type": "string",
                        "description": "The bank account number (IBAN) of the contact. Used for outgoing payments and displayed on documents."
                      },
                      "send_invoices_to_attention": {
                        "type": "string",
                        "description": "The name of the person to address invoices to (attention line)."
                      },
                      "send_invoices_to_email": {
                        "type": "string",
                        "description": "Should be one or more valid email addresses, separated by a comma."
                      },
                      "send_estimates_to_attention": {
                        "type": "string",
                        "description": "The name of the person to address estimates to (attention line)."
                      },
                      "send_estimates_to_email": {
                        "type": "string",
                        "description": "Should be one or more valid email addresses, separated by a comma."
                      },
                      "sepa_active": {
                        "type": [
                          "boolean",
                          "string"
                        ],
                        "description": "When `true`, all other SEPA fields are required."
                      },
                      "sepa_iban": {
                        "type": "string",
                        "description": "Should be a valid IBAN."
                      },
                      "sepa_iban_account_name": {
                        "type": "string",
                        "description": "The account holder name for the SEPA direct debit IBAN."
                      },
                      "sepa_bic": {
                        "type": "string",
                        "description": "Should be a valid BIC."
                      },
                      "sepa_mandate_id": {
                        "type": "string",
                        "description": "Should be unique for the administration."
                      },
                      "sepa_mandate_date": {
                        "type": "string",
                        "description": "Should be a date in the past."
                      },
                      "sepa_sequence_type": {
                        "type": "string",
                        "description": "Can be `RCUR`, `FRST`, `OOFF` or `FNAL`."
                      },
                      "invoice_workflow_id": {
                        "$ref": "#/components/schemas/identifier",
                        "description": "Should be a valid invoice workflow id."
                      },
                      "estimate_workflow_id": {
                        "$ref": "#/components/schemas/identifier",
                        "description": "Should be a valid estimate workflow id."
                      },
                      "si_identifier_type": {
                        "type": "string",
                        "description": "Can be `0002`, `0007`, `0009`, `0037`, `0060`, `0088`, `0096`, `0097`, `0106`, `0130`, `0135`, `0142`, `0151`, `0183`, `0184`, `0188`, `0190`, `0191`, `0192`, `0193`, `0195`, `0196`, `0198`, `0199`, `0200`, `0201`, `0204`, `0205`, `0208`, `0209`, `0210`, `0211`, `0212`, `0213`, `0215`, `0216`, `0221`, `0230`, `9910`, `9913`, `9914`, `9915`, `9918`, `9919`, `9920`, `9922`, `9923`, `9924`, `9925`, `9926`, `9927`, `9928`, `9929`, `9930`, `9931`, `9932`, `9933`, `9934`, `9935`, `9936`, `9937`, `9938`, `9939`, `9940`, `9941`, `9942`, `9943`, `9944`, `9945`, `9946`, `9947`, `9948`, `9949`, `9950`, `9951`, `9952`, `9953`, `9957` or `9959`."
                      },
                      "si_identifier": {
                        "type": "string",
                        "description": "The Peppol/e-invoicing identifier value for this contact. The format depends on the `si_identifier_type`."
                      },
                      "direct_debit": {
                        "type": [
                          "boolean",
                          "string"
                        ],
                        "description": "When `true`, invoices for this contact are collected via SEPA direct debit. Requires SEPA fields to be configured."
                      },
                      "custom_fields_attributes": {
                        "$ref": "#/components/schemas/custom_fields_attributes"
                      }
                    },
                    "required": []
                  }
                },
                "required": [
                  "contact"
                ]
              },
              "examples": {
                "UpdateAContact": {
                  "summary": "Update a contact",
                  "value": {
                    "contact": {
                      "company_name": "Test B.V."
                    }
                  }
                },
                "CreatesAContactPersonWhenCompanyNameFirstnameAndLastnameExistTogether": {
                  "summary": "Creates a contact person when company name, firstname and lastname exist together",
                  "value": {
                    "contact": {
                      "firstname": "Money",
                      "lastname": "Bird"
                    }
                  }
                },
                "UpdateAContactThatHasSepaActivated": {
                  "summary": "Update a contact that has sepa activated",
                  "value": {
                    "contact": {
                      "company_name": "Test B.V."
                    }
                  }
                },
                "UpdatesAContactWithGivenPeppolIdentifier": {
                  "summary": "Updates a contact with given peppol identifier",
                  "value": {
                    "contact": {
                      "si_identifier": "1234567",
                      "si_identifier_type": "NL:KVK"
                    }
                  }
                },
                "UpdateTheSepaSequenceType": {
                  "summary": "Update the sepa sequence type",
                  "value": {
                    "contact": {
                      "sepa_sequence_type": "FNAL"
                    }
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Contact updated",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/contact_response"
                },
                "examples": {
                  "UpdateAContact": {
                    "summary": "Update a contact",
                    "value": {
                      "id": "502689185726990164",
                      "administration_id": 123,
                      "company_name": "Test B.V.",
                      "firstname": null,
                      "lastname": "Appleseed",
                      "address1": "Hoofdstraat 12",
                      "address2": "",
                      "zipcode": "1234 AB",
                      "city": "Amsterdam",
                      "country": "NL",
                      "phone": "",
                      "delivery_method": "Email",
                      "customer_id": "1",
                      "tax_number": "",
                      "chamber_of_commerce": "",
                      "bank_account": "",
                      "is_trusted": false,
                      "max_transfer_amount": null,
                      "attention": "",
                      "email": "info@example.com",
                      "email_ubl": true,
                      "send_invoices_to_attention": "",
                      "send_invoices_to_email": "info@example.com",
                      "send_estimates_to_attention": "",
                      "send_estimates_to_email": "info@example.com",
                      "direct_debit": false,
                      "sepa_active": false,
                      "sepa_iban": "",
                      "sepa_iban_account_name": "",
                      "sepa_bic": "",
                      "sepa_mandate_id": "",
                      "sepa_mandate_date": null,
                      "sepa_sequence_type": "RCUR",
                      "credit_card_number": "",
                      "credit_card_reference": "",
                      "credit_card_type": null,
                      "tax_number_validated_at": null,
                      "tax_number_valid": null,
                      "invoice_workflow_id": null,
                      "estimate_workflow_id": null,
                      "si_identifier": "",
                      "si_identifier_type": null,
                      "moneybird_payments_mandate": false,
                      "created_at": "2026-11-02T12:16:27.283Z",
                      "updated_at": "2026-11-02T12:16:27.311Z",
                      "version": 1793621787,
                      "sales_invoices_url": "https://moneybird.dev/123/sales_invoices/4387bff6d063d10b82985dd0798419a0efe7fd70370f52d3363e3a4381da1034/all",
                      "notes": [],
                      "custom_fields": [],
                      "contact_people": [
                        {
                          "id": "502689185729087318",
                          "contact_id": "502689185726990164",
                          "administration_id": 123,
                          "firstname": "John",
                          "lastname": "Appleseed",
                          "phone": null,
                          "email": null,
                          "department": null,
                          "created_at": "2026-11-02T12:16:27.286Z",
                          "updated_at": "2026-11-02T12:16:27.286Z",
                          "version": 1793621787
                        },
                        {
                          "id": "502689185765787491",
                          "contact_id": "502689185726990164",
                          "administration_id": 123,
                          "firstname": null,
                          "lastname": "Appleseed",
                          "phone": null,
                          "email": null,
                          "department": null,
                          "created_at": "2026-11-02T12:16:27.321Z",
                          "updated_at": "2026-11-02T12:16:27.321Z",
                          "version": 1793621787
                        }
                      ],
                      "archived": false,
                      "events": [
                        {
                          "administration_id": 123,
                          "user_id": "502689108256097381",
                          "action": "contact_created",
                          "link_entity_id": null,
                          "link_entity_type": null,
                          "data": {},
                          "created_at": "2026-11-02T12:16:27.289Z",
                          "updated_at": "2026-11-02T12:16:27.289Z"
                        },
                        {
                          "administration_id": 123,
                          "user_id": "502689108256097381",
                          "action": "contact_changed",
                          "link_entity_id": null,
                          "link_entity_type": null,
                          "data": {
                            "changes": {
                              "company_name": [
                                "Foobar Holding B.V.",
                                "Test B.V."
                              ]
                            }
                          },
                          "created_at": "2026-11-02T12:16:27.313Z",
                          "updated_at": "2026-11-02T12:16:27.313Z"
                        }
                      ]
                    }
                  },
                  "CreatesAContactPersonWhenCompanyNameFirstnameAndLastnameExistTogether": {
                    "summary": "Creates a contact person when company name, firstname and lastname exist together",
                    "value": {
                      "id": "502689185816119156",
                      "administration_id": 123,
                      "company_name": "Moneybird B.V.",
                      "firstname": "Money",
                      "lastname": "Bird",
                      "address1": null,
                      "address2": null,
                      "zipcode": null,
                      "city": null,
                      "country": "NL",
                      "phone": null,
                      "delivery_method": "Email",
                      "customer_id": "customer-1",
                      "tax_number": null,
                      "chamber_of_commerce": null,
                      "bank_account": null,
                      "is_trusted": false,
                      "max_transfer_amount": null,
                      "attention": null,
                      "email": "contact1@example.com",
                      "email_ubl": false,
                      "send_invoices_to_attention": null,
                      "send_invoices_to_email": "contact1@example.com",
                      "send_estimates_to_attention": null,
                      "send_estimates_to_email": null,
                      "direct_debit": false,
                      "sepa_active": false,
                      "sepa_iban": null,
                      "sepa_iban_account_name": null,
                      "sepa_bic": null,
                      "sepa_mandate_id": null,
                      "sepa_mandate_date": null,
                      "sepa_sequence_type": "RCUR",
                      "credit_card_number": null,
                      "credit_card_reference": null,
                      "credit_card_type": null,
                      "tax_number_validated_at": null,
                      "tax_number_valid": null,
                      "invoice_workflow_id": null,
                      "estimate_workflow_id": null,
                      "si_identifier": null,
                      "si_identifier_type": null,
                      "moneybird_payments_mandate": false,
                      "created_at": "2026-11-02T12:16:27.369Z",
                      "updated_at": "2026-11-02T12:16:27.376Z",
                      "version": 1793621787,
                      "sales_invoices_url": "https://moneybird.dev/123/sales_invoices/0000000000000000000000000000000000000000000000000000000000000001/all",
                      "notes": [],
                      "custom_fields": [],
                      "contact_people": [
                        {
                          "id": "502689185828702072",
                          "contact_id": "502689185816119156",
                          "administration_id": 123,
                          "firstname": "Money",
                          "lastname": "Bird",
                          "phone": null,
                          "email": null,
                          "department": null,
                          "created_at": "2026-11-02T12:16:27.381Z",
                          "updated_at": "2026-11-02T12:16:27.381Z",
                          "version": 1793621787
                        }
                      ],
                      "archived": false,
                      "events": [
                        {
                          "administration_id": 123,
                          "user_id": "502689108256097381",
                          "action": "contact_changed",
                          "link_entity_id": null,
                          "link_entity_type": null,
                          "data": {
                            "changes": {
                              "firstname": [
                                null,
                                "Money"
                              ],
                              "lastname": [
                                null,
                                "Bird"
                              ]
                            }
                          },
                          "created_at": "2026-11-02T12:16:27.377Z",
                          "updated_at": "2026-11-02T12:16:27.377Z"
                        }
                      ]
                    }
                  },
                  "UpdateAContactThatHasSepaActivated": {
                    "summary": "Update a contact that has sepa activated",
                    "value": {
                      "id": "502689185995425701",
                      "administration_id": 123,
                      "company_name": "Test B.V.",
                      "firstname": null,
                      "lastname": null,
                      "address1": "1 Infinite Loop",
                      "address2": "",
                      "zipcode": "123456",
                      "city": "Redmond",
                      "country": "NL",
                      "phone": "",
                      "delivery_method": "Email",
                      "customer_id": "2",
                      "tax_number": "",
                      "chamber_of_commerce": "",
                      "bank_account": "NL50TEST0166567191",
                      "is_trusted": false,
                      "max_transfer_amount": null,
                      "attention": "",
                      "email": "info@example.com",
                      "email_ubl": true,
                      "send_invoices_to_attention": "",
                      "send_invoices_to_email": "info@example.com",
                      "send_estimates_to_attention": "",
                      "send_estimates_to_email": "info@example.com",
                      "direct_debit": false,
                      "sepa_active": true,
                      "sepa_iban": "NL50TEST0166567191",
                      "sepa_iban_account_name": "Foobar Holding B.V.",
                      "sepa_bic": "RABONL2U",
                      "sepa_mandate_id": "MAN12313",
                      "sepa_mandate_date": "2014-01-01",
                      "sepa_sequence_type": "RCUR",
                      "credit_card_number": "",
                      "credit_card_reference": "",
                      "credit_card_type": null,
                      "tax_number_validated_at": null,
                      "tax_number_valid": null,
                      "invoice_workflow_id": null,
                      "estimate_workflow_id": null,
                      "si_identifier": "",
                      "si_identifier_type": null,
                      "moneybird_payments_mandate": false,
                      "created_at": "2026-11-02T12:16:27.540Z",
                      "updated_at": "2026-11-02T12:16:27.556Z",
                      "version": 1793621787,
                      "sales_invoices_url": "https://moneybird.dev/123/sales_invoices/ada8fd05a7bbb89722f040132239dba5cb6d74184560e4ff913095da841ca28c/all",
                      "notes": [],
                      "custom_fields": [],
                      "contact_people": [
                        {
                          "id": "502689185998571431",
                          "contact_id": "502689185995425701",
                          "administration_id": 123,
                          "firstname": "John",
                          "lastname": "Doe",
                          "phone": null,
                          "email": null,
                          "department": null,
                          "created_at": "2026-11-02T12:16:27.543Z",
                          "updated_at": "2026-11-02T12:16:27.543Z",
                          "version": 1793621787
                        }
                      ],
                      "archived": false,
                      "events": [
                        {
                          "administration_id": 123,
                          "user_id": "502689108256097381",
                          "action": "contact_created",
                          "link_entity_id": null,
                          "link_entity_type": null,
                          "data": {},
                          "created_at": "2026-11-02T12:16:27.547Z",
                          "updated_at": "2026-11-02T12:16:27.547Z"
                        },
                        {
                          "administration_id": 123,
                          "user_id": "502689108256097381",
                          "action": "contact_changed",
                          "link_entity_id": null,
                          "link_entity_type": null,
                          "data": {
                            "changes": {
                              "company_name": [
                                "Foobar Holding B.V.",
                                "Test B.V."
                              ]
                            }
                          },
                          "created_at": "2026-11-02T12:16:27.558Z",
                          "updated_at": "2026-11-02T12:16:27.558Z"
                        }
                      ]
                    }
                  },
                  "UpdatesAContactWithGivenPeppolIdentifier": {
                    "summary": "Updates a contact with given peppol identifier",
                    "value": {
                      "id": "502689186091894716",
                      "administration_id": 123,
                      "company_name": "Foobar Holding B.V.",
                      "firstname": null,
                      "lastname": "Appleseed",
                      "address1": "Hoofdstraat 12",
                      "address2": "",
                      "zipcode": "1234 AB",
                      "city": "Amsterdam",
                      "country": "NL",
                      "phone": "",
                      "delivery_method": "Email",
                      "customer_id": "1",
                      "tax_number": "",
                      "chamber_of_commerce": "",
                      "bank_account": "",
                      "is_trusted": false,
                      "max_transfer_amount": null,
                      "attention": "",
                      "email": "info@example.com",
                      "email_ubl": true,
                      "send_invoices_to_attention": "",
                      "send_invoices_to_email": "info@example.com",
                      "send_estimates_to_attention": "",
                      "send_estimates_to_email": "info@example.com",
                      "direct_debit": false,
                      "sepa_active": false,
                      "sepa_iban": "",
                      "sepa_iban_account_name": "",
                      "sepa_bic": "",
                      "sepa_mandate_id": "",
                      "sepa_mandate_date": null,
                      "sepa_sequence_type": "RCUR",
                      "credit_card_number": "",
                      "credit_card_reference": "",
                      "credit_card_type": null,
                      "tax_number_validated_at": null,
                      "tax_number_valid": null,
                      "invoice_workflow_id": null,
                      "estimate_workflow_id": null,
                      "si_identifier": "1234567",
                      "si_identifier_type": "NL:KVK",
                      "moneybird_payments_mandate": false,
                      "created_at": "2026-11-02T12:16:27.631Z",
                      "updated_at": "2026-11-02T12:16:27.661Z",
                      "version": 1793621787,
                      "sales_invoices_url": "https://moneybird.dev/123/sales_invoices/b01cecd2d264b9ea4ccd431df5ec1f1bcb807c9832e8110b364480ecf5611abf/all",
                      "notes": [],
                      "custom_fields": [],
                      "contact_people": [
                        {
                          "id": "502689186093991870",
                          "contact_id": "502689186091894716",
                          "administration_id": 123,
                          "firstname": "John",
                          "lastname": "Appleseed",
                          "phone": null,
                          "email": null,
                          "department": null,
                          "created_at": "2026-11-02T12:16:27.634Z",
                          "updated_at": "2026-11-02T12:16:27.634Z",
                          "version": 1793621787
                        },
                        {
                          "id": "502689186128594891",
                          "contact_id": "502689186091894716",
                          "administration_id": 123,
                          "firstname": null,
                          "lastname": "Appleseed",
                          "phone": null,
                          "email": null,
                          "department": null,
                          "created_at": "2026-11-02T12:16:27.666Z",
                          "updated_at": "2026-11-02T12:16:27.666Z",
                          "version": 1793621787
                        }
                      ],
                      "archived": false,
                      "events": [
                        {
                          "administration_id": 123,
                          "user_id": "502689108256097381",
                          "action": "contact_created",
                          "link_entity_id": null,
                          "link_entity_type": null,
                          "data": {},
                          "created_at": "2026-11-02T12:16:27.638Z",
                          "updated_at": "2026-11-02T12:16:27.638Z"
                        },
                        {
                          "administration_id": 123,
                          "user_id": "502689108256097381",
                          "action": "contact_changed",
                          "link_entity_id": null,
                          "link_entity_type": null,
                          "data": {
                            "changes": {
                              "si_identifier": [
                                "",
                                "1234567"
                              ]
                            }
                          },
                          "created_at": "2026-11-02T12:16:27.663Z",
                          "updated_at": "2026-11-02T12:16:27.663Z"
                        }
                      ]
                    }
                  },
                  "UpdateTheSepaSequenceType": {
                    "summary": "Update the sepa sequence type",
                    "value": {
                      "id": "502689186174732246",
                      "administration_id": 123,
                      "company_name": "Foobar Holding B.V.",
                      "firstname": null,
                      "lastname": null,
                      "address1": "1 Infinite Loop",
                      "address2": "",
                      "zipcode": "123456",
                      "city": "Redmond",
                      "country": "NL",
                      "phone": "",
                      "delivery_method": "Email",
                      "customer_id": "2",
                      "tax_number": "",
                      "chamber_of_commerce": "",
                      "bank_account": "NL50TEST0166567191",
                      "is_trusted": false,
                      "max_transfer_amount": null,
                      "attention": "",
                      "email": "info@example.com",
                      "email_ubl": true,
                      "send_invoices_to_attention": "",
                      "send_invoices_to_email": "info@example.com",
                      "send_estimates_to_attention": "",
                      "send_estimates_to_email": "info@example.com",
                      "direct_debit": false,
                      "sepa_active": true,
                      "sepa_iban": "NL50TEST0166567191",
                      "sepa_iban_account_name": "Foobar Holding B.V.",
                      "sepa_bic": "RABONL2U",
                      "sepa_mandate_id": "MAN12313",
                      "sepa_mandate_date": "2014-01-01",
                      "sepa_sequence_type": "FNAL",
                      "credit_card_number": "",
                      "credit_card_reference": "",
                      "credit_card_type": null,
                      "tax_number_validated_at": null,
                      "tax_number_valid": null,
                      "invoice_workflow_id": null,
                      "estimate_workflow_id": null,
                      "si_identifier": "",
                      "si_identifier_type": null,
                      "moneybird_payments_mandate": false,
                      "created_at": "2026-11-02T12:16:27.710Z",
                      "updated_at": "2026-11-02T12:16:27.725Z",
                      "version": 1793621787,
                      "sales_invoices_url": "https://moneybird.dev/123/sales_invoices/74c5e50eb2fec582fcd41a4b2a945ccf434f5381802ce7089c3d9335e57cb24c/all",
                      "notes": [],
                      "custom_fields": [],
                      "contact_people": [
                        {
                          "id": "502689186177877976",
                          "contact_id": "502689186174732246",
                          "administration_id": 123,
                          "firstname": "John",
                          "lastname": "Doe",
                          "phone": null,
                          "email": null,
                          "department": null,
                          "created_at": "2026-11-02T12:16:27.713Z",
                          "updated_at": "2026-11-02T12:16:27.713Z",
                          "version": 1793621787
                        }
                      ],
                      "archived": false,
                      "events": [
                        {
                          "administration_id": 123,
                          "user_id": "502689108256097381",
                          "action": "contact_created",
                          "link_entity_id": null,
                          "link_entity_type": null,
                          "data": {},
                          "created_at": "2026-11-02T12:16:27.717Z",
                          "updated_at": "2026-11-02T12:16:27.717Z"
                        },
                        {
                          "administration_id": 123,
                          "user_id": "502689108256097381",
                          "action": "contact_changed",
                          "link_entity_id": null,
                          "link_entity_type": null,
                          "data": {
                            "changes": {
                              "sepa_sequence_type": [
                                "RCUR",
                                "FNAL"
                              ]
                            }
                          },
                          "created_at": "2026-11-02T12:16:27.727Z",
                          "updated_at": "2026-11-02T12:16:27.727Z"
                        }
                      ]
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "Bad request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/symbolic_error"
                },
                "examples": {
                  "DoesNotAllowMakingTheContactTrustedThroughTheApi": {
                    "summary": "Does not allow making the contact trusted through the api",
                    "value": {
                      "error": "An contact can only be trusted during the approval of a payment.",
                      "symbolic": {
                        "is_trusted": "permission"
                      }
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Not found",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/symbolic_error"
                },
                "examples": {
                  "ReturnsA404StatusWhenTheContactIsNotFound": {
                    "summary": "Returns a 404 status when the contact is not found",
                    "value": {
                      "error": "record not found",
                      "symbolic": {
                        "id": "not_found"
                      }
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "Unprocessable entity",
            "content": {
              "application/json": {
                "schema": {
                  "anyOf": [
                    {
                      "$ref": "#/components/schemas/symbolic_error"
                    },
                    {
                      "$ref": "#/components/schemas/non_symbolic_error"
                    }
                  ]
                },
                "examples": {
                  "ReturnsAnErrorWhenRecordIsInvalid": {
                    "summary": "Returns an error when record is invalid",
                    "value": {
                      "error": {
                        "firstname": [
                          "is required"
                        ],
                        "lastname": [
                          "is required"
                        ],
                        "company_name": [
                          "is required"
                        ]
                      },
                      "details": {
                        "firstname": [
                          {
                            "error": "is required"
                          }
                        ],
                        "lastname": [
                          {
                            "error": "is required"
                          }
                        ],
                        "company_name": [
                          {
                            "error": "is required"
                          }
                        ]
                      }
                    }
                  }
                }
              }
            }
          }
        },
        "operationId": "patch_administration_id_contacts_id"
      },
      "delete": {
        "summary": "Delete a contact",
        "description": "Deletes a contact. A contact that is still in use is archived instead.\n\n### Required scope(s)\n Any of: `estimates`, `sales_invoices`, `documents`, `bank` or `settings`",
        "tags": [
          "Contacts"
        ],
        "security": [
          {
            "bearerAuth": [
              "estimates"
            ]
          },
          {
            "bearerAuth": [
              "sales_invoices"
            ]
          },
          {
            "bearerAuth": [
              "documents"
            ]
          },
          {
            "bearerAuth": [
              "bank"
            ]
          },
          {
            "bearerAuth": [
              "settings"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/administration_id"
          },
          {
            "name": "id",
            "in": "path",
            "required": true,
            "schema": {
              "$ref": "#/components/schemas/identifier"
            }
          },
          {
            "$ref": "#/components/parameters/format"
          }
        ],
        "responses": {
          "204": {
            "description": "Contact deleted"
          },
          "404": {
            "description": "Not found",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/symbolic_error"
                },
                "examples": {
                  "ReturnsA404StatusWhenTheContactIsNotFound": {
                    "summary": "Returns a 404 status when the contact is not found",
                    "value": {
                      "error": "record not found",
                      "symbolic": {
                        "id": "not_found"
                      }
                    }
                  }
                }
              }
            }
          }
        },
        "operationId": "delete_administration_id_contacts_id"
      }
    },
    "/{administration_id}/contacts{format}": {
      "get": {
        "summary": "List all contacts",
        "description": "Returns a paginated list of contacts in the administration.\n\nSearching for contacts can be done by providing the `query` parameter with search terms. The API searches for matches in the following contact fields:\n\n- `company_name`\n- `attention`\n- `firstname`\n- `lastname`\n- `address1`\n- `address2`\n- `zipcode`\n- `city`\n- `country`\n- `email`\n- `phone`\n- `customer_id`\n- `tax_number`\n- `chamber_of_commerce`\n- `bank_account`\n\n### Required scope(s)\n Any of: `estimates`, `sales_invoices`, `documents`, `bank` or `settings`",
        "tags": [
          "Contacts"
        ],
        "security": [
          {
            "bearerAuth": [
              "estimates"
            ]
          },
          {
            "bearerAuth": [
              "sales_invoices"
            ]
          },
          {
            "bearerAuth": [
              "documents"
            ]
          },
          {
            "bearerAuth": [
              "bank"
            ]
          },
          {
            "bearerAuth": [
              "settings"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/administration_id"
          },
          {
            "$ref": "#/components/parameters/format"
          },
          {
            "$ref": "#/components/parameters/per_page"
          },
          {
            "$ref": "#/components/parameters/page"
          },
          {
            "name": "query",
            "in": "query",
            "required": false,
            "description": "Free-text search across name, contact people, email, phone, customer id, tax number, chamber of commerce, IBAN, and address fields.",
            "schema": {
              "type": "string"
            },
            "examples": {
              "ReturnsEmptyListWhenNoMatchesWithFilter": {
                "summary": "Returns empty list when no matches with filter",
                "value": "sdfadsfdsafdsafadsgasdfadsfdsf"
              },
              "AllowsFilteringByName": {
                "summary": "Allows filtering by name",
                "value": "appleseed"
              }
            }
          },
          {
            "name": "include_archived",
            "in": "query",
            "required": false,
            "schema": {
              "type": [
                "boolean",
                "string"
              ]
            }
          },
          {
            "name": "todo",
            "in": "query",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "contact_field",
            "in": "query",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "contact_value",
            "in": "query",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "contact_import_id",
            "in": "query",
            "required": false,
            "description": "Restrict to contacts created by the given contact import batch.",
            "schema": {
              "type": [
                "integer",
                "string"
              ]
            }
          }
        ],
        "responses": {
          "200": {
            "description": "A list of contacts",
            "content": {
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "$ref": "#/components/schemas/contact_response"
                  }
                },
                "examples": {
                  "ReturnsEmptyListWhenNoMatchesWithFilter": {
                    "summary": "Returns empty list when no matches with filter",
                    "value": []
                  },
                  "ReturnAListOfContacts": {
                    "summary": "Return a list of contacts",
                    "value": [
                      {
                        "id": "502689187106915405",
                        "administration_id": 123,
                        "company_name": "Foobar Holding B.V.",
                        "firstname": null,
                        "lastname": "Appleseed",
                        "address1": "Hoofdstraat 12",
                        "address2": "",
                        "zipcode": "1234 AB",
                        "city": "Amsterdam",
                        "country": "NL",
                        "phone": "",
                        "delivery_method": "Email",
                        "customer_id": "1",
                        "tax_number": "",
                        "chamber_of_commerce": "",
                        "bank_account": "",
                        "is_trusted": false,
                        "max_transfer_amount": null,
                        "attention": "",
                        "email": "info@example.com",
                        "email_ubl": true,
                        "send_invoices_to_attention": "",
                        "send_invoices_to_email": "info@example.com",
                        "send_estimates_to_attention": "",
                        "send_estimates_to_email": "info@example.com",
                        "direct_debit": false,
                        "sepa_active": false,
                        "sepa_iban": "",
                        "sepa_iban_account_name": "",
                        "sepa_bic": "",
                        "sepa_mandate_id": "",
                        "sepa_mandate_date": null,
                        "sepa_sequence_type": "RCUR",
                        "credit_card_number": "",
                        "credit_card_reference": "",
                        "credit_card_type": null,
                        "tax_number_validated_at": null,
                        "tax_number_valid": null,
                        "invoice_workflow_id": null,
                        "estimate_workflow_id": null,
                        "si_identifier": "",
                        "si_identifier_type": null,
                        "moneybird_payments_mandate": false,
                        "created_at": "2026-11-02T12:16:28.599Z",
                        "updated_at": "2026-11-02T12:16:28.616Z",
                        "version": 1793621788,
                        "sales_invoices_url": "https://moneybird.dev/123/sales_invoices/e255359ffa6c5b5ab786f896453093ce2664ab58f6ed948a13e4fb4e219cafba/all",
                        "notes": [],
                        "custom_fields": [],
                        "contact_people": [
                          {
                            "id": "502689187112158287",
                            "contact_id": "502689187106915405",
                            "administration_id": 123,
                            "firstname": "John",
                            "lastname": "Appleseed",
                            "phone": null,
                            "email": null,
                            "department": null,
                            "created_at": "2026-11-02T12:16:28.604Z",
                            "updated_at": "2026-11-02T12:16:28.604Z",
                            "version": 1793621788
                          },
                          {
                            "id": "502689187150955612",
                            "contact_id": "502689187106915405",
                            "administration_id": 123,
                            "firstname": "Jan",
                            "lastname": "Janssen",
                            "phone": "123-456-2346",
                            "email": "janjanssen@dev.null.moneybird.net",
                            "department": "Sales",
                            "created_at": "2026-11-02T12:16:28.641Z",
                            "updated_at": "2026-11-02T12:16:28.641Z",
                            "version": 1793621788
                          },
                          {
                            "id": "502689187156198495",
                            "contact_id": "502689187106915405",
                            "administration_id": 123,
                            "firstname": "Foo",
                            "lastname": "Bar",
                            "phone": "123-456-2346",
                            "email": "janjanssen@dev.null.moneybird.net",
                            "department": "Sales",
                            "created_at": "2026-11-02T12:16:28.647Z",
                            "updated_at": "2026-11-02T12:16:28.647Z",
                            "version": 1793621788
                          }
                        ],
                        "archived": false,
                        "events": [
                          {
                            "administration_id": 123,
                            "user_id": "502689108256097381",
                            "action": "contact_created",
                            "link_entity_id": null,
                            "link_entity_type": null,
                            "data": {},
                            "created_at": "2026-11-02T12:16:28.610Z",
                            "updated_at": "2026-11-02T12:16:28.610Z"
                          }
                        ]
                      },
                      {
                        "id": "502689187134178388",
                        "administration_id": 123,
                        "company_name": "Foobar Holding B.V.",
                        "firstname": null,
                        "lastname": null,
                        "address1": "1 Infinite Loop",
                        "address2": "",
                        "zipcode": "123456",
                        "city": "Redmond",
                        "country": "NL",
                        "phone": "",
                        "delivery_method": "Email",
                        "customer_id": "2",
                        "tax_number": "",
                        "chamber_of_commerce": "",
                        "bank_account": "NL50TEST0166567191",
                        "is_trusted": false,
                        "max_transfer_amount": null,
                        "attention": "",
                        "email": "info@example.com",
                        "email_ubl": true,
                        "send_invoices_to_attention": "",
                        "send_invoices_to_email": "info@example.com",
                        "send_estimates_to_attention": "",
                        "send_estimates_to_email": "info@example.com",
                        "direct_debit": false,
                        "sepa_active": true,
                        "sepa_iban": "NL50TEST0166567191",
                        "sepa_iban_account_name": "Foobar Holding B.V.",
                        "sepa_bic": "RABONL2U",
                        "sepa_mandate_id": "MAN12313",
                        "sepa_mandate_date": "2014-01-01",
                        "sepa_sequence_type": "RCUR",
                        "credit_card_number": "",
                        "credit_card_reference": "",
                        "credit_card_type": null,
                        "tax_number_validated_at": null,
                        "tax_number_valid": null,
                        "invoice_workflow_id": null,
                        "estimate_workflow_id": null,
                        "si_identifier": "",
                        "si_identifier_type": null,
                        "moneybird_payments_mandate": false,
                        "created_at": "2026-11-02T12:16:28.625Z",
                        "updated_at": "2026-11-02T12:16:28.625Z",
                        "version": 1793621788,
                        "sales_invoices_url": "https://moneybird.dev/123/sales_invoices/3610d9593b9db2dc91efaede68a4ebd5b10e318c76ef2a8c62a7af365968397a/all",
                        "notes": [],
                        "custom_fields": [],
                        "contact_people": [
                          {
                            "id": "502689187137324118",
                            "contact_id": "502689187134178388",
                            "administration_id": 123,
                            "firstname": "John",
                            "lastname": "Doe",
                            "phone": null,
                            "email": null,
                            "department": null,
                            "created_at": "2026-11-02T12:16:28.629Z",
                            "updated_at": "2026-11-02T12:16:28.629Z",
                            "version": 1793621788
                          }
                        ],
                        "archived": false,
                        "events": [
                          {
                            "administration_id": 123,
                            "user_id": "502689108256097381",
                            "action": "contact_created",
                            "link_entity_id": null,
                            "link_entity_type": null,
                            "data": {},
                            "created_at": "2026-11-02T12:16:28.634Z",
                            "updated_at": "2026-11-02T12:16:28.634Z"
                          }
                        ]
                      },
                      {
                        "id": "502689187147809882",
                        "administration_id": 123,
                        "company_name": "Foobar Holding B.V.",
                        "firstname": null,
                        "lastname": null,
                        "address1": "Hoofdstraat 12",
                        "address2": null,
                        "zipcode": "1234AB",
                        "city": "Amsterdam",
                        "country": "NL",
                        "phone": null,
                        "delivery_method": "Email",
                        "customer_id": "customer-1",
                        "tax_number": null,
                        "chamber_of_commerce": null,
                        "bank_account": null,
                        "is_trusted": false,
                        "max_transfer_amount": null,
                        "attention": null,
                        "email": "info@example.com",
                        "email_ubl": true,
                        "send_invoices_to_attention": null,
                        "send_invoices_to_email": "info@example.com",
                        "send_estimates_to_attention": null,
                        "send_estimates_to_email": "info@example.com",
                        "direct_debit": false,
                        "sepa_active": false,
                        "sepa_iban": null,
                        "sepa_iban_account_name": null,
                        "sepa_bic": null,
                        "sepa_mandate_id": null,
                        "sepa_mandate_date": null,
                        "sepa_sequence_type": "RCUR",
                        "credit_card_number": null,
                        "credit_card_reference": null,
                        "credit_card_type": null,
                        "tax_number_validated_at": null,
                        "tax_number_valid": null,
                        "invoice_workflow_id": null,
                        "estimate_workflow_id": null,
                        "si_identifier": null,
                        "si_identifier_type": null,
                        "moneybird_payments_mandate": false,
                        "created_at": "2026-11-02T12:16:28.638Z",
                        "updated_at": "2026-11-02T12:16:28.638Z",
                        "version": 1793621788,
                        "sales_invoices_url": "https://moneybird.dev/123/sales_invoices/0000000000000000000000000000000000000000000000000000000000000001/all",
                        "notes": [],
                        "custom_fields": [],
                        "contact_people": [],
                        "archived": false,
                        "events": []
                      }
                    ]
                  },
                  "AllowsFilteringByName": {
                    "summary": "Allows filtering by name",
                    "value": [
                      {
                        "id": "502689187570386019",
                        "administration_id": 123,
                        "company_name": "Foobar Holding B.V.",
                        "firstname": null,
                        "lastname": "Appleseed",
                        "address1": "Hoofdstraat 12",
                        "address2": "",
                        "zipcode": "1234 AB",
                        "city": "Amsterdam",
                        "country": "NL",
                        "phone": "",
                        "delivery_method": "Email",
                        "customer_id": "1",
                        "tax_number": "",
                        "chamber_of_commerce": "",
                        "bank_account": "",
                        "is_trusted": false,
                        "max_transfer_amount": null,
                        "attention": "",
                        "email": "info@example.com",
                        "email_ubl": true,
                        "send_invoices_to_attention": "",
                        "send_invoices_to_email": "info@example.com",
                        "send_estimates_to_attention": "",
                        "send_estimates_to_email": "info@example.com",
                        "direct_debit": false,
                        "sepa_active": false,
                        "sepa_iban": "",
                        "sepa_iban_account_name": "",
                        "sepa_bic": "",
                        "sepa_mandate_id": "",
                        "sepa_mandate_date": null,
                        "sepa_sequence_type": "RCUR",
                        "credit_card_number": "",
                        "credit_card_reference": "",
                        "credit_card_type": null,
                        "tax_number_validated_at": null,
                        "tax_number_valid": null,
                        "invoice_workflow_id": null,
                        "estimate_workflow_id": null,
                        "si_identifier": "",
                        "si_identifier_type": null,
                        "moneybird_payments_mandate": false,
                        "created_at": "2026-11-02T12:16:29.042Z",
                        "updated_at": "2026-11-02T12:16:29.108Z",
                        "version": 1793621789,
                        "sales_invoices_url": "https://moneybird.dev/123/sales_invoices/fb90438754209bc3a712f509cbdf27f6e25de67c393c55eb132f2a9bd820f35b/all",
                        "notes": [],
                        "custom_fields": [],
                        "contact_people": [
                          {
                            "id": "502689187594503269",
                            "contact_id": "502689187570386019",
                            "administration_id": 123,
                            "firstname": "John",
                            "lastname": "Appleseed",
                            "phone": null,
                            "email": null,
                            "department": null,
                            "created_at": "2026-11-02T12:16:29.065Z",
                            "updated_at": "2026-11-02T12:16:29.065Z",
                            "version": 1793621789
                          },
                          {
                            "id": "502689187765421170",
                            "contact_id": "502689187570386019",
                            "administration_id": 123,
                            "firstname": "Jan",
                            "lastname": "Janssen",
                            "phone": "123-456-2346",
                            "email": "janjanssen@dev.null.moneybird.net",
                            "department": "Sales",
                            "created_at": "2026-11-02T12:16:29.227Z",
                            "updated_at": "2026-11-02T12:16:29.227Z",
                            "version": 1793621789
                          },
                          {
                            "id": "502689187802121333",
                            "contact_id": "502689187570386019",
                            "administration_id": 123,
                            "firstname": "Foo",
                            "lastname": "Bar",
                            "phone": "123-456-2346",
                            "email": "janjanssen@dev.null.moneybird.net",
                            "department": "Sales",
                            "created_at": "2026-11-02T12:16:29.262Z",
                            "updated_at": "2026-11-02T12:16:29.262Z",
                            "version": 1793621789
                          }
                        ],
                        "archived": false,
                        "events": [
                          {
                            "administration_id": 123,
                            "user_id": "502689108256097381",
                            "action": "contact_created",
                            "link_entity_id": null,
                            "link_entity_type": null,
                            "data": {},
                            "created_at": "2026-11-02T12:16:29.102Z",
                            "updated_at": "2026-11-02T12:16:29.102Z"
                          }
                        ]
                      }
                    ]
                  },
                  "AllowsFilteringByNameInCombinationWithPagination": {
                    "summary": "Allows filtering by name in combination with pagination",
                    "value": []
                  },
                  "ReturnsPaginatedContactsOnPage1": {
                    "summary": "Returns paginated contacts on page 1",
                    "value": [
                      {
                        "id": "502689188439655589",
                        "administration_id": 123,
                        "company_name": "Foobar Holding B.V.",
                        "firstname": null,
                        "lastname": "Appleseed",
                        "address1": "Hoofdstraat 12",
                        "address2": "",
                        "zipcode": "1234 AB",
                        "city": "Amsterdam",
                        "country": "NL",
                        "phone": "",
                        "delivery_method": "Email",
                        "customer_id": "1",
                        "tax_number": "",
                        "chamber_of_commerce": "",
                        "bank_account": "",
                        "is_trusted": false,
                        "max_transfer_amount": null,
                        "attention": "",
                        "email": "info@example.com",
                        "email_ubl": true,
                        "send_invoices_to_attention": "",
                        "send_invoices_to_email": "info@example.com",
                        "send_estimates_to_attention": "",
                        "send_estimates_to_email": "info@example.com",
                        "direct_debit": false,
                        "sepa_active": false,
                        "sepa_iban": "",
                        "sepa_iban_account_name": "",
                        "sepa_bic": "",
                        "sepa_mandate_id": "",
                        "sepa_mandate_date": null,
                        "sepa_sequence_type": "RCUR",
                        "credit_card_number": "",
                        "credit_card_reference": "",
                        "credit_card_type": null,
                        "tax_number_validated_at": null,
                        "tax_number_valid": null,
                        "invoice_workflow_id": null,
                        "estimate_workflow_id": null,
                        "si_identifier": "",
                        "si_identifier_type": null,
                        "moneybird_payments_mandate": false,
                        "created_at": "2026-11-02T12:16:29.870Z",
                        "updated_at": "2026-11-02T12:16:29.887Z",
                        "version": 1793621789,
                        "sales_invoices_url": "https://moneybird.dev/123/sales_invoices/5ffc4d1c4a4cfdfbda02f7d4fce9cacadfbacc52eba9f915005079ac66def046/all",
                        "notes": [],
                        "custom_fields": [],
                        "contact_people": [
                          {
                            "id": "502689188444898471",
                            "contact_id": "502689188439655589",
                            "administration_id": 123,
                            "firstname": "John",
                            "lastname": "Appleseed",
                            "phone": null,
                            "email": null,
                            "department": null,
                            "created_at": "2026-11-02T12:16:29.875Z",
                            "updated_at": "2026-11-02T12:16:29.875Z",
                            "version": 1793621789
                          },
                          {
                            "id": "502689188488938676",
                            "contact_id": "502689188439655589",
                            "administration_id": 123,
                            "firstname": "Jan",
                            "lastname": "Janssen",
                            "phone": "123-456-2346",
                            "email": "janjanssen@dev.null.moneybird.net",
                            "department": "Sales",
                            "created_at": "2026-11-02T12:16:29.917Z",
                            "updated_at": "2026-11-02T12:16:29.917Z",
                            "version": 1793621789
                          },
                          {
                            "id": "502689188496278711",
                            "contact_id": "502689188439655589",
                            "administration_id": 123,
                            "firstname": "Foo",
                            "lastname": "Bar",
                            "phone": "123-456-2346",
                            "email": "janjanssen@dev.null.moneybird.net",
                            "department": "Sales",
                            "created_at": "2026-11-02T12:16:29.924Z",
                            "updated_at": "2026-11-02T12:16:29.924Z",
                            "version": 1793621789
                          }
                        ],
                        "archived": false,
                        "events": [
                          {
                            "administration_id": 123,
                            "user_id": "502689108256097381",
                            "action": "contact_created",
                            "link_entity_id": null,
                            "link_entity_type": null,
                            "data": {},
                            "created_at": "2026-11-02T12:16:29.882Z",
                            "updated_at": "2026-11-02T12:16:29.882Z"
                          }
                        ]
                      }
                    ]
                  },
                  "ReturnsPaginatedContactsOnPage2": {
                    "summary": "Returns paginated contacts on page 2",
                    "value": [
                      {
                        "id": "502689188565484738",
                        "administration_id": 123,
                        "company_name": "Foobar Holding B.V.",
                        "firstname": null,
                        "lastname": null,
                        "address1": "1 Infinite Loop",
                        "address2": "",
                        "zipcode": "123456",
                        "city": "Redmond",
                        "country": "NL",
                        "phone": "",
                        "delivery_method": "Email",
                        "customer_id": "2",
                        "tax_number": "",
                        "chamber_of_commerce": "",
                        "bank_account": "NL50TEST0166567191",
                        "is_trusted": false,
                        "max_transfer_amount": null,
                        "attention": "",
                        "email": "info@example.com",
                        "email_ubl": true,
                        "send_invoices_to_attention": "",
                        "send_invoices_to_email": "info@example.com",
                        "send_estimates_to_attention": "",
                        "send_estimates_to_email": "info@example.com",
                        "direct_debit": false,
                        "sepa_active": true,
                        "sepa_iban": "NL50TEST0166567191",
                        "sepa_iban_account_name": "Foobar Holding B.V.",
                        "sepa_bic": "RABONL2U",
                        "sepa_mandate_id": "MAN12313",
                        "sepa_mandate_date": "2014-01-01",
                        "sepa_sequence_type": "RCUR",
                        "credit_card_number": "",
                        "credit_card_reference": "",
                        "credit_card_type": null,
                        "tax_number_validated_at": null,
                        "tax_number_valid": null,
                        "invoice_workflow_id": null,
                        "estimate_workflow_id": null,
                        "si_identifier": "",
                        "si_identifier_type": null,
                        "moneybird_payments_mandate": false,
                        "created_at": "2026-11-02T12:16:29.990Z",
                        "updated_at": "2026-11-02T12:16:29.990Z",
                        "version": 1793621789,
                        "sales_invoices_url": "https://moneybird.dev/123/sales_invoices/2a616275b853eedf847ac05ae47777ec3b10c083119fd4309bda5af5293d98e1/all",
                        "notes": [],
                        "custom_fields": [],
                        "contact_people": [
                          {
                            "id": "502689188568630468",
                            "contact_id": "502689188565484738",
                            "administration_id": 123,
                            "firstname": "John",
                            "lastname": "Doe",
                            "phone": null,
                            "email": null,
                            "department": null,
                            "created_at": "2026-11-02T12:16:29.993Z",
                            "updated_at": "2026-11-02T12:16:29.993Z",
                            "version": 1793621789
                          }
                        ],
                        "archived": false,
                        "events": [
                          {
                            "administration_id": 123,
                            "user_id": "502689108256097381",
                            "action": "contact_created",
                            "link_entity_id": null,
                            "link_entity_type": null,
                            "data": {},
                            "created_at": "2026-11-02T12:16:29.998Z",
                            "updated_at": "2026-11-02T12:16:29.998Z"
                          }
                        ]
                      }
                    ]
                  }
                }
              }
            }
          },
          "400": {
            "description": "Bad request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/symbolic_error"
                },
                "examples": {
                  "ReturnsAnErrorWhenTooManyContactsAreRequested": {
                    "summary": "Returns an error when too many contacts are requested",
                    "value": {
                      "error": "per_page does not have a valid value"
                    }
                  }
                }
              }
            }
          }
        },
        "operationId": "get_administration_id_contacts"
      },
      "post": {
        "summary": "Create a new contact",
        "description": "Creating a new contact in the administration requires at least a `company_name` or a `firstname` and `lastname`.\nWhen filling a custom field, both `id` and `value` are required. See the custom field example for more information.\n\n### Required scope(s)\n Any of: `estimates`, `sales_invoices`, `documents`, `bank` or `settings`",
        "tags": [
          "Contacts"
        ],
        "security": [
          {
            "bearerAuth": [
              "estimates"
            ]
          },
          {
            "bearerAuth": [
              "sales_invoices"
            ]
          },
          {
            "bearerAuth": [
              "documents"
            ]
          },
          {
            "bearerAuth": [
              "bank"
            ]
          },
          {
            "bearerAuth": [
              "settings"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/administration_id"
          },
          {
            "$ref": "#/components/parameters/format"
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/*": {
              "schema": {
                "unevaluatedProperties": false,
                "type": "object",
                "properties": {
                  "contact": {
                    "type": "object",
                    "unevaluatedProperties": false,
                    "properties": {
                      "company_name": {
                        "type": "string",
                        "description": "A contact requires a non-blank `company_name`, `firstname` or `lastname`."
                      },
                      "address1": {
                        "type": "string",
                        "description": "Primary street address of the contact."
                      },
                      "address2": {
                        "type": "string",
                        "description": "Secondary address line (e.g. apartment number, building name)."
                      },
                      "zipcode": {
                        "type": "string",
                        "description": "Postal code or ZIP code of the contact's address."
                      },
                      "city": {
                        "type": "string",
                        "description": "City or town of the contact's address."
                      },
                      "country": {
                        "type": "string",
                        "description": "ISO two-character country code, e.g. NL or DE."
                      },
                      "phone": {
                        "type": "string",
                        "description": "Phone number of the contact."
                      },
                      "delivery_method": {
                        "type": "string",
                        "description": "Can be `Email`, `Simplerinvoicing`, `Peppol`, `Manual` or `Post`."
                      },
                      "customer_id": {
                        "type": "string",
                        "description": "Will be assigned automatically if empty. Should be unique for the administration."
                      },
                      "tax_number": {
                        "type": "string",
                        "description": "The tax identification number (VAT number) of the contact, e.g. `NL123456789B01`."
                      },
                      "firstname": {
                        "type": "string",
                        "description": "A contact requires a non-blank `company_name`, `firstname` or `lastname`."
                      },
                      "lastname": {
                        "type": "string",
                        "description": "A contact requires a non-blank `company_name`, `firstname` or `lastname`."
                      },
                      "chamber_of_commerce": {
                        "type": "string",
                        "description": "The CoC (Chamber of Commerce) registration number of the contact's business."
                      },
                      "bank_account": {
                        "type": "string",
                        "description": "The bank account number (IBAN) of the contact. Used for outgoing payments and displayed on documents."
                      },
                      "send_invoices_to_attention": {
                        "type": "string",
                        "description": "The name of the person to address invoices to (attention line), e.g. \"Finance Department\"."
                      },
                      "send_invoices_to_email": {
                        "type": "string",
                        "description": "Should be one or more valid email addresses, separated by a comma."
                      },
                      "send_estimates_to_attention": {
                        "type": "string",
                        "description": "The name of the person to address estimates to (attention line)."
                      },
                      "send_estimates_to_email": {
                        "type": "string",
                        "description": "Should be one or more valid email addresses, separated by a comma."
                      },
                      "sepa_active": {
                        "type": [
                          "boolean",
                          "string"
                        ],
                        "description": "When `true`, all other SEPA fields are required."
                      },
                      "sepa_iban": {
                        "type": "string",
                        "description": "Should be a valid IBAN."
                      },
                      "sepa_iban_account_name": {
                        "type": "string",
                        "description": "The account holder name for the SEPA direct debit IBAN."
                      },
                      "sepa_bic": {
                        "type": "string",
                        "description": "Should be a valid BIC."
                      },
                      "sepa_mandate_id": {
                        "type": "string",
                        "description": "Should be unique for the administration."
                      },
                      "sepa_mandate_date": {
                        "type": "string",
                        "description": "Should be a date in the past."
                      },
                      "sepa_sequence_type": {
                        "type": "string",
                        "description": "Can be `RCUR`, `FRST`, `OOFF` or `FNAL`."
                      },
                      "si_identifier_type": {
                        "type": "string",
                        "description": "Can be `0002`, `0007`, `0009`, `0037`, `0060`, `0088`, `0096`, `0097`, `0106`, `0130`, `0135`, `0142`, `0151`, `0183`, `0184`, `0188`, `0190`, `0191`, `0192`, `0193`, `0195`, `0196`, `0198`, `0199`, `0200`, `0201`, `0204`, `0205`, `0208`, `0209`, `0210`, `0211`, `0212`, `0213`, `0215`, `0216`, `0221`, `0230`, `9910`, `9913`, `9914`, `9915`, `9918`, `9919`, `9920`, `9922`, `9923`, `9924`, `9925`, `9926`, `9927`, `9928`, `9929`, `9930`, `9931`, `9932`, `9933`, `9934`, `9935`, `9936`, `9937`, `9938`, `9939`, `9940`, `9941`, `9942`, `9943`, `9944`, `9945`, `9946`, `9947`, `9948`, `9949`, `9950`, `9951`, `9952`, `9953`, `9957` or `9959`."
                      },
                      "si_identifier": {
                        "type": "string",
                        "description": "The Peppol/e-invoicing identifier value for this contact. The format depends on the `si_identifier_type`."
                      },
                      "invoice_workflow_id": {
                        "$ref": "#/components/schemas/identifier",
                        "description": "Should be a valid invoice workflow id."
                      },
                      "estimate_workflow_id": {
                        "$ref": "#/components/schemas/identifier",
                        "description": "Should be a valid estimate workflow id."
                      },
                      "email_ubl": {
                        "type": [
                          "boolean",
                          "string"
                        ],
                        "description": "When `true`, a UBL (Universal Business Language) XML file is attached when emailing invoices to this contact. Enables machine-readable invoice processing."
                      },
                      "direct_debit": {
                        "type": [
                          "boolean",
                          "string"
                        ],
                        "description": "When `true`, invoices for this contact are collected via SEPA direct debit. Requires SEPA fields to be configured."
                      },
                      "custom_fields_attributes": {
                        "$ref": "#/components/schemas/custom_fields_attributes"
                      },
                      "contact_person": {
                        "type": "object",
                        "description": "An optional initial contact person to create along with the contact. Additional contact persons can be managed via the contact persons endpoint.",
                        "unevaluatedProperties": false,
                        "properties": {
                          "firstname": {
                            "type": "string",
                            "description": "First name of the contact person."
                          },
                          "lastname": {
                            "type": "string",
                            "description": "Last name of the contact person."
                          }
                        },
                        "required": [
                          "firstname",
                          "lastname"
                        ]
                      }
                    },
                    "required": []
                  }
                },
                "required": [
                  "contact"
                ]
              },
              "examples": {
                "AddingValuesForCustomFields": {
                  "summary": "Adding values for custom fields",
                  "value": {
                    "contact": {
                      "company_name": "Test B.V.",
                      "custom_fields_attributes": {
                        "0": {
                          "id": 502689192874083500,
                          "value": "Field value"
                        }
                      }
                    }
                  }
                },
                "CreateANewContactWithGivenPeppolIdentifier": {
                  "summary": "Create a new contact with given peppol identifier",
                  "value": {
                    "contact": {
                      "company_name": "Test B.V.",
                      "si_identifier": "1234567",
                      "si_identifier_type": "NL:KVK"
                    }
                  }
                },
                "CreateANewContact": {
                  "summary": "Create a new contact",
                  "value": {
                    "contact": {
                      "company_name": "Test B.V."
                    }
                  }
                }
              }
            }
          }
        },
        "responses": {
          "201": {
            "description": "Contact created",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/contact_response"
                },
                "examples": {
                  "AddingValuesForCustomFields": {
                    "summary": "Adding values for custom fields",
                    "value": {
                      "id": "502689192882472112",
                      "administration_id": 123,
                      "company_name": "Test B.V.",
                      "firstname": "",
                      "lastname": "",
                      "address1": "",
                      "address2": "",
                      "zipcode": "",
                      "city": "",
                      "country": "NL",
                      "phone": "",
                      "delivery_method": "Email",
                      "customer_id": "3",
                      "tax_number": "",
                      "chamber_of_commerce": "",
                      "bank_account": "",
                      "is_trusted": false,
                      "max_transfer_amount": null,
                      "attention": "",
                      "email": "",
                      "email_ubl": true,
                      "send_invoices_to_attention": "",
                      "send_invoices_to_email": "",
                      "send_estimates_to_attention": "",
                      "send_estimates_to_email": "",
                      "direct_debit": false,
                      "sepa_active": false,
                      "sepa_iban": "",
                      "sepa_iban_account_name": "",
                      "sepa_bic": "",
                      "sepa_mandate_id": "",
                      "sepa_mandate_date": null,
                      "sepa_sequence_type": "RCUR",
                      "credit_card_number": "",
                      "credit_card_reference": "",
                      "credit_card_type": null,
                      "tax_number_validated_at": null,
                      "tax_number_valid": null,
                      "invoice_workflow_id": null,
                      "estimate_workflow_id": null,
                      "si_identifier": "",
                      "si_identifier_type": null,
                      "moneybird_payments_mandate": false,
                      "created_at": "2026-11-02T12:16:34.108Z",
                      "updated_at": "2026-11-02T12:16:34.108Z",
                      "version": 1793621794,
                      "sales_invoices_url": "https://moneybird.dev/123/sales_invoices/194f4d9c3ce7e768ce8db8e5853164685186a85264580dd427c03e8dea5a96d2/all",
                      "notes": [],
                      "custom_fields": [
                        {
                          "id": "502689192874083502",
                          "name": "Number",
                          "value": "Field value"
                        }
                      ],
                      "contact_people": [],
                      "archived": false,
                      "events": [
                        {
                          "administration_id": 123,
                          "user_id": "502689108256097381",
                          "action": "contact_created",
                          "link_entity_id": null,
                          "link_entity_type": null,
                          "data": {},
                          "created_at": "2026-11-02T12:16:34.110Z",
                          "updated_at": "2026-11-02T12:16:34.110Z"
                        }
                      ]
                    }
                  },
                  "CreateANewContactWithGivenPeppolIdentifier": {
                    "summary": "Create a new contact with given peppol identifier",
                    "value": {
                      "id": "502689192955872449",
                      "administration_id": 123,
                      "company_name": "Test B.V.",
                      "firstname": "",
                      "lastname": "",
                      "address1": "",
                      "address2": "",
                      "zipcode": "",
                      "city": "",
                      "country": "NL",
                      "phone": "",
                      "delivery_method": "Email",
                      "customer_id": "3",
                      "tax_number": "",
                      "chamber_of_commerce": "",
                      "bank_account": "",
                      "is_trusted": false,
                      "max_transfer_amount": null,
                      "attention": "",
                      "email": "",
                      "email_ubl": true,
                      "send_invoices_to_attention": "",
                      "send_invoices_to_email": "",
                      "send_estimates_to_attention": "",
                      "send_estimates_to_email": "",
                      "direct_debit": false,
                      "sepa_active": false,
                      "sepa_iban": "",
                      "sepa_iban_account_name": "",
                      "sepa_bic": "",
                      "sepa_mandate_id": "",
                      "sepa_mandate_date": null,
                      "sepa_sequence_type": "RCUR",
                      "credit_card_number": "",
                      "credit_card_reference": "",
                      "credit_card_type": null,
                      "tax_number_validated_at": null,
                      "tax_number_valid": null,
                      "invoice_workflow_id": null,
                      "estimate_workflow_id": null,
                      "si_identifier": "1234567",
                      "si_identifier_type": "NL:KVK",
                      "moneybird_payments_mandate": false,
                      "created_at": "2026-11-02T12:16:34.178Z",
                      "updated_at": "2026-11-02T12:16:34.178Z",
                      "version": 1793621794,
                      "sales_invoices_url": "https://moneybird.dev/123/sales_invoices/722e51081f6d6a315285124c0f601b7cc552ce688cd8a5effa48ed28b8490110/all",
                      "notes": [],
                      "custom_fields": [],
                      "contact_people": [],
                      "archived": false,
                      "events": [
                        {
                          "administration_id": 123,
                          "user_id": "502689108256097381",
                          "action": "contact_created",
                          "link_entity_id": null,
                          "link_entity_type": null,
                          "data": {},
                          "created_at": "2026-11-02T12:16:34.180Z",
                          "updated_at": "2026-11-02T12:16:34.180Z"
                        }
                      ]
                    }
                  },
                  "CreateANewContact": {
                    "summary": "Create a new contact",
                    "value": {
                      "id": "502689193083798752",
                      "administration_id": 123,
                      "company_name": "Test B.V.",
                      "firstname": "",
                      "lastname": "",
                      "address1": "",
                      "address2": "",
                      "zipcode": "",
                      "city": "",
                      "country": "NL",
                      "phone": "",
                      "delivery_method": "Email",
                      "customer_id": "3",
                      "tax_number": "",
                      "chamber_of_commerce": "",
                      "bank_account": "",
                      "is_trusted": false,
                      "max_transfer_amount": null,
                      "attention": "",
                      "email": "",
                      "email_ubl": true,
                      "send_invoices_to_attention": "",
                      "send_invoices_to_email": "",
                      "send_estimates_to_attention": "",
                      "send_estimates_to_email": "",
                      "direct_debit": false,
                      "sepa_active": false,
                      "sepa_iban": "",
                      "sepa_iban_account_name": "",
                      "sepa_bic": "",
                      "sepa_mandate_id": "",
                      "sepa_mandate_date": null,
                      "sepa_sequence_type": "RCUR",
                      "credit_card_number": "",
                      "credit_card_reference": "",
                      "credit_card_type": null,
                      "tax_number_validated_at": null,
                      "tax_number_valid": null,
                      "invoice_workflow_id": null,
                      "estimate_workflow_id": null,
                      "si_identifier": "",
                      "si_identifier_type": null,
                      "moneybird_payments_mandate": false,
                      "created_at": "2026-11-02T12:16:34.299Z",
                      "updated_at": "2026-11-02T12:16:34.299Z",
                      "version": 1793621794,
                      "sales_invoices_url": "https://moneybird.dev/123/sales_invoices/a8bf774c7dbe479e9e84f198f482c0ae683e6f0e5bd10cab099f3f6531862323/all",
                      "notes": [],
                      "custom_fields": [],
                      "contact_people": [],
                      "archived": false,
                      "events": [
                        {
                          "administration_id": 123,
                          "user_id": "502689108256097381",
                          "action": "contact_created",
                          "link_entity_id": null,
                          "link_entity_type": null,
                          "data": {},
                          "created_at": "2026-11-02T12:16:34.302Z",
                          "updated_at": "2026-11-02T12:16:34.302Z"
                        }
                      ]
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "Bad request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/symbolic_error"
                },
                "examples": {
                  "ReturnsAnErrorWhenFieldsAreNotProvided": {
                    "summary": "Returns an error when fields are not provided",
                    "value": {
                      "error": "Contact is required",
                      "symbolic": {
                        "contact": "required"
                      }
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Not found",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/symbolic_error"
                },
                "examples": {
                  "ReturnsAnErrorWhenCustomFieldCannotBeFound": {
                    "summary": "Returns an error when custom field cannot be found",
                    "value": {
                      "error": "Custom field with id 1234 not found for administration",
                      "symbolic": {
                        "custom_fields_attributes": "not_found"
                      }
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "Unprocessable entity",
            "content": {
              "application/json": {
                "schema": {
                  "anyOf": [
                    {
                      "$ref": "#/components/schemas/symbolic_error"
                    },
                    {
                      "$ref": "#/components/schemas/non_symbolic_error"
                    }
                  ]
                },
                "examples": {
                  "ReturnsAnErrorWhenRecordIsInvalid": {
                    "summary": "Returns an error when record is invalid",
                    "value": {
                      "error": {
                        "firstname": [
                          "is required"
                        ],
                        "lastname": [
                          "is required"
                        ],
                        "company_name": [
                          "is required"
                        ]
                      },
                      "details": {
                        "firstname": [
                          {
                            "error": "is required"
                          }
                        ],
                        "lastname": [
                          {
                            "error": "is required"
                          }
                        ],
                        "company_name": [
                          {
                            "error": "is required"
                          }
                        ]
                      }
                    }
                  },
                  "DoesNotCreateContactWhenMandateDateIsFutureInAdministrationTimezone": {
                    "summary": "Does not create contact when mandate date is future in administration timezone",
                    "value": {
                      "error": {
                        "sepa_mandate_date": [
                          "cannot be in the future"
                        ]
                      },
                      "details": {
                        "sepa_mandate_date": [
                          {
                            "error": "not_in_future"
                          }
                        ]
                      }
                    }
                  }
                }
              }
            }
          }
        },
        "operationId": "post_administration_id_contacts"
      }
    },
    "/{administration_id}/custom_fields{format}": {
      "get": {
        "summary": "List all custom fields",
        "description": "Custom fields are used to add extra information to entities in the administration. The `source`\nfield can be `sales_invoices`, `contact` or `identity` and defines for which entities the custom\nfield can be used. The id of a custom field is required to add a value for a custom field to an\nentity.\n\n### Required scope(s)\n Any of: `settings`, `sales_invoices`, `documents`, `estimates` or `bank`",
        "tags": [
          "Custom fields"
        ],
        "security": [
          {
            "bearerAuth": [
              "settings"
            ]
          },
          {
            "bearerAuth": [
              "sales_invoices"
            ]
          },
          {
            "bearerAuth": [
              "documents"
            ]
          },
          {
            "bearerAuth": [
              "estimates"
            ]
          },
          {
            "bearerAuth": [
              "bank"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/administration_id"
          },
          {
            "$ref": "#/components/parameters/format"
          }
        ],
        "responses": {
          "200": {
            "description": "A list of custom fields",
            "content": {
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "$ref": "#/components/schemas/custom_field_response"
                  }
                },
                "examples": {
                  "ReturnsAllCustomFieldsOfAnAdministration": {
                    "summary": "Returns all custom fields of an administration",
                    "value": [
                      {
                        "id": "502689288616412791",
                        "administration_id": 123,
                        "name": "custom_field_95b66e168001577be465",
                        "source": "sales_invoice"
                      }
                    ]
                  }
                }
              }
            }
          }
        },
        "operationId": "get_administration_id_custom_fields"
      }
    },
    "/{administration_id}/customer_contact_portal/{contact_id}/invoices{format}": {
      "get": {
        "summary": "Get a temporary link to the invoices in the customer contact portal",
        "description": "Generate a temporary link to the invoices in the customer contact portal. The link will expire after 1 hour.\n\n### Required scope(s)\n Any of: `sales_invoices` or `estimates`",
        "tags": [
          "Customer contact portal"
        ],
        "security": [
          {
            "bearerAuth": [
              "sales_invoices"
            ]
          },
          {
            "bearerAuth": [
              "estimates"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/administration_id"
          },
          {
            "name": "contact_id",
            "in": "path",
            "required": true,
            "schema": {
              "$ref": "#/components/schemas/identifier"
            }
          },
          {
            "$ref": "#/components/parameters/format"
          }
        ],
        "responses": {
          "200": {
            "description": "Temporary link generated successfully",
            "content": {
              "application/json": {
                "schema": {
                  "type": "string",
                  "example": "https://moneybird.com/temporary-link"
                },
                "examples": {
                  "ReturnsATemporaryLinkThatRedirectsToTheInvoicesPage": {
                    "summary": "Returns a temporary link that redirects to the invoices page",
                    "value": "http://moneybird.com"
                  }
                }
              }
            }
          },
          "401": {
            "description": "Unauthorized",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/symbolic_error"
                },
                "examples": {
                  "Returns401ForTheInvoicesLink": {
                    "summary": "Returns 401 for the invoices link",
                    "value": {
                      "error": "No access to sales_invoices or estimates"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Contact not found",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/symbolic_error"
                },
                "examples": {
                  "Returns404WhenTheContactDoesNotExist": {
                    "summary": "Returns 404 when the contact does not exist",
                    "value": {
                      "error": "Record not found for model name: Contact"
                    }
                  }
                }
              }
            }
          }
        },
        "operationId": "get_administration_id_customer_contact_portal_contact_id_invoices"
      }
    },
    "/{administration_id}/customer_contact_portal/{contact_id}/subscriptions/{id}{format}": {
      "get": {
        "summary": "Get a temporary link to the subscriptions in the customer contact portal",
        "description": "Generate a temporary link to the subscriptions in the customer contact portal. The link will expire after 1 hour.\nCreating the online sales link can be done using the [Create online sales link endpoint](https://developer.moneybird.com/api/subscription-templates#create-online-sales-link).\n\n### Required scope(s)\n Any of: `sales_invoices` or `estimates`",
        "tags": [
          "Customer contact portal"
        ],
        "security": [
          {
            "bearerAuth": [
              "sales_invoices"
            ]
          },
          {
            "bearerAuth": [
              "estimates"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/administration_id"
          },
          {
            "name": "contact_id",
            "in": "path",
            "required": true,
            "schema": {
              "$ref": "#/components/schemas/identifier"
            }
          },
          {
            "name": "id",
            "in": "path",
            "required": true,
            "schema": {
              "$ref": "#/components/schemas/identifier"
            }
          },
          {
            "$ref": "#/components/parameters/format"
          }
        ],
        "responses": {
          "200": {
            "description": "Temporary link generated successfully",
            "content": {
              "application/json": {
                "schema": {
                  "type": "string",
                  "example": "https://moneybird.com/temporary-link"
                },
                "examples": {
                  "ReturnsATemporaryLink": {
                    "summary": "Returns a temporary link",
                    "value": "http://moneybird.com"
                  }
                }
              }
            }
          },
          "401": {
            "description": "Unauthorized",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/symbolic_error"
                },
                "examples": {
                  "Returns401ForTheSubscriptionLink": {
                    "summary": "Returns 401 for the subscription link",
                    "value": {
                      "error": "No access to sales_invoices or estimates"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Contact or subscription not found",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/symbolic_error"
                },
                "examples": {
                  "Returns404WhenTheSubscriptionDoesNotBelongToTheContact": {
                    "summary": "Returns 404 when the subscription does not belong to the contact",
                    "value": {
                      "error": "Record not found for model name: Subscription"
                    }
                  },
                  "Returns404WhenTheSubscriptionHasNoSubscriptionTemplate": {
                    "summary": "Returns 404 when the subscription has no subscription template",
                    "value": {
                      "error": "Record not found for model name: Subscription"
                    }
                  }
                }
              }
            }
          }
        },
        "operationId": "get_administration_id_customer_contact_portal_contact_id_subscriptions_id"
      }
    },
    "/{administration_id}/customer_contact_portal/{contact_id}{format}": {
      "get": {
        "summary": "Get a temporary link to the customer contact portal",
        "description": "Generate a temporary link to the customer contact portal. The link will expire after 1 hour.\n\n### Required scope(s)\n Any of: `sales_invoices` or `estimates`",
        "tags": [
          "Customer contact portal"
        ],
        "security": [
          {
            "bearerAuth": [
              "sales_invoices"
            ]
          },
          {
            "bearerAuth": [
              "estimates"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/administration_id"
          },
          {
            "name": "contact_id",
            "in": "path",
            "required": true,
            "schema": {
              "$ref": "#/components/schemas/identifier"
            }
          },
          {
            "$ref": "#/components/parameters/format"
          }
        ],
        "responses": {
          "200": {
            "description": "Temporary link generated successfully",
            "content": {
              "application/json": {
                "schema": {
                  "type": "string",
                  "example": "https://moneybird.com/temporary-link"
                },
                "examples": {
                  "ReturnsATemporaryLink": {
                    "summary": "Returns a temporary link",
                    "value": "http://moneybird.com"
                  }
                }
              }
            }
          },
          "401": {
            "description": "Unauthorized",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/symbolic_error"
                },
                "examples": {
                  "Returns401ForTheContactPortalLink": {
                    "summary": "Returns 401 for the contact portal link",
                    "value": {
                      "error": "No access to sales_invoices or estimates"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Not found",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/symbolic_error"
                },
                "examples": {
                  "Returns404WhenTheContactDoesNotExist": {
                    "summary": "Returns 404 when the contact does not exist",
                    "value": {
                      "error": "Record not found for model name: Contact"
                    }
                  },
                  "Returns404WhenTheContactDoesNotBelongToTheAdministration": {
                    "summary": "Returns 404 when the contact does not belong to the administration",
                    "value": {
                      "error": "Record not found for model name: Contact"
                    }
                  }
                }
              }
            }
          }
        },
        "operationId": "get_administration_id_customer_contact_portal_contact_id"
      }
    },
    "/{administration_id}/document_styles{format}": {
      "get": {
        "summary": "List all document styles",
        "description": "Returns a list of all document styles.\n\n### Required scope(s)\n Any of: `settings`, `sales_invoices` or `estimates`",
        "tags": [
          "Document styles"
        ],
        "security": [
          {
            "bearerAuth": [
              "settings"
            ]
          },
          {
            "bearerAuth": [
              "sales_invoices"
            ]
          },
          {
            "bearerAuth": [
              "estimates"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/administration_id"
          },
          {
            "$ref": "#/components/parameters/format"
          }
        ],
        "responses": {
          "200": {
            "description": "A list of document styles",
            "content": {
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "$ref": "#/components/schemas/document_style_response"
                  }
                },
                "examples": {
                  "ReturnsAllDocumentstylesOfAnAdministration": {
                    "summary": "Returns all documentstyles of an administration",
                    "value": [
                      {
                        "id": "502689109280556185",
                        "administration_id": 123,
                        "name": "Standaard",
                        "identity_id": "502689108656653419",
                        "default": true,
                        "logo_hash": null,
                        "logo_container_full_width": false,
                        "logo_display_width": 50,
                        "logo_position": "right",
                        "background_hash": null,
                        "paper_size": "A4",
                        "address_position": "left",
                        "font_size": 9,
                        "font_family": "lucida_grande",
                        "print_on_stationery": false,
                        "custom_css": null,
                        "invoice_sender_address": [
                          {
                            "field": "company_name",
                            "bold": true
                          },
                          {
                            "field": "address"
                          },
                          {
                            "field": "newline"
                          },
                          {
                            "field": "email"
                          },
                          {
                            "field": "phone"
                          },
                          {
                            "field": "newline"
                          },
                          {
                            "field": "chamber_of_commerce",
                            "label": true
                          },
                          {
                            "field": "tax_number",
                            "label": true
                          },
                          {
                            "field": "bank_account_number",
                            "label": true
                          }
                        ],
                        "invoice_metadata_left": [
                          {
                            "field": "reference"
                          }
                        ],
                        "invoice_metadata_right": [
                          {
                            "field": "invoice_date"
                          },
                          {
                            "field": "due_date"
                          }
                        ],
                        "estimate_sender_address": [
                          {
                            "field": "company_name",
                            "bold": true
                          },
                          {
                            "field": "address"
                          },
                          {
                            "field": "newline"
                          },
                          {
                            "field": "email"
                          },
                          {
                            "field": "phone"
                          },
                          {
                            "field": "newline"
                          },
                          {
                            "field": "chamber_of_commerce",
                            "label": true
                          },
                          {
                            "field": "tax_number",
                            "label": true
                          },
                          {
                            "field": "bank_account_number",
                            "label": true
                          }
                        ],
                        "estimate_metadata_left": [
                          {
                            "field": "reference"
                          }
                        ],
                        "estimate_metadata_right": [
                          {
                            "field": "estimate_date"
                          },
                          {
                            "field": "due_date"
                          }
                        ],
                        "created_at": "2026-11-02T12:15:14.376Z",
                        "updated_at": "2026-11-02T12:15:14.376Z"
                      }
                    ]
                  }
                }
              }
            }
          }
        },
        "operationId": "get_administration_id_document_styles"
      }
    },
    "/{administration_id}/documents/general_documents/synchronization{format}": {
      "get": {
        "summary": "List ids and versions of general documents",
        "description": "Returns all documents in the administration. The list contains the document id and the version of the document.\nCheck if the version of the document is newer than the version you have stored locally, use the `POST`\nvariant for fetching documents with the given ids.\n\n### Required scope(s)\n `documents`",
        "tags": [
          "Documents: General documents"
        ],
        "security": [
          {
            "bearerAuth": [
              "documents"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/administration_id"
          },
          {
            "$ref": "#/components/parameters/format"
          },
          {
            "name": "filter",
            "in": "query",
            "required": false,
            "description": "Comma-separated `key:value` filter terms. Same syntax as `GET /documents/general_documents` — see that operation's description for the available keys.",
            "schema": {
              "type": "string"
            },
            "examples": {
              "RetrievesAllIdsForSynchronizationUsingAFilter": {
                "summary": "Retrieves all ids for synchronization using a filter",
                "value": "period:this_month"
              }
            }
          }
        ],
        "responses": {
          "200": {
            "description": "IDs and versions of records",
            "content": {
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "type": "object",
                    "unevaluatedProperties": false,
                    "properties": {
                      "id": {
                        "type": [
                          "integer",
                          "string"
                        ]
                      },
                      "version": {
                        "type": [
                          "integer",
                          "string"
                        ]
                      }
                    }
                  }
                },
                "examples": {
                  "RetrievesAllIdsForSynchronization": {
                    "summary": "Retrieves all ids for synchronization",
                    "value": [
                      {
                        "id": "502689138792728362",
                        "version": 1793621742
                      },
                      {
                        "id": "502689138835719980",
                        "version": 1793621742
                      },
                      {
                        "id": "502689138865080110",
                        "version": 1793621742
                      }
                    ]
                  },
                  "RetrievesAllIdsForSynchronizationUsingAFilter": {
                    "summary": "Retrieves all ids for synchronization using a filter",
                    "value": [
                      {
                        "id": "502689139063260991",
                        "version": 1793621742
                      },
                      {
                        "id": "502689139085281089",
                        "version": 1793621742
                      },
                      {
                        "id": "502689139106252611",
                        "version": 1793621742
                      }
                    ]
                  }
                }
              }
            }
          }
        },
        "operationId": "get_administration_id_documents_general_documents_synchronization"
      },
      "post": {
        "summary": "Fetch general documents with given ids",
        "x-query": true,
        "description": "Given a list of document ids, returns the document information belonging to the documents.\nReturns a maximum of 100 documents, even if more ids are provided.\n\n### Required scope(s)\n `documents`",
        "tags": [
          "Documents: General documents"
        ],
        "security": [
          {
            "bearerAuth": [
              "documents"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/administration_id"
          },
          {
            "$ref": "#/components/parameters/format"
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/*": {
              "schema": {
                "unevaluatedProperties": false,
                "type": "object",
                "properties": {
                  "ids": {
                    "type": "array",
                    "items": {
                      "type": [
                        "integer",
                        "string"
                      ]
                    }
                  }
                },
                "required": [
                  "ids"
                ]
              },
              "examples": {
                "RetrievesDocumentsForGivenIds": {
                  "summary": "Retrieves documents for given ids",
                  "value": {
                    "ids": [
                      502689139313870660,
                      502689139336939300
                    ]
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "A list of general documents",
            "content": {
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "$ref": "#/components/schemas/general_document_response"
                  }
                },
                "examples": {
                  "RetrievesDocumentsForGivenIds": {
                    "summary": "Retrieves documents for given ids",
                    "value": [
                      {
                        "id": "502689139313870678",
                        "administration_id": 123,
                        "contact_id": null,
                        "contact": null,
                        "reference": "Contract",
                        "date": "2026-11-02",
                        "due_date": null,
                        "entry_number": 3,
                        "state": "saved",
                        "exchange_rate": "1.0",
                        "created_at": "2026-11-02T12:15:43.021Z",
                        "updated_at": "2026-11-02T12:15:43.021Z",
                        "version": 1793621743,
                        "notes": [],
                        "attachments": [],
                        "events": [
                          {
                            "administration_id": 123,
                            "user_id": "502689108256097381",
                            "action": "document_saved",
                            "link_entity_id": null,
                            "link_entity_type": null,
                            "data": {},
                            "created_at": "2026-11-02T12:15:43.025Z",
                            "updated_at": "2026-11-02T12:15:43.025Z"
                          }
                        ]
                      },
                      {
                        "id": "502689139336939352",
                        "administration_id": 123,
                        "contact_id": null,
                        "contact": null,
                        "reference": "Contract",
                        "date": "2026-11-02",
                        "due_date": null,
                        "entry_number": 4,
                        "state": "saved",
                        "exchange_rate": "1.0",
                        "created_at": "2026-11-02T12:15:43.041Z",
                        "updated_at": "2026-11-02T12:15:43.041Z",
                        "version": 1793621743,
                        "notes": [],
                        "attachments": [],
                        "events": [
                          {
                            "administration_id": 123,
                            "user_id": "502689108256097381",
                            "action": "document_saved",
                            "link_entity_id": null,
                            "link_entity_type": null,
                            "data": {},
                            "created_at": "2026-11-02T12:15:43.047Z",
                            "updated_at": "2026-11-02T12:15:43.047Z"
                          }
                        ]
                      }
                    ]
                  }
                }
              }
            }
          }
        },
        "operationId": "post_administration_id_documents_general_documents_synchronization"
      }
    },
    "/{administration_id}/documents/general_documents/{general_document_id}/notes/{id}{format}": {
      "delete": {
        "summary": "Destroys note from entity",
        "description": "Deletes a note from the general document.\n\n### Required scope(s)\n `documents`",
        "tags": [
          "Documents: General documents"
        ],
        "security": [
          {
            "bearerAuth": [
              "documents"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/administration_id"
          },
          {
            "name": "general_document_id",
            "in": "path",
            "required": true,
            "schema": {
              "$ref": "#/components/schemas/identifier"
            }
          },
          {
            "name": "id",
            "in": "path",
            "required": true,
            "schema": {
              "$ref": "#/components/schemas/identifier"
            }
          },
          {
            "$ref": "#/components/parameters/format"
          }
        ],
        "responses": {
          "204": {
            "description": "Note deleted"
          },
          "400": {
            "$ref": "#/components/responses/400_bad_request"
          }
        },
        "operationId": "delete_administration_id_documents_general_documents_general_document_id_notes_id"
      }
    },
    "/{administration_id}/documents/general_documents/{general_document_id}/notes{format}": {
      "post": {
        "summary": "Adds note to entity",
        "description": "Adds a note to the general document.\n\n### Required scope(s)\n `documents`",
        "tags": [
          "Documents: General documents"
        ],
        "security": [
          {
            "bearerAuth": [
              "documents"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/administration_id"
          },
          {
            "name": "general_document_id",
            "in": "path",
            "required": true,
            "schema": {
              "$ref": "#/components/schemas/identifier"
            }
          },
          {
            "$ref": "#/components/parameters/format"
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/*": {
              "schema": {
                "unevaluatedProperties": false,
                "type": "object",
                "properties": {
                  "note": {
                    "type": "object",
                    "unevaluatedProperties": false,
                    "properties": {
                      "note": {
                        "type": "string",
                        "description": "**Required**. Text for the note or to-do."
                      },
                      "todo": {
                        "type": [
                          "boolean",
                          "string"
                        ],
                        "description": "If `true` the note is a to-do."
                      },
                      "assignee_id": {
                        "$ref": "#/components/schemas/identifier",
                        "description": "Assign to-do to user. Should be a valid user id. If assignee_id is provided the note will be a to-do."
                      }
                    },
                    "required": []
                  }
                },
                "required": []
              },
              "examples": {
                "CreateANote": {
                  "summary": "Create a note",
                  "value": {
                    "note": {
                      "note": "Text of the note",
                      "assignee_id": 502689137314235970,
                      "todo": true
                    }
                  }
                }
              }
            }
          }
        },
        "responses": {
          "201": {
            "description": "Note created",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/note_response"
                },
                "examples": {
                  "CreateANote": {
                    "summary": "Create a note",
                    "value": {
                      "id": "502689137329964583",
                      "administration_id": 123,
                      "entity_id": "502689137303750179",
                      "entity_type": "Document",
                      "user_id": "502689108256097381",
                      "assignee_id": "502689137314235941",
                      "todo": true,
                      "note": "Text of the note",
                      "completed_at": null,
                      "completed_by_id": null,
                      "todo_type": null,
                      "data": {},
                      "created_at": "2026-11-02T12:15:41.129Z",
                      "updated_at": "2026-11-02T12:15:41.129Z"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "$ref": "#/components/responses/400_bad_request"
          },
          "422": {
            "$ref": "#/components/responses/422_unprocessable_entity"
          }
        },
        "operationId": "post_administration_id_documents_general_documents_general_document_id_notes"
      }
    },
    "/{administration_id}/documents/general_documents/{id}/attachments/{attachment_id}/download{format}": {
      "get": {
        "summary": "Download attachment",
        "description": "Download the attachment. The response will be a redirect to a temporarily available URL\nwhere the attachment can be downloaded. Use the `Location` header in the response\nto download the attachment.\n\n### Required scope(s)\n `documents`",
        "tags": [
          "Documents: General documents"
        ],
        "security": [
          {
            "bearerAuth": [
              "documents"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/administration_id"
          },
          {
            "name": "id",
            "in": "path",
            "required": true,
            "schema": {
              "$ref": "#/components/schemas/identifier"
            }
          },
          {
            "name": "attachment_id",
            "in": "path",
            "required": true,
            "schema": {
              "$ref": "#/components/schemas/identifier"
            }
          },
          {
            "$ref": "#/components/parameters/format"
          }
        ],
        "responses": {
          "302": {
            "description": "Found",
            "content": {
              "text/plain": {
                "schema": {
                  "type": "string"
                },
                "examples": {
                  "DownloadsTheAttachment": {
                    "summary": "Downloads the attachment",
                    "value": "{\"message\":\"Use the Location header to download the attachment\"}"
                  }
                }
              }
            }
          },
          "404": {
            "$ref": "#/components/responses/404_not_found"
          }
        },
        "operationId": "get_administration_id_documents_general_documents_id_attachments_attachment_id_download"
      }
    },
    "/{administration_id}/documents/general_documents/{id}/attachments/{attachment_id}{format}": {
      "delete": {
        "summary": "Delete an attachment",
        "description": "Deletes an attachment of an attachable.\n\n### Required scope(s)\n `documents`",
        "tags": [
          "Documents: General documents"
        ],
        "security": [
          {
            "bearerAuth": [
              "documents"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/administration_id"
          },
          {
            "name": "id",
            "in": "path",
            "required": true,
            "schema": {
              "$ref": "#/components/schemas/identifier"
            }
          },
          {
            "name": "attachment_id",
            "in": "path",
            "required": true,
            "schema": {
              "$ref": "#/components/schemas/identifier"
            }
          },
          {
            "$ref": "#/components/parameters/format"
          }
        ],
        "responses": {
          "204": {
            "description": "Attachment deleted"
          },
          "404": {
            "$ref": "#/components/responses/404_not_found"
          }
        },
        "operationId": "delete_administration_id_documents_general_documents_id_attachments_attachment_id"
      }
    },
    "/{administration_id}/documents/general_documents/{id}/attachments{format}": {
      "post": {
        "summary": "Add attachment to general document",
        "description": "Add an attachment to a general document.\n\n### Required scope(s)\n `documents`",
        "tags": [
          "Documents: General documents"
        ],
        "security": [
          {
            "bearerAuth": [
              "documents"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/administration_id"
          },
          {
            "name": "id",
            "in": "path",
            "required": true,
            "schema": {
              "$ref": "#/components/schemas/identifier"
            }
          },
          {
            "$ref": "#/components/parameters/format"
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "multipart/form-data": {
              "schema": {
                "type": "object",
                "properties": {
                  "file": {
                    "type": "string",
                    "format": "binary"
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Status code",
            "content": {
              "application/json": {
                "schema": {
                  "type": "integer"
                },
                "examples": {
                  "UploadsAnAttachment": {
                    "summary": "Uploads an attachment",
                    "value": 200
                  }
                }
              }
            }
          },
          "400": {
            "$ref": "#/components/responses/400_bad_request"
          },
          "404": {
            "$ref": "#/components/responses/404_not_found"
          },
          "422": {
            "$ref": "#/components/responses/422_unprocessable_entity"
          }
        },
        "operationId": "post_administration_id_documents_general_documents_id_attachments"
      }
    },
    "/{administration_id}/documents/general_documents/{id}{format}": {
      "get": {
        "summary": "Get general document",
        "description": "Returns a general document by id.\n\n### Required scope(s)\n `documents`",
        "tags": [
          "Documents: General documents"
        ],
        "security": [
          {
            "bearerAuth": [
              "documents"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/administration_id"
          },
          {
            "name": "id",
            "in": "path",
            "required": true,
            "schema": {
              "$ref": "#/components/schemas/identifier"
            }
          },
          {
            "$ref": "#/components/parameters/format"
          }
        ],
        "responses": {
          "200": {
            "description": "A general document",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/general_document_response"
                },
                "examples": {
                  "ReturnsTheWantedGeneralDocument": {
                    "summary": "Returns the wanted general document",
                    "value": {
                      "id": "502689137618323034",
                      "administration_id": 123,
                      "contact_id": null,
                      "contact": null,
                      "reference": "Contract",
                      "date": "2026-11-02",
                      "due_date": null,
                      "entry_number": 2,
                      "state": "saved",
                      "exchange_rate": "1.0",
                      "created_at": "2026-11-02T12:15:41.403Z",
                      "updated_at": "2026-11-02T12:15:41.403Z",
                      "version": 1793621741,
                      "notes": [],
                      "attachments": [],
                      "events": [
                        {
                          "administration_id": 123,
                          "user_id": "502689108256097381",
                          "action": "document_saved",
                          "link_entity_id": null,
                          "link_entity_type": null,
                          "data": {},
                          "created_at": "2026-11-02T12:15:41.406Z",
                          "updated_at": "2026-11-02T12:15:41.406Z"
                        }
                      ]
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Not found",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/symbolic_error"
                },
                "examples": {
                  "OnlyReturnsGeneralDocuments": {
                    "summary": "Only returns general documents",
                    "value": {
                      "error": "Record not found for model name: General document"
                    }
                  }
                }
              }
            }
          }
        },
        "operationId": "get_administration_id_documents_general_documents_id"
      },
      "delete": {
        "summary": "Delete a general document",
        "description": "Deletes a general document.\n\n### Required scope(s)\n `documents`",
        "tags": [
          "Documents: General documents"
        ],
        "security": [
          {
            "bearerAuth": [
              "documents"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/administration_id"
          },
          {
            "name": "id",
            "in": "path",
            "required": true,
            "schema": {
              "$ref": "#/components/schemas/identifier"
            }
          },
          {
            "$ref": "#/components/parameters/format"
          }
        ],
        "responses": {
          "200": {
            "description": "Status code",
            "content": {
              "application/json": {
                "schema": {
                  "type": "integer"
                },
                "examples": {
                  "DeletesTheGeneralDocument": {
                    "summary": "Deletes the general document",
                    "value": 200
                  }
                }
              }
            }
          },
          "404": {
            "$ref": "#/components/responses/404_not_found"
          },
          "422": {
            "$ref": "#/components/responses/422_unprocessable_entity"
          }
        },
        "operationId": "delete_administration_id_documents_general_documents_id"
      },
      "patch": {
        "summary": "Update a general document",
        "description": "Updates a general document.\n\n### Required scope(s)\n `documents`",
        "tags": [
          "Documents: General documents"
        ],
        "security": [
          {
            "bearerAuth": [
              "documents"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/administration_id"
          },
          {
            "name": "id",
            "in": "path",
            "required": true,
            "schema": {
              "$ref": "#/components/schemas/identifier"
            }
          },
          {
            "$ref": "#/components/parameters/format"
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/*": {
              "schema": {
                "unevaluatedProperties": false,
                "type": "object",
                "properties": {
                  "general_document": {
                    "type": "object",
                    "unevaluatedProperties": false,
                    "properties": {
                      "reference": {
                        "type": "string",
                        "description": "**Required**."
                      },
                      "date": {
                        "type": "string",
                        "format": "date",
                        "description": "**Required**."
                      },
                      "due_date": {
                        "type": "string",
                        "format": "date"
                      },
                      "reminder_date": {
                        "type": "string",
                        "format": "date"
                      },
                      "contact_id": {
                        "$ref": "#/components/schemas/identifier",
                        "description": "Should be a valid contact id."
                      },
                      "reminder": {
                        "type": "object",
                        "unevaluatedProperties": false,
                        "description": "Creates a reminder to-do for this document.",
                        "properties": {
                          "date": {
                            "type": "string",
                            "format": "date"
                          },
                          "message": {
                            "type": "string"
                          }
                        },
                        "required": [
                          "date"
                        ]
                      }
                    },
                    "required": []
                  },
                  "remove_contact": {
                    "type": [
                      "boolean",
                      "string"
                    ]
                  }
                },
                "required": []
              },
              "examples": {
                "UpdatesTheGeneralDocument": {
                  "summary": "Updates the general document",
                  "value": {
                    "general_document": {
                      "reference": "updated reference"
                    }
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "General document updated",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/general_document_response"
                },
                "examples": {
                  "UpdatesTheGeneralDocument": {
                    "summary": "Updates the general document",
                    "value": {
                      "id": "502689137903535757",
                      "administration_id": 123,
                      "contact_id": null,
                      "contact": null,
                      "reference": "updated reference",
                      "date": "2026-11-02",
                      "due_date": null,
                      "entry_number": 2,
                      "state": "saved",
                      "exchange_rate": "1.0",
                      "created_at": "2026-11-02T12:15:41.676Z",
                      "updated_at": "2026-11-02T12:15:41.697Z",
                      "version": 1793621741,
                      "notes": [],
                      "attachments": [],
                      "events": [
                        {
                          "administration_id": 123,
                          "user_id": "502689108256097381",
                          "action": "document_saved",
                          "link_entity_id": null,
                          "link_entity_type": null,
                          "data": {},
                          "created_at": "2026-11-02T12:15:41.678Z",
                          "updated_at": "2026-11-02T12:15:41.678Z"
                        },
                        {
                          "administration_id": 123,
                          "user_id": "502689108256097381",
                          "action": "document_updated",
                          "link_entity_id": null,
                          "link_entity_type": null,
                          "data": {},
                          "created_at": "2026-11-02T12:15:41.700Z",
                          "updated_at": "2026-11-02T12:15:41.700Z"
                        }
                      ]
                    }
                  }
                }
              }
            }
          },
          "404": {
            "$ref": "#/components/responses/404_not_found"
          },
          "422": {
            "$ref": "#/components/responses/422_unprocessable_entity"
          }
        },
        "operationId": "patch_administration_id_documents_general_documents_id"
      }
    },
    "/{administration_id}/documents/general_documents{format}": {
      "get": {
        "summary": "Get general documents",
        "description": "Returns a paginated list of documents of this type in the administration.\n\n### Required scope(s)\n `documents`",
        "tags": [
          "Documents: General documents"
        ],
        "security": [
          {
            "bearerAuth": [
              "documents"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/administration_id"
          },
          {
            "$ref": "#/components/parameters/format"
          },
          {
            "name": "filter",
            "in": "query",
            "required": false,
            "description": "Filters are `key:value` terms separated by commas (e.g. `period:this_year,state:open`). Any filter you pass replaces the defaults below entirely, so include every key you need. Available filters:\n\n| **Filter** | **Type** | **Default** | **Description** |\n| - | - | - | - |\n| period | `String` | `this_year` | A named period (`this_week`, `prev_week`, `next_week`, `this_month`, `prev_month`, `next_month`, `this_quarter`, `prev_quarter`, `next_quarter`, `this_year`, `prev_year`, `next_year`) or a custom range (`201301..201302`, `20130101..20130131`). A custom period must have a start and an end date. It must not be longer than 10 years and must be between `20000101` and `21000101`. For one month, use `202401..202401`, not `202401`. Without `period`, the filter does not limit the dates. The default `this_year` applies only when you send no `filter`. |\n| state | `String` | `all` | `all`, `new`, `saved`, `open`, `paid`, `late` or `pending_payment`. `paid`, `late` and `pending_payment` only apply to documents with a payment lifecycle (purchase invoices and receipts) |\n| recurring | `String` | `all` | `all`, `enabled` or `disabled` |\n| attachment | `String` | `all` | `all`, `with` or `without` |\n| reference | `String` | | Documents with the given reference value |\n| contact_id | `Integer` | | Documents belonging to the given contact |\n| ledger_account_id | `Integer` | | Documents booking against the given ledger account |\n| updated_after | `String` | | ISO 8601 timestamp in UTC; documents updated strictly after this time |\n\nMultiple values for `state`, `recurring` and `attachment` can be combined with a pipe, e.g. `state:open|paid`.",
            "schema": {
              "type": "string",
              "default": "period:this_year"
            },
            "examples": {
              "ReturnsTheOldestGeneralDocumentFirstWhenSortedByDateAscending": {
                "summary": "Returns the oldest general document first when sorted by date ascending",
                "value": "period:20251102..20261102"
              }
            }
          },
          {
            "name": "new_filter",
            "in": "query",
            "required": false,
            "schema": {
              "type": "string",
              "description": "String terms, example: `key1:value1,key2:value2`."
            }
          },
          {
            "$ref": "#/components/parameters/page"
          },
          {
            "$ref": "#/components/parameters/sort"
          },
          {
            "$ref": "#/components/parameters/per_page"
          }
        ],
        "responses": {
          "200": {
            "description": "A list of general documents",
            "content": {
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "$ref": "#/components/schemas/general_document_response"
                  }
                },
                "examples": {
                  "ReturnsPaginatedGeneralDocumentsOnPage1": {
                    "summary": "Returns paginated general documents on page 1",
                    "value": [
                      {
                        "id": "502689141722448979",
                        "administration_id": 123,
                        "contact_id": null,
                        "contact": null,
                        "reference": "Contract",
                        "date": "2026-11-02",
                        "due_date": null,
                        "entry_number": 5,
                        "state": "saved",
                        "exchange_rate": "1.0",
                        "created_at": "2026-11-02T12:15:45.318Z",
                        "updated_at": "2026-11-02T12:15:45.318Z",
                        "version": 1793621745,
                        "notes": [],
                        "attachments": [],
                        "events": [
                          {
                            "administration_id": 123,
                            "user_id": "502689108256097381",
                            "action": "document_saved",
                            "link_entity_id": null,
                            "link_entity_type": null,
                            "data": {},
                            "created_at": "2026-11-02T12:15:45.319Z",
                            "updated_at": "2026-11-02T12:15:45.319Z"
                          }
                        ]
                      }
                    ]
                  },
                  "ReturnsTheOldestGeneralDocumentFirstWhenSortedByDateAscending": {
                    "summary": "Returns the oldest general document first when sorted by date ascending",
                    "value": [
                      {
                        "id": "502689141843035244",
                        "administration_id": 123,
                        "contact_id": null,
                        "contact": null,
                        "reference": "Contract",
                        "date": "2025-11-02",
                        "due_date": null,
                        "entry_number": null,
                        "state": "new",
                        "exchange_rate": "1.0",
                        "created_at": "2026-11-02T12:15:45.433Z",
                        "updated_at": "2026-11-02T12:15:45.433Z",
                        "version": 1793621745,
                        "notes": [],
                        "attachments": [],
                        "events": []
                      }
                    ]
                  },
                  "ReturnsAListOfGeneralDocuments": {
                    "summary": "Returns a list of general documents",
                    "value": [
                      {
                        "id": "502689141960475778",
                        "administration_id": 123,
                        "contact_id": null,
                        "contact": null,
                        "reference": "Contract",
                        "date": "2026-11-02",
                        "due_date": null,
                        "entry_number": 5,
                        "state": "saved",
                        "exchange_rate": "1.0",
                        "created_at": "2026-11-02T12:15:45.544Z",
                        "updated_at": "2026-11-02T12:15:45.544Z",
                        "version": 1793621745,
                        "notes": [],
                        "attachments": [],
                        "events": [
                          {
                            "administration_id": 123,
                            "user_id": "502689108256097381",
                            "action": "document_saved",
                            "link_entity_id": null,
                            "link_entity_type": null,
                            "data": {},
                            "created_at": "2026-11-02T12:15:45.546Z",
                            "updated_at": "2026-11-02T12:15:45.546Z"
                          }
                        ]
                      },
                      {
                        "id": "502689141953135744",
                        "administration_id": 123,
                        "contact_id": null,
                        "contact": null,
                        "reference": "Contract",
                        "date": "2026-11-02",
                        "due_date": null,
                        "entry_number": 4,
                        "state": "saved",
                        "exchange_rate": "1.0",
                        "created_at": "2026-11-02T12:15:45.538Z",
                        "updated_at": "2026-11-02T12:15:45.538Z",
                        "version": 1793621745,
                        "notes": [],
                        "attachments": [],
                        "events": [
                          {
                            "administration_id": 123,
                            "user_id": "502689108256097381",
                            "action": "document_saved",
                            "link_entity_id": null,
                            "link_entity_type": null,
                            "data": {},
                            "created_at": "2026-11-02T12:15:45.540Z",
                            "updated_at": "2026-11-02T12:15:45.540Z"
                          }
                        ]
                      },
                      {
                        "id": "502689141946844286",
                        "administration_id": 123,
                        "contact_id": null,
                        "contact": null,
                        "reference": "Contract",
                        "date": "2026-11-02",
                        "due_date": null,
                        "entry_number": 3,
                        "state": "saved",
                        "exchange_rate": "1.0",
                        "created_at": "2026-11-02T12:15:45.532Z",
                        "updated_at": "2026-11-02T12:15:45.532Z",
                        "version": 1793621745,
                        "notes": [],
                        "attachments": [],
                        "events": [
                          {
                            "administration_id": 123,
                            "user_id": "502689108256097381",
                            "action": "document_saved",
                            "link_entity_id": null,
                            "link_entity_type": null,
                            "data": {},
                            "created_at": "2026-11-02T12:15:45.534Z",
                            "updated_at": "2026-11-02T12:15:45.534Z"
                          }
                        ]
                      },
                      {
                        "id": "502689141940552828",
                        "administration_id": 123,
                        "contact_id": null,
                        "contact": null,
                        "reference": "Contract",
                        "date": "2026-11-02",
                        "due_date": null,
                        "entry_number": 2,
                        "state": "saved",
                        "exchange_rate": "1.0",
                        "created_at": "2026-11-02T12:15:45.525Z",
                        "updated_at": "2026-11-02T12:15:45.525Z",
                        "version": 1793621745,
                        "notes": [],
                        "attachments": [],
                        "events": [
                          {
                            "administration_id": 123,
                            "user_id": "502689108256097381",
                            "action": "document_saved",
                            "link_entity_id": null,
                            "link_entity_type": null,
                            "data": {},
                            "created_at": "2026-11-02T12:15:45.527Z",
                            "updated_at": "2026-11-02T12:15:45.527Z"
                          }
                        ]
                      }
                    ]
                  },
                  "ReturnsPaginatedGeneralDocumentsOnPage2": {
                    "summary": "Returns paginated general documents on page 2",
                    "value": [
                      {
                        "id": "502689142081062039",
                        "administration_id": 123,
                        "contact_id": null,
                        "contact": null,
                        "reference": "Contract",
                        "date": "2026-11-02",
                        "due_date": null,
                        "entry_number": 4,
                        "state": "saved",
                        "exchange_rate": "1.0",
                        "created_at": "2026-11-02T12:15:45.659Z",
                        "updated_at": "2026-11-02T12:15:45.659Z",
                        "version": 1793621745,
                        "notes": [],
                        "attachments": [],
                        "events": [
                          {
                            "administration_id": 123,
                            "user_id": "502689108256097381",
                            "action": "document_saved",
                            "link_entity_id": null,
                            "link_entity_type": null,
                            "data": {},
                            "created_at": "2026-11-02T12:15:45.661Z",
                            "updated_at": "2026-11-02T12:15:45.661Z"
                          }
                        ]
                      }
                    ]
                  }
                }
              }
            }
          },
          "400": {
            "description": "Bad request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/symbolic_error"
                },
                "examples": {
                  "ReturnsAnErrorWhenTooManyGeneralDocumentsAreRequested": {
                    "summary": "Returns an error when too many general documents are requested",
                    "value": {
                      "error": "Per Page is too big",
                      "symbolic": {
                        "per_page": "max"
                      }
                    }
                  }
                }
              }
            }
          }
        },
        "operationId": "get_administration_id_documents_general_documents"
      },
      "post": {
        "summary": "Create a new general document",
        "description": "Creates a new general document.\n\n### Required scope(s)\n `documents`",
        "tags": [
          "Documents: General documents"
        ],
        "security": [
          {
            "bearerAuth": [
              "documents"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/administration_id"
          },
          {
            "$ref": "#/components/parameters/format"
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/*": {
              "schema": {
                "unevaluatedProperties": false,
                "type": "object",
                "properties": {
                  "general_document": {
                    "type": "object",
                    "unevaluatedProperties": false,
                    "properties": {
                      "reference": {
                        "type": "string",
                        "description": "**Required**."
                      },
                      "date": {
                        "type": "string",
                        "format": "date",
                        "description": "**Required**."
                      },
                      "due_date": {
                        "type": "string",
                        "format": "date"
                      },
                      "reminder_date": {
                        "type": "string",
                        "format": "date"
                      },
                      "contact_id": {
                        "$ref": "#/components/schemas/identifier",
                        "description": "Should be a valid contact id."
                      },
                      "reminder": {
                        "type": "object",
                        "unevaluatedProperties": false,
                        "description": "Creates a reminder to-do for this document.",
                        "properties": {
                          "date": {
                            "type": "string",
                            "format": "date"
                          },
                          "message": {
                            "type": "string"
                          }
                        },
                        "required": [
                          "date"
                        ]
                      }
                    },
                    "required": []
                  }
                },
                "required": []
              },
              "examples": {
                "CreatesTheGeneralDocument": {
                  "summary": "Creates the general document",
                  "value": {
                    "general_document": {
                      "reference": "foobar",
                      "contact_id": 502689138500175600
                    }
                  }
                }
              }
            }
          }
        },
        "responses": {
          "201": {
            "description": "General document created",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/general_document_response"
                },
                "examples": {
                  "CreatesTheGeneralDocument": {
                    "summary": "Creates the general document",
                    "value": {
                      "id": "502689138551555848",
                      "administration_id": 123,
                      "contact_id": "502689138500175608",
                      "contact": {
                        "id": "502689138500175608",
                        "administration_id": 123,
                        "company_name": "Foobar Holding B.V.",
                        "firstname": null,
                        "lastname": null,
                        "address1": "Hoofdstraat 12",
                        "address2": null,
                        "zipcode": "1234AB",
                        "city": "Amsterdam",
                        "country": "NL",
                        "phone": null,
                        "delivery_method": "Email",
                        "customer_id": "customer-1",
                        "tax_number": null,
                        "chamber_of_commerce": null,
                        "bank_account": null,
                        "is_trusted": false,
                        "max_transfer_amount": null,
                        "attention": null,
                        "email": "info@example.com",
                        "email_ubl": true,
                        "send_invoices_to_attention": null,
                        "send_invoices_to_email": "info@example.com",
                        "send_estimates_to_attention": null,
                        "send_estimates_to_email": "info@example.com",
                        "direct_debit": false,
                        "sepa_active": false,
                        "sepa_iban": null,
                        "sepa_iban_account_name": null,
                        "sepa_bic": null,
                        "sepa_mandate_id": null,
                        "sepa_mandate_date": null,
                        "sepa_sequence_type": "RCUR",
                        "credit_card_number": null,
                        "credit_card_reference": null,
                        "credit_card_type": null,
                        "tax_number_validated_at": null,
                        "tax_number_valid": null,
                        "invoice_workflow_id": null,
                        "estimate_workflow_id": null,
                        "si_identifier": null,
                        "si_identifier_type": null,
                        "moneybird_payments_mandate": false,
                        "created_at": "2026-11-02T12:15:42.244Z",
                        "updated_at": "2026-11-02T12:15:42.244Z",
                        "version": 1793621742,
                        "sales_invoices_url": "https://moneybird.dev/123/sales_invoices/0000000000000000000000000000000000000000000000000000000000000001/all",
                        "notes": [],
                        "custom_fields": [],
                        "contact_people": [],
                        "archived": false
                      },
                      "reference": "foobar",
                      "date": "2026-11-02",
                      "due_date": null,
                      "entry_number": 3,
                      "state": "saved",
                      "exchange_rate": "1.0",
                      "created_at": "2026-11-02T12:15:42.294Z",
                      "updated_at": "2026-11-02T12:15:42.294Z",
                      "version": 1793621742,
                      "notes": [],
                      "attachments": [],
                      "events": [
                        {
                          "administration_id": 123,
                          "user_id": "502689108256097381",
                          "action": "document_saved",
                          "link_entity_id": null,
                          "link_entity_type": null,
                          "data": {},
                          "created_at": "2026-11-02T12:15:42.296Z",
                          "updated_at": "2026-11-02T12:15:42.296Z"
                        }
                      ]
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "Bad request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/symbolic_error"
                },
                "examples": {
                  "RequiresAllInput": {
                    "summary": "Requires all input",
                    "value": {
                      "error": "General Document is required",
                      "symbolic": {
                        "general_document": "required"
                      }
                    }
                  }
                }
              }
            }
          },
          "402": {
            "$ref": "#/components/responses/402_payment_required"
          },
          "422": {
            "$ref": "#/components/responses/422_unprocessable_entity"
          }
        },
        "operationId": "post_administration_id_documents_general_documents"
      }
    },
    "/{administration_id}/documents/general_journal_documents/synchronization{format}": {
      "get": {
        "summary": "List ids and versions of general journal documents",
        "description": "Returns all documents in the administration. The list contains the document id and the version of the document.\nCheck if the version of the document is newer than the version you have stored locally, use the `POST`\nvariant for fetching documents with the given ids.\n\n### Required scope(s)\n `documents`",
        "tags": [
          "Documents: General journal documents"
        ],
        "security": [
          {
            "bearerAuth": [
              "documents"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/administration_id"
          },
          {
            "$ref": "#/components/parameters/format"
          },
          {
            "name": "filter",
            "in": "query",
            "required": false,
            "description": "Comma-separated `key:value` filter terms. Same syntax as `GET /documents/general_journal_documents` — see that operation's description for the available keys.",
            "schema": {
              "type": "string"
            },
            "examples": {
              "RetrievesAllIdsForSynchronizationUsingAFilter": {
                "summary": "Retrieves all ids for synchronization using a filter",
                "value": "period:this_month"
              }
            }
          }
        ],
        "responses": {
          "200": {
            "description": "IDs and versions of records",
            "content": {
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "type": "object",
                    "unevaluatedProperties": false,
                    "properties": {
                      "id": {
                        "type": [
                          "integer",
                          "string"
                        ]
                      },
                      "version": {
                        "type": [
                          "integer",
                          "string"
                        ]
                      }
                    }
                  }
                },
                "examples": {
                  "RetrievesAllIdsForSynchronizationUsingAFilter": {
                    "summary": "Retrieves all ids for synchronization using a filter",
                    "value": [
                      {
                        "id": "502689299342296201",
                        "version": 1793621895
                      },
                      {
                        "id": "502689299381093532",
                        "version": 1793621895
                      },
                      {
                        "id": "502689299420939439",
                        "version": 1793621895
                      }
                    ]
                  },
                  "RetrievesAllIdsForSynchronization": {
                    "summary": "Retrieves all ids for synchronization",
                    "value": [
                      {
                        "id": "502689299523699923",
                        "version": 1793621895
                      },
                      {
                        "id": "502689299556205798",
                        "version": 1793621895
                      },
                      {
                        "id": "502689299591857401",
                        "version": 1793621895
                      }
                    ]
                  }
                }
              }
            }
          }
        },
        "operationId": "get_administration_id_documents_general_journal_documents_synchronization"
      },
      "post": {
        "summary": "Fetch general journal documents with given ids",
        "x-query": true,
        "description": "Given a list of document ids, returns the document information belonging to the documents.\nReturns a maximum of 100 documents, even if more ids are provided.\n\n### Required scope(s)\n `documents`",
        "tags": [
          "Documents: General journal documents"
        ],
        "security": [
          {
            "bearerAuth": [
              "documents"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/administration_id"
          },
          {
            "$ref": "#/components/parameters/format"
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/*": {
              "schema": {
                "unevaluatedProperties": false,
                "type": "object",
                "properties": {
                  "ids": {
                    "type": "array",
                    "items": {
                      "type": [
                        "integer",
                        "string"
                      ]
                    }
                  }
                },
                "required": [
                  "ids"
                ]
              },
              "examples": {
                "RetrievesDocumentsForGivenIds": {
                  "summary": "Retrieves documents for given ids",
                  "value": {
                    "ids": [
                      502689299186058300,
                      502689299221709950
                    ]
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "A list of general journal documents",
            "content": {
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "$ref": "#/components/schemas/general_journal_document_response"
                  }
                },
                "examples": {
                  "RetrievesDocumentsForGivenIds": {
                    "summary": "Retrieves documents for given ids",
                    "value": [
                      {
                        "id": "502689299186058322",
                        "administration_id": 123,
                        "reference": "Deprecations",
                        "date": "2026-11-02",
                        "journal_type": null,
                        "created_at": "2026-11-02T12:18:15.486Z",
                        "updated_at": "2026-11-02T12:18:15.486Z",
                        "version": 1793621895,
                        "general_journal_document_entries": [
                          {
                            "id": "502689299187106899",
                            "administration_id": 123,
                            "ledger_account_id": "502689299169281105",
                            "project_id": null,
                            "contact_id": null,
                            "debit": "100.0",
                            "credit": "0.0",
                            "row_order": 1,
                            "created_at": "2026-11-02T12:18:15.488Z",
                            "updated_at": "2026-11-02T12:18:15.488Z",
                            "description": "First"
                          },
                          {
                            "id": "502689299188155476",
                            "administration_id": 123,
                            "ledger_account_id": "502689299169281105",
                            "project_id": null,
                            "contact_id": null,
                            "debit": "0.0",
                            "credit": "100.0",
                            "row_order": 2,
                            "created_at": "2026-11-02T12:18:15.488Z",
                            "updated_at": "2026-11-02T12:18:15.488Z",
                            "description": "Second"
                          },
                          {
                            "id": "502689299188155477",
                            "administration_id": 123,
                            "ledger_account_id": "502689299169281105",
                            "project_id": null,
                            "contact_id": null,
                            "debit": "50.0",
                            "credit": "0.0",
                            "row_order": 3,
                            "created_at": "2026-11-02T12:18:15.489Z",
                            "updated_at": "2026-11-02T12:18:15.489Z",
                            "description": "Third"
                          },
                          {
                            "id": "502689299189204054",
                            "administration_id": 123,
                            "ledger_account_id": "502689299169281105",
                            "project_id": null,
                            "contact_id": null,
                            "debit": "0.0",
                            "credit": "50.0",
                            "row_order": 4,
                            "created_at": "2026-11-02T12:18:15.490Z",
                            "updated_at": "2026-11-02T12:18:15.490Z",
                            "description": "Fourth"
                          }
                        ],
                        "notes": [],
                        "attachments": [],
                        "events": [
                          {
                            "administration_id": 123,
                            "user_id": "502689108256097381",
                            "action": "document_saved",
                            "link_entity_id": null,
                            "link_entity_type": null,
                            "data": {},
                            "created_at": "2026-11-02T12:18:15.492Z",
                            "updated_at": "2026-11-02T12:18:15.492Z"
                          }
                        ]
                      },
                      {
                        "id": "502689299221709925",
                        "administration_id": 123,
                        "reference": "Deprecations",
                        "date": "2026-11-02",
                        "journal_type": null,
                        "created_at": "2026-11-02T12:18:15.520Z",
                        "updated_at": "2026-11-02T12:18:15.520Z",
                        "version": 1793621895,
                        "general_journal_document_entries": [
                          {
                            "id": "502689299222758502",
                            "administration_id": 123,
                            "ledger_account_id": "502689299204932708",
                            "project_id": null,
                            "contact_id": null,
                            "debit": "100.0",
                            "credit": "0.0",
                            "row_order": 1,
                            "created_at": "2026-11-02T12:18:15.521Z",
                            "updated_at": "2026-11-02T12:18:15.521Z",
                            "description": "First"
                          },
                          {
                            "id": "502689299223807079",
                            "administration_id": 123,
                            "ledger_account_id": "502689299204932708",
                            "project_id": null,
                            "contact_id": null,
                            "debit": "0.0",
                            "credit": "100.0",
                            "row_order": 2,
                            "created_at": "2026-11-02T12:18:15.522Z",
                            "updated_at": "2026-11-02T12:18:15.522Z",
                            "description": "Second"
                          },
                          {
                            "id": "502689299224855656",
                            "administration_id": 123,
                            "ledger_account_id": "502689299204932708",
                            "project_id": null,
                            "contact_id": null,
                            "debit": "50.0",
                            "credit": "0.0",
                            "row_order": 3,
                            "created_at": "2026-11-02T12:18:15.523Z",
                            "updated_at": "2026-11-02T12:18:15.523Z",
                            "description": "Third"
                          },
                          {
                            "id": "502689299224855657",
                            "administration_id": 123,
                            "ledger_account_id": "502689299204932708",
                            "project_id": null,
                            "contact_id": null,
                            "debit": "0.0",
                            "credit": "50.0",
                            "row_order": 4,
                            "created_at": "2026-11-02T12:18:15.524Z",
                            "updated_at": "2026-11-02T12:18:15.524Z",
                            "description": "Fourth"
                          }
                        ],
                        "notes": [],
                        "attachments": [],
                        "events": [
                          {
                            "administration_id": 123,
                            "user_id": "502689108256097381",
                            "action": "document_saved",
                            "link_entity_id": null,
                            "link_entity_type": null,
                            "data": {},
                            "created_at": "2026-11-02T12:18:15.526Z",
                            "updated_at": "2026-11-02T12:18:15.526Z"
                          }
                        ]
                      }
                    ]
                  }
                }
              }
            }
          }
        },
        "operationId": "post_administration_id_documents_general_journal_documents_synchronization"
      }
    },
    "/{administration_id}/documents/general_journal_documents/{general_journal_document_id}/notes/{id}{format}": {
      "delete": {
        "summary": "Destroys note from entity",
        "description": "Deletes a note from the general journal document.\n\n### Required scope(s)\n `documents`",
        "tags": [
          "Documents: General journal documents"
        ],
        "security": [
          {
            "bearerAuth": [
              "documents"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/administration_id"
          },
          {
            "name": "general_journal_document_id",
            "in": "path",
            "required": true,
            "schema": {
              "$ref": "#/components/schemas/identifier"
            }
          },
          {
            "name": "id",
            "in": "path",
            "required": true,
            "schema": {
              "$ref": "#/components/schemas/identifier"
            }
          },
          {
            "$ref": "#/components/parameters/format"
          }
        ],
        "responses": {
          "204": {
            "description": "Note deleted"
          },
          "400": {
            "$ref": "#/components/responses/400_bad_request"
          }
        },
        "operationId": "delete_administration_id_documents_general_journal_documents_general_journal_document_id_notes_id"
      }
    },
    "/{administration_id}/documents/general_journal_documents/{general_journal_document_id}/notes{format}": {
      "post": {
        "summary": "Adds note to entity",
        "description": "Adds a note to the general journal document.\n\n### Required scope(s)\n `documents`",
        "tags": [
          "Documents: General journal documents"
        ],
        "security": [
          {
            "bearerAuth": [
              "documents"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/administration_id"
          },
          {
            "name": "general_journal_document_id",
            "in": "path",
            "required": true,
            "schema": {
              "$ref": "#/components/schemas/identifier"
            }
          },
          {
            "$ref": "#/components/parameters/format"
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/*": {
              "schema": {
                "unevaluatedProperties": false,
                "type": "object",
                "properties": {
                  "note": {
                    "type": "object",
                    "unevaluatedProperties": false,
                    "properties": {
                      "note": {
                        "type": "string",
                        "description": "**Required**. Text for the note or to-do."
                      },
                      "todo": {
                        "type": [
                          "boolean",
                          "string"
                        ],
                        "description": "If `true` the note is a to-do."
                      },
                      "assignee_id": {
                        "$ref": "#/components/schemas/identifier",
                        "description": "Assign to-do to user. Should be a valid user id. If assignee_id is provided the note will be a to-do."
                      }
                    },
                    "required": []
                  }
                },
                "required": []
              },
              "examples": {
                "CreateANote": {
                  "summary": "Create a note",
                  "value": {
                    "note": {
                      "note": "Text of the note",
                      "assignee_id": 502689296958883000,
                      "todo": true
                    }
                  }
                }
              }
            }
          }
        },
        "responses": {
          "201": {
            "description": "Note created",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/note_response"
                },
                "examples": {
                  "CreateANote": {
                    "summary": "Create a note",
                    "value": {
                      "id": "502689296973563089",
                      "administration_id": 123,
                      "entity_id": "502689296937911485",
                      "entity_type": "Document",
                      "user_id": "502689108256097381",
                      "assignee_id": "502689296958883023",
                      "todo": true,
                      "note": "Text of the note",
                      "completed_at": null,
                      "completed_by_id": null,
                      "todo_type": null,
                      "data": {},
                      "created_at": "2026-11-02T12:18:13.377Z",
                      "updated_at": "2026-11-02T12:18:13.377Z"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "$ref": "#/components/responses/400_bad_request"
          },
          "422": {
            "$ref": "#/components/responses/422_unprocessable_entity"
          }
        },
        "operationId": "post_administration_id_documents_general_journal_documents_general_journal_document_id_notes"
      }
    },
    "/{administration_id}/documents/general_journal_documents/{id}/attachments/{attachment_id}/download{format}": {
      "get": {
        "summary": "Download attachment",
        "description": "Download the attachment. The response will be a redirect to a temporarily available URL\nwhere the attachment can be downloaded. Use the `Location` header in the response\nto download the attachment.\n\n### Required scope(s)\n `documents`",
        "tags": [
          "Documents: General journal documents"
        ],
        "security": [
          {
            "bearerAuth": [
              "documents"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/administration_id"
          },
          {
            "name": "id",
            "in": "path",
            "required": true,
            "schema": {
              "$ref": "#/components/schemas/identifier"
            }
          },
          {
            "name": "attachment_id",
            "in": "path",
            "required": true,
            "schema": {
              "$ref": "#/components/schemas/identifier"
            }
          },
          {
            "$ref": "#/components/parameters/format"
          }
        ],
        "responses": {
          "302": {
            "description": "Found",
            "content": {
              "text/plain": {
                "schema": {
                  "type": "string"
                },
                "examples": {
                  "DownloadsTheAttachment": {
                    "summary": "Downloads the attachment",
                    "value": "{\"message\":\"Use the Location header to download the attachment\"}"
                  }
                }
              }
            }
          },
          "404": {
            "$ref": "#/components/responses/404_not_found"
          }
        },
        "operationId": "get_administration_id_documents_general_journal_documents_id_attachments_attachment_id_download"
      }
    },
    "/{administration_id}/documents/general_journal_documents/{id}/attachments/{attachment_id}{format}": {
      "delete": {
        "summary": "Delete an attachment",
        "description": "Deletes an attachment of an attachable.\n\n### Required scope(s)\n `documents`",
        "tags": [
          "Documents: General journal documents"
        ],
        "security": [
          {
            "bearerAuth": [
              "documents"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/administration_id"
          },
          {
            "name": "id",
            "in": "path",
            "required": true,
            "schema": {
              "$ref": "#/components/schemas/identifier"
            }
          },
          {
            "name": "attachment_id",
            "in": "path",
            "required": true,
            "schema": {
              "$ref": "#/components/schemas/identifier"
            }
          },
          {
            "$ref": "#/components/parameters/format"
          }
        ],
        "responses": {
          "204": {
            "description": "Attachment deleted"
          },
          "404": {
            "$ref": "#/components/responses/404_not_found"
          }
        },
        "operationId": "delete_administration_id_documents_general_journal_documents_id_attachments_attachment_id"
      }
    },
    "/{administration_id}/documents/general_journal_documents/{id}/attachments{format}": {
      "post": {
        "summary": "Add attachment to general journal document",
        "description": "Add an attachment to a general journal document.\n\n### Required scope(s)\n `documents`",
        "tags": [
          "Documents: General journal documents"
        ],
        "security": [
          {
            "bearerAuth": [
              "documents"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/administration_id"
          },
          {
            "name": "id",
            "in": "path",
            "required": true,
            "schema": {
              "$ref": "#/components/schemas/identifier"
            }
          },
          {
            "$ref": "#/components/parameters/format"
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "multipart/form-data": {
              "schema": {
                "type": "object",
                "properties": {
                  "file": {
                    "type": "string",
                    "format": "binary"
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Status code",
            "content": {
              "application/json": {
                "schema": {
                  "type": "integer"
                },
                "examples": {
                  "UploadsAnAttachment": {
                    "summary": "Uploads an attachment",
                    "value": 200
                  }
                }
              }
            }
          },
          "400": {
            "$ref": "#/components/responses/400_bad_request"
          },
          "404": {
            "$ref": "#/components/responses/404_not_found"
          },
          "422": {
            "$ref": "#/components/responses/422_unprocessable_entity"
          }
        },
        "operationId": "post_administration_id_documents_general_journal_documents_id_attachments"
      }
    },
    "/{administration_id}/documents/general_journal_documents/{id}{format}": {
      "get": {
        "summary": "Get general journal document",
        "description": "Returns a general journal document by id.\n\n### Required scope(s)\n `documents`",
        "tags": [
          "Documents: General journal documents"
        ],
        "security": [
          {
            "bearerAuth": [
              "documents"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/administration_id"
          },
          {
            "name": "id",
            "in": "path",
            "required": true,
            "schema": {
              "$ref": "#/components/schemas/identifier"
            }
          },
          {
            "$ref": "#/components/parameters/format"
          }
        ],
        "responses": {
          "200": {
            "description": "A general journal document",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/general_journal_document_response"
                },
                "examples": {
                  "ReturnsTheWantedGeneralJournalDocument": {
                    "summary": "Returns the wanted general journal document",
                    "value": {
                      "id": "502689297246192941",
                      "administration_id": 123,
                      "reference": "Deprecations",
                      "date": "2026-11-02",
                      "journal_type": null,
                      "created_at": "2026-11-02T12:18:13.636Z",
                      "updated_at": "2026-11-02T12:18:13.636Z",
                      "version": 1793621893,
                      "general_journal_document_entries": [
                        {
                          "id": "502689297247241518",
                          "administration_id": 123,
                          "ledger_account_id": "502689297234658604",
                          "project_id": null,
                          "contact_id": null,
                          "debit": "100.0",
                          "credit": "0.0",
                          "row_order": 1,
                          "created_at": "2026-11-02T12:18:13.637Z",
                          "updated_at": "2026-11-02T12:18:13.637Z",
                          "description": "First"
                        },
                        {
                          "id": "502689297248290095",
                          "administration_id": 123,
                          "ledger_account_id": "502689297234658604",
                          "project_id": null,
                          "contact_id": null,
                          "debit": "0.0",
                          "credit": "100.0",
                          "row_order": 2,
                          "created_at": "2026-11-02T12:18:13.638Z",
                          "updated_at": "2026-11-02T12:18:13.638Z",
                          "description": "Second"
                        },
                        {
                          "id": "502689297248290096",
                          "administration_id": 123,
                          "ledger_account_id": "502689297234658604",
                          "project_id": null,
                          "contact_id": null,
                          "debit": "50.0",
                          "credit": "0.0",
                          "row_order": 3,
                          "created_at": "2026-11-02T12:18:13.639Z",
                          "updated_at": "2026-11-02T12:18:13.639Z",
                          "description": "Third"
                        },
                        {
                          "id": "502689297249338673",
                          "administration_id": 123,
                          "ledger_account_id": "502689297234658604",
                          "project_id": null,
                          "contact_id": null,
                          "debit": "0.0",
                          "credit": "50.0",
                          "row_order": 4,
                          "created_at": "2026-11-02T12:18:13.640Z",
                          "updated_at": "2026-11-02T12:18:13.640Z",
                          "description": "Fourth"
                        }
                      ],
                      "notes": [],
                      "attachments": [],
                      "events": [
                        {
                          "administration_id": 123,
                          "user_id": "502689108256097381",
                          "action": "document_saved",
                          "link_entity_id": null,
                          "link_entity_type": null,
                          "data": {},
                          "created_at": "2026-11-02T12:18:13.641Z",
                          "updated_at": "2026-11-02T12:18:13.641Z"
                        }
                      ]
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Not found",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/symbolic_error"
                },
                "examples": {
                  "OnlyReturnsGeneralJournalDocuments": {
                    "summary": "Only returns general journal documents",
                    "value": {
                      "error": "Record not found for model name: Manual journal"
                    }
                  }
                }
              }
            }
          }
        },
        "operationId": "get_administration_id_documents_general_journal_documents_id"
      },
      "delete": {
        "summary": "Delete a general journal document",
        "description": "Deletes a general journal document.\n\n### Required scope(s)\n `documents`",
        "tags": [
          "Documents: General journal documents"
        ],
        "security": [
          {
            "bearerAuth": [
              "documents"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/administration_id"
          },
          {
            "name": "id",
            "in": "path",
            "required": true,
            "schema": {
              "$ref": "#/components/schemas/identifier"
            }
          },
          {
            "$ref": "#/components/parameters/format"
          }
        ],
        "responses": {
          "200": {
            "description": "Status code",
            "content": {
              "application/json": {
                "schema": {
                  "type": "integer"
                },
                "examples": {
                  "DeletesTheGeneralJournalDocument": {
                    "summary": "Deletes the general journal document",
                    "value": 200
                  }
                }
              }
            }
          },
          "404": {
            "$ref": "#/components/responses/404_not_found"
          },
          "422": {
            "$ref": "#/components/responses/422_unprocessable_entity"
          }
        },
        "operationId": "delete_administration_id_documents_general_journal_documents_id"
      },
      "patch": {
        "summary": "Update a general journal document",
        "description": "Updates a general journal document.\n\n### Required scope(s)\n `documents`",
        "tags": [
          "Documents: General journal documents"
        ],
        "security": [
          {
            "bearerAuth": [
              "documents"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/administration_id"
          },
          {
            "name": "id",
            "in": "path",
            "required": true,
            "schema": {
              "$ref": "#/components/schemas/identifier"
            }
          },
          {
            "$ref": "#/components/parameters/format"
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/*": {
              "schema": {
                "unevaluatedProperties": false,
                "type": "object",
                "properties": {
                  "general_journal_document": {
                    "type": "object",
                    "unevaluatedProperties": false,
                    "properties": {
                      "reference": {
                        "type": "string"
                      },
                      "date": {
                        "type": "string"
                      },
                      "journal_type": {
                        "type": "string",
                        "enum": [
                          "fiscal_year_ending",
                          ""
                        ],
                        "description": "The only journal type is `fiscal_year_ending`, for the entry that closes a fiscal year. An empty string makes it a normal journal entry."
                      },
                      "general_journal_document_entries_attributes": {
                        "oneOf": [
                          {
                            "type": "array",
                            "items": {
                              "type": "object",
                              "unevaluatedProperties": false,
                              "properties": {
                                "id": {
                                  "type": "integer"
                                },
                                "ledger_account_id": {
                                  "$ref": "#/components/schemas/identifier",
                                  "description": "Should be a valid ledger account id."
                                },
                                "tax_rate_id": {
                                  "$ref": "#/components/schemas/identifier",
                                  "description": "Should be a valid tax rate id."
                                },
                                "description": {
                                  "type": "string"
                                },
                                "debit": {
                                  "$ref": "#/components/schemas/money"
                                },
                                "credit": {
                                  "$ref": "#/components/schemas/money"
                                },
                                "project_id": {
                                  "$ref": "#/components/schemas/identifier",
                                  "description": "Should be a valid project id."
                                },
                                "row_order": {
                                  "type": "integer"
                                },
                                "_destroy": {
                                  "type": [
                                    "boolean",
                                    "string"
                                  ]
                                },
                                "contact_id": {
                                  "$ref": "#/components/schemas/identifier",
                                  "description": "Should be a valid contact id."
                                }
                              },
                              "required": []
                            }
                          },
                          {
                            "type": "object",
                            "additionalProperties": {
                              "type": "object",
                              "properties": {
                                "id": {
                                  "type": "integer"
                                },
                                "ledger_account_id": {
                                  "$ref": "#/components/schemas/identifier",
                                  "description": "Should be a valid ledger account id."
                                },
                                "tax_rate_id": {
                                  "$ref": "#/components/schemas/identifier",
                                  "description": "Should be a valid tax rate id."
                                },
                                "description": {
                                  "type": "string"
                                },
                                "debit": {
                                  "$ref": "#/components/schemas/money"
                                },
                                "credit": {
                                  "$ref": "#/components/schemas/money"
                                },
                                "project_id": {
                                  "$ref": "#/components/schemas/identifier",
                                  "description": "Should be a valid project id."
                                },
                                "row_order": {
                                  "type": "integer"
                                },
                                "_destroy": {
                                  "type": [
                                    "boolean",
                                    "string"
                                  ]
                                },
                                "contact_id": {
                                  "$ref": "#/components/schemas/identifier",
                                  "description": "Should be a valid contact id."
                                }
                              },
                              "required": []
                            }
                          }
                        ]
                      }
                    },
                    "required": []
                  },
                  "all_taxes": {
                    "type": [
                      "boolean",
                      "string"
                    ]
                  }
                },
                "required": []
              },
              "examples": {
                "UpdatesTheGeneralJournalDocument": {
                  "summary": "Updates the general journal document",
                  "value": {
                    "general_journal_document": {
                      "reference": "updated reference"
                    }
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "General journal document updated",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/general_journal_document_response"
                },
                "examples": {
                  "UpdatesTheGeneralJournalDocument": {
                    "summary": "Updates the general journal document",
                    "value": {
                      "id": "502689297676109283",
                      "administration_id": 123,
                      "reference": "updated reference",
                      "date": "2026-11-02",
                      "journal_type": null,
                      "created_at": "2026-11-02T12:18:14.046Z",
                      "updated_at": "2026-11-02T12:18:14.076Z",
                      "version": 1793621894,
                      "general_journal_document_entries": [
                        {
                          "id": "502689297677157860",
                          "administration_id": 123,
                          "ledger_account_id": "502689297663526370",
                          "project_id": null,
                          "contact_id": null,
                          "debit": "100.0",
                          "credit": "0.0",
                          "row_order": 1,
                          "created_at": "2026-11-02T12:18:14.047Z",
                          "updated_at": "2026-11-02T12:18:14.047Z",
                          "description": "First"
                        },
                        {
                          "id": "502689297677157861",
                          "administration_id": 123,
                          "ledger_account_id": "502689297663526370",
                          "project_id": null,
                          "contact_id": null,
                          "debit": "0.0",
                          "credit": "100.0",
                          "row_order": 2,
                          "created_at": "2026-11-02T12:18:14.048Z",
                          "updated_at": "2026-11-02T12:18:14.048Z",
                          "description": "Second"
                        },
                        {
                          "id": "502689297678206438",
                          "administration_id": 123,
                          "ledger_account_id": "502689297663526370",
                          "project_id": null,
                          "contact_id": null,
                          "debit": "50.0",
                          "credit": "0.0",
                          "row_order": 3,
                          "created_at": "2026-11-02T12:18:14.049Z",
                          "updated_at": "2026-11-02T12:18:14.049Z",
                          "description": "Third"
                        },
                        {
                          "id": "502689297678206439",
                          "administration_id": 123,
                          "ledger_account_id": "502689297663526370",
                          "project_id": null,
                          "contact_id": null,
                          "debit": "0.0",
                          "credit": "50.0",
                          "row_order": 4,
                          "created_at": "2026-11-02T12:18:14.049Z",
                          "updated_at": "2026-11-02T12:18:14.049Z",
                          "description": "Fourth"
                        }
                      ],
                      "notes": [],
                      "attachments": [],
                      "events": [
                        {
                          "administration_id": 123,
                          "user_id": "502689108256097381",
                          "action": "document_saved",
                          "link_entity_id": null,
                          "link_entity_type": null,
                          "data": {},
                          "created_at": "2026-11-02T12:18:14.050Z",
                          "updated_at": "2026-11-02T12:18:14.050Z"
                        },
                        {
                          "administration_id": 123,
                          "user_id": "502689108256097381",
                          "action": "document_updated",
                          "link_entity_id": null,
                          "link_entity_type": null,
                          "data": {},
                          "created_at": "2026-11-02T12:18:14.077Z",
                          "updated_at": "2026-11-02T12:18:14.077Z"
                        }
                      ]
                    }
                  }
                }
              }
            }
          },
          "400": {
            "$ref": "#/components/responses/400_bad_request"
          },
          "404": {
            "$ref": "#/components/responses/404_not_found"
          },
          "422": {
            "$ref": "#/components/responses/422_unprocessable_entity"
          }
        },
        "operationId": "patch_administration_id_documents_general_journal_documents_id"
      }
    },
    "/{administration_id}/documents/general_journal_documents{format}": {
      "get": {
        "summary": "Get general journal documents",
        "description": "Returns a paginated list of documents of this type in the administration.\n\nThe `exclude_new_general_journal_documents` parameter, when set to `true`, removes documents that are still in the `new` state from the response. It has no effect on other document types.\n\n### Required scope(s)\n `documents`",
        "tags": [
          "Documents: General journal documents"
        ],
        "security": [
          {
            "bearerAuth": [
              "documents"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/administration_id"
          },
          {
            "$ref": "#/components/parameters/format"
          },
          {
            "name": "filter",
            "in": "query",
            "required": false,
            "description": "Filters are `key:value` terms separated by commas (e.g. `period:this_year,state:open`). Any filter you pass replaces the defaults below entirely, so include every key you need. Available filters:\n\n| **Filter** | **Type** | **Default** | **Description** |\n| - | - | - | - |\n| period | `String` | `this_year` | A named period (`this_week`, `prev_week`, `next_week`, `this_month`, `prev_month`, `next_month`, `this_quarter`, `prev_quarter`, `next_quarter`, `this_year`, `prev_year`, `next_year`) or a custom range (`201301..201302`, `20130101..20130131`). A custom period must have a start and an end date. It must not be longer than 10 years and must be between `20000101` and `21000101`. For one month, use `202401..202401`, not `202401`. Without `period`, the filter does not limit the dates. The default `this_year` applies only when you send no `filter`. |\n| state | `String` | `all` | `all`, `new`, `saved`, `open`, `paid`, `late` or `pending_payment`. `paid`, `late` and `pending_payment` only apply to documents with a payment lifecycle (purchase invoices and receipts) |\n| recurring | `String` | `all` | `all`, `enabled` or `disabled` |\n| attachment | `String` | `all` | `all`, `with` or `without` |\n| reference | `String` | | Documents with the given reference value |\n| contact_id | `Integer` | | Documents belonging to the given contact |\n| ledger_account_id | `Integer` | | Documents booking against the given ledger account |\n| updated_after | `String` | | ISO 8601 timestamp in UTC; documents updated strictly after this time |\n\nMultiple values for `state`, `recurring` and `attachment` can be combined with a pipe, e.g. `state:open|paid`.",
            "schema": {
              "type": "string",
              "default": "period:this_year"
            },
            "examples": {
              "ReturnsTheOldestGeneralJournalDocumentFirstWhenSortedByDateAscending": {
                "summary": "Returns the oldest general journal document first when sorted by date ascending",
                "value": "period:20251102..20261102"
              }
            }
          },
          {
            "name": "new_filter",
            "in": "query",
            "required": false,
            "schema": {
              "type": "string",
              "description": "String terms, example: `key1:value1,key2:value2`."
            }
          },
          {
            "$ref": "#/components/parameters/page"
          },
          {
            "$ref": "#/components/parameters/sort"
          },
          {
            "$ref": "#/components/parameters/per_page"
          },
          {
            "name": "exclude_new_general_journal_documents",
            "in": "query",
            "required": false,
            "schema": {
              "type": [
                "boolean",
                "string"
              ]
            }
          }
        ],
        "responses": {
          "200": {
            "description": "A list of general journal documents",
            "content": {
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "$ref": "#/components/schemas/general_journal_document_response"
                  }
                },
                "examples": {
                  "ReturnsPaginatedGeneralJournalDocumentsOnPage2": {
                    "summary": "Returns paginated general journal documents on page 2",
                    "value": [
                      {
                        "id": "502689297958176326",
                        "administration_id": 123,
                        "reference": "Deprecations",
                        "date": "2026-11-02",
                        "journal_type": null,
                        "created_at": "2026-11-02T12:18:14.316Z",
                        "updated_at": "2026-11-02T12:18:14.316Z",
                        "version": 1793621894,
                        "general_journal_document_entries": [
                          {
                            "id": "502689297959224903",
                            "administration_id": 123,
                            "ledger_account_id": "502689297943496261",
                            "project_id": null,
                            "contact_id": null,
                            "debit": "100.0",
                            "credit": "0.0",
                            "row_order": 1,
                            "created_at": "2026-11-02T12:18:14.317Z",
                            "updated_at": "2026-11-02T12:18:14.317Z",
                            "description": "First"
                          },
                          {
                            "id": "502689297960273480",
                            "administration_id": 123,
                            "ledger_account_id": "502689297943496261",
                            "project_id": null,
                            "contact_id": null,
                            "debit": "0.0",
                            "credit": "100.0",
                            "row_order": 2,
                            "created_at": "2026-11-02T12:18:14.318Z",
                            "updated_at": "2026-11-02T12:18:14.318Z",
                            "description": "Second"
                          },
                          {
                            "id": "502689297961322057",
                            "administration_id": 123,
                            "ledger_account_id": "502689297943496261",
                            "project_id": null,
                            "contact_id": null,
                            "debit": "50.0",
                            "credit": "0.0",
                            "row_order": 3,
                            "created_at": "2026-11-02T12:18:14.318Z",
                            "updated_at": "2026-11-02T12:18:14.318Z",
                            "description": "Third"
                          },
                          {
                            "id": "502689297962370634",
                            "administration_id": 123,
                            "ledger_account_id": "502689297943496261",
                            "project_id": null,
                            "contact_id": null,
                            "debit": "0.0",
                            "credit": "50.0",
                            "row_order": 4,
                            "created_at": "2026-11-02T12:18:14.319Z",
                            "updated_at": "2026-11-02T12:18:14.319Z",
                            "description": "Fourth"
                          }
                        ],
                        "notes": [],
                        "attachments": [],
                        "events": [
                          {
                            "administration_id": 123,
                            "user_id": "502689108256097381",
                            "action": "document_saved",
                            "link_entity_id": null,
                            "link_entity_type": null,
                            "data": {},
                            "created_at": "2026-11-02T12:18:14.321Z",
                            "updated_at": "2026-11-02T12:18:14.321Z"
                          }
                        ]
                      }
                    ]
                  },
                  "ReturnsTheOldestGeneralJournalDocumentFirstWhenSortedByDateAscending": {
                    "summary": "Returns the oldest general journal document first when sorted by date ascending",
                    "value": [
                      {
                        "id": "502689298233951944",
                        "administration_id": 123,
                        "reference": "Loonjournaalposten",
                        "date": "2025-11-02",
                        "journal_type": null,
                        "created_at": "2026-11-02T12:18:14.578Z",
                        "updated_at": "2026-11-02T12:18:14.578Z",
                        "version": 1793621894,
                        "general_journal_document_entries": [],
                        "notes": [],
                        "attachments": [],
                        "events": []
                      }
                    ]
                  },
                  "ReturnsPaginatedGeneralJournalDocumentsOnPage1": {
                    "summary": "Returns paginated general journal documents on page 1",
                    "value": [
                      {
                        "id": "502689298414307092",
                        "administration_id": 123,
                        "reference": "Deprecations",
                        "date": "2026-11-02",
                        "journal_type": null,
                        "created_at": "2026-11-02T12:18:14.750Z",
                        "updated_at": "2026-11-02T12:18:14.750Z",
                        "version": 1793621894,
                        "general_journal_document_entries": [
                          {
                            "id": "502689298415355669",
                            "administration_id": 123,
                            "ledger_account_id": "502689298401724179",
                            "project_id": null,
                            "contact_id": null,
                            "debit": "100.0",
                            "credit": "0.0",
                            "row_order": 1,
                            "created_at": "2026-11-02T12:18:14.751Z",
                            "updated_at": "2026-11-02T12:18:14.751Z",
                            "description": "First"
                          },
                          {
                            "id": "502689298415355670",
                            "administration_id": 123,
                            "ledger_account_id": "502689298401724179",
                            "project_id": null,
                            "contact_id": null,
                            "debit": "0.0",
                            "credit": "100.0",
                            "row_order": 2,
                            "created_at": "2026-11-02T12:18:14.752Z",
                            "updated_at": "2026-11-02T12:18:14.752Z",
                            "description": "Second"
                          },
                          {
                            "id": "502689298416404247",
                            "administration_id": 123,
                            "ledger_account_id": "502689298401724179",
                            "project_id": null,
                            "contact_id": null,
                            "debit": "50.0",
                            "credit": "0.0",
                            "row_order": 3,
                            "created_at": "2026-11-02T12:18:14.753Z",
                            "updated_at": "2026-11-02T12:18:14.753Z",
                            "description": "Third"
                          },
                          {
                            "id": "502689298416404248",
                            "administration_id": 123,
                            "ledger_account_id": "502689298401724179",
                            "project_id": null,
                            "contact_id": null,
                            "debit": "0.0",
                            "credit": "50.0",
                            "row_order": 4,
                            "created_at": "2026-11-02T12:18:14.753Z",
                            "updated_at": "2026-11-02T12:18:14.753Z",
                            "description": "Fourth"
                          }
                        ],
                        "notes": [],
                        "attachments": [],
                        "events": [
                          {
                            "administration_id": 123,
                            "user_id": "502689108256097381",
                            "action": "document_saved",
                            "link_entity_id": null,
                            "link_entity_type": null,
                            "data": {},
                            "created_at": "2026-11-02T12:18:14.754Z",
                            "updated_at": "2026-11-02T12:18:14.754Z"
                          }
                        ]
                      }
                    ]
                  },
                  "ReturnsAListOfGeneralJournalDocuments": {
                    "summary": "Returns a list of general journal documents",
                    "value": [
                      {
                        "id": "502689298821154766",
                        "administration_id": 123,
                        "reference": "Deprecations",
                        "date": "2026-11-02",
                        "journal_type": null,
                        "created_at": "2026-11-02T12:18:15.138Z",
                        "updated_at": "2026-11-02T12:18:15.138Z",
                        "version": 1793621895,
                        "general_journal_document_entries": [
                          {
                            "id": "502689298822203343",
                            "administration_id": 123,
                            "ledger_account_id": "502689298805426125",
                            "project_id": null,
                            "contact_id": null,
                            "debit": "100.0",
                            "credit": "0.0",
                            "row_order": 1,
                            "created_at": "2026-11-02T12:18:15.140Z",
                            "updated_at": "2026-11-02T12:18:15.140Z",
                            "description": "First"
                          },
                          {
                            "id": "502689298823251920",
                            "administration_id": 123,
                            "ledger_account_id": "502689298805426125",
                            "project_id": null,
                            "contact_id": null,
                            "debit": "0.0",
                            "credit": "100.0",
                            "row_order": 2,
                            "created_at": "2026-11-02T12:18:15.141Z",
                            "updated_at": "2026-11-02T12:18:15.141Z",
                            "description": "Second"
                          },
                          {
                            "id": "502689298824300497",
                            "administration_id": 123,
                            "ledger_account_id": "502689298805426125",
                            "project_id": null,
                            "contact_id": null,
                            "debit": "50.0",
                            "credit": "0.0",
                            "row_order": 3,
                            "created_at": "2026-11-02T12:18:15.142Z",
                            "updated_at": "2026-11-02T12:18:15.142Z",
                            "description": "Third"
                          },
                          {
                            "id": "502689298824300498",
                            "administration_id": 123,
                            "ledger_account_id": "502689298805426125",
                            "project_id": null,
                            "contact_id": null,
                            "debit": "0.0",
                            "credit": "50.0",
                            "row_order": 4,
                            "created_at": "2026-11-02T12:18:15.142Z",
                            "updated_at": "2026-11-02T12:18:15.142Z",
                            "description": "Fourth"
                          }
                        ],
                        "notes": [],
                        "attachments": [],
                        "events": [
                          {
                            "administration_id": 123,
                            "user_id": "502689108256097381",
                            "action": "document_saved",
                            "link_entity_id": null,
                            "link_entity_type": null,
                            "data": {},
                            "created_at": "2026-11-02T12:18:15.143Z",
                            "updated_at": "2026-11-02T12:18:15.143Z"
                          }
                        ]
                      },
                      {
                        "id": "502689298786551739",
                        "administration_id": 123,
                        "reference": "Deprecations",
                        "date": "2026-11-02",
                        "journal_type": null,
                        "created_at": "2026-11-02T12:18:15.106Z",
                        "updated_at": "2026-11-02T12:18:15.106Z",
                        "version": 1793621895,
                        "general_journal_document_entries": [
                          {
                            "id": "502689298787600316",
                            "administration_id": 123,
                            "ledger_account_id": "502689298772920250",
                            "project_id": null,
                            "contact_id": null,
                            "debit": "100.0",
                            "credit": "0.0",
                            "row_order": 1,
                            "created_at": "2026-11-02T12:18:15.107Z",
                            "updated_at": "2026-11-02T12:18:15.107Z",
                            "description": "First"
                          },
                          {
                            "id": "502689298788648893",
                            "administration_id": 123,
                            "ledger_account_id": "502689298772920250",
                            "project_id": null,
                            "contact_id": null,
                            "debit": "0.0",
                            "credit": "100.0",
                            "row_order": 2,
                            "created_at": "2026-11-02T12:18:15.108Z",
                            "updated_at": "2026-11-02T12:18:15.108Z",
                            "description": "Second"
                          },
                          {
                            "id": "502689298788648894",
                            "administration_id": 123,
                            "ledger_account_id": "502689298772920250",
                            "project_id": null,
                            "contact_id": null,
                            "debit": "50.0",
                            "credit": "0.0",
                            "row_order": 3,
                            "created_at": "2026-11-02T12:18:15.108Z",
                            "updated_at": "2026-11-02T12:18:15.108Z",
                            "description": "Third"
                          },
                          {
                            "id": "502689298789697471",
                            "administration_id": 123,
                            "ledger_account_id": "502689298772920250",
                            "project_id": null,
                            "contact_id": null,
                            "debit": "0.0",
                            "credit": "50.0",
                            "row_order": 4,
                            "created_at": "2026-11-02T12:18:15.109Z",
                            "updated_at": "2026-11-02T12:18:15.109Z",
                            "description": "Fourth"
                          }
                        ],
                        "notes": [],
                        "attachments": [],
                        "events": [
                          {
                            "administration_id": 123,
                            "user_id": "502689108256097381",
                            "action": "document_saved",
                            "link_entity_id": null,
                            "link_entity_type": null,
                            "data": {},
                            "created_at": "2026-11-02T12:18:15.110Z",
                            "updated_at": "2026-11-02T12:18:15.110Z"
                          }
                        ]
                      },
                      {
                        "id": "502689298756143016",
                        "administration_id": 123,
                        "reference": "Deprecations",
                        "date": "2026-11-02",
                        "journal_type": null,
                        "created_at": "2026-11-02T12:18:15.077Z",
                        "updated_at": "2026-11-02T12:18:15.077Z",
                        "version": 1793621895,
                        "general_journal_document_entries": [
                          {
                            "id": "502689298757191593",
                            "administration_id": 123,
                            "ledger_account_id": "502689298742511527",
                            "project_id": null,
                            "contact_id": null,
                            "debit": "100.0",
                            "credit": "0.0",
                            "row_order": 1,
                            "created_at": "2026-11-02T12:18:15.078Z",
                            "updated_at": "2026-11-02T12:18:15.078Z",
                            "description": "First"
                          },
                          {
                            "id": "502689298758240170",
                            "administration_id": 123,
                            "ledger_account_id": "502689298742511527",
                            "project_id": null,
                            "contact_id": null,
                            "debit": "0.0",
                            "credit": "100.0",
                            "row_order": 2,
                            "created_at": "2026-11-02T12:18:15.079Z",
                            "updated_at": "2026-11-02T12:18:15.079Z",
                            "description": "Second"
                          },
                          {
                            "id": "502689298759288747",
                            "administration_id": 123,
                            "ledger_account_id": "502689298742511527",
                            "project_id": null,
                            "contact_id": null,
                            "debit": "50.0",
                            "credit": "0.0",
                            "row_order": 3,
                            "created_at": "2026-11-02T12:18:15.079Z",
                            "updated_at": "2026-11-02T12:18:15.079Z",
                            "description": "Third"
                          },
                          {
                            "id": "502689298759288748",
                            "administration_id": 123,
                            "ledger_account_id": "502689298742511527",
                            "project_id": null,
                            "contact_id": null,
                            "debit": "0.0",
                            "credit": "50.0",
                            "row_order": 4,
                            "created_at": "2026-11-02T12:18:15.080Z",
                            "updated_at": "2026-11-02T12:18:15.080Z",
                            "description": "Fourth"
                          }
                        ],
                        "notes": [],
                        "attachments": [],
                        "events": [
                          {
                            "administration_id": 123,
                            "user_id": "502689108256097381",
                            "action": "document_saved",
                            "link_entity_id": null,
                            "link_entity_type": null,
                            "data": {},
                            "created_at": "2026-11-02T12:18:15.082Z",
                            "updated_at": "2026-11-02T12:18:15.082Z"
                          }
                        ]
                      },
                      {
                        "id": "502689298726782869",
                        "administration_id": 123,
                        "reference": "Deprecations",
                        "date": "2026-11-02",
                        "journal_type": null,
                        "created_at": "2026-11-02T12:18:15.049Z",
                        "updated_at": "2026-11-02T12:18:15.049Z",
                        "version": 1793621895,
                        "general_journal_document_entries": [
                          {
                            "id": "502689298727831446",
                            "administration_id": 123,
                            "ledger_account_id": "502689298716297108",
                            "project_id": null,
                            "contact_id": null,
                            "debit": "100.0",
                            "credit": "0.0",
                            "row_order": 1,
                            "created_at": "2026-11-02T12:18:15.050Z",
                            "updated_at": "2026-11-02T12:18:15.050Z",
                            "description": "First"
                          },
                          {
                            "id": "502689298728880023",
                            "administration_id": 123,
                            "ledger_account_id": "502689298716297108",
                            "project_id": null,
                            "contact_id": null,
                            "debit": "0.0",
                            "credit": "100.0",
                            "row_order": 2,
                            "created_at": "2026-11-02T12:18:15.051Z",
                            "updated_at": "2026-11-02T12:18:15.051Z",
                            "description": "Second"
                          },
                          {
                            "id": "502689298729928600",
                            "administration_id": 123,
                            "ledger_account_id": "502689298716297108",
                            "project_id": null,
                            "contact_id": null,
                            "debit": "50.0",
                            "credit": "0.0",
                            "row_order": 3,
                            "created_at": "2026-11-02T12:18:15.051Z",
                            "updated_at": "2026-11-02T12:18:15.051Z",
                            "description": "Third"
                          },
                          {
                            "id": "502689298729928601",
                            "administration_id": 123,
                            "ledger_account_id": "502689298716297108",
                            "project_id": null,
                            "contact_id": null,
                            "debit": "0.0",
                            "credit": "50.0",
                            "row_order": 4,
                            "created_at": "2026-11-02T12:18:15.052Z",
                            "updated_at": "2026-11-02T12:18:15.052Z",
                            "description": "Fourth"
                          }
                        ],
                        "notes": [],
                        "attachments": [],
                        "events": [
                          {
                            "administration_id": 123,
                            "user_id": "502689108256097381",
                            "action": "document_saved",
                            "link_entity_id": null,
                            "link_entity_type": null,
                            "data": {},
                            "created_at": "2026-11-02T12:18:15.053Z",
                            "updated_at": "2026-11-02T12:18:15.053Z"
                          }
                        ]
                      }
                    ]
                  }
                }
              }
            }
          },
          "400": {
            "description": "Bad request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/symbolic_error"
                },
                "examples": {
                  "ReturnsAnErrorWhenTooManyGeneralJournalDocumentsAreRequested": {
                    "summary": "Returns an error when too many general journal documents are requested",
                    "value": {
                      "error": "Per Page is too big",
                      "symbolic": {
                        "per_page": "max"
                      }
                    }
                  }
                }
              }
            }
          }
        },
        "operationId": "get_administration_id_documents_general_journal_documents"
      },
      "post": {
        "summary": "Create a new general journal document",
        "description": "Creates a new general journal document.\n\n### Required scope(s)\n `documents`",
        "tags": [
          "Documents: General journal documents"
        ],
        "security": [
          {
            "bearerAuth": [
              "documents"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/administration_id"
          },
          {
            "$ref": "#/components/parameters/format"
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/*": {
              "schema": {
                "unevaluatedProperties": false,
                "type": "object",
                "properties": {
                  "general_journal_document": {
                    "type": "object",
                    "unevaluatedProperties": false,
                    "properties": {
                      "reference": {
                        "type": "string"
                      },
                      "date": {
                        "type": "string",
                        "format": "date",
                        "description": "Date of the journal entry. Defaults to today."
                      },
                      "journal_type": {
                        "type": "string",
                        "enum": [
                          "fiscal_year_ending"
                        ],
                        "description": "The only journal type is `fiscal_year_ending`, for the entry that closes a fiscal year. Leave it out for a normal journal entry."
                      },
                      "general_journal_document_entries_attributes": {
                        "oneOf": [
                          {
                            "type": "array",
                            "items": {
                              "type": "object",
                              "unevaluatedProperties": false,
                              "properties": {
                                "id": {
                                  "type": "integer"
                                },
                                "ledger_account_id": {
                                  "$ref": "#/components/schemas/identifier",
                                  "description": "Should be a valid ledger account id."
                                },
                                "tax_rate_id": {
                                  "$ref": "#/components/schemas/identifier",
                                  "description": "Should be a valid tax rate id."
                                },
                                "description": {
                                  "type": "string"
                                },
                                "debit": {
                                  "$ref": "#/components/schemas/money"
                                },
                                "credit": {
                                  "$ref": "#/components/schemas/money"
                                },
                                "project_id": {
                                  "$ref": "#/components/schemas/identifier",
                                  "description": "Should be a valid project id."
                                },
                                "row_order": {
                                  "type": "integer"
                                },
                                "_destroy": {
                                  "type": [
                                    "boolean",
                                    "string"
                                  ]
                                },
                                "contact_id": {
                                  "$ref": "#/components/schemas/identifier",
                                  "description": "Should be a valid contact id."
                                }
                              },
                              "required": []
                            }
                          },
                          {
                            "type": "object",
                            "additionalProperties": {
                              "type": "object",
                              "properties": {
                                "id": {
                                  "type": "integer"
                                },
                                "ledger_account_id": {
                                  "$ref": "#/components/schemas/identifier",
                                  "description": "Should be a valid ledger account id."
                                },
                                "tax_rate_id": {
                                  "$ref": "#/components/schemas/identifier",
                                  "description": "Should be a valid tax rate id."
                                },
                                "description": {
                                  "type": "string"
                                },
                                "debit": {
                                  "$ref": "#/components/schemas/money"
                                },
                                "credit": {
                                  "$ref": "#/components/schemas/money"
                                },
                                "project_id": {
                                  "$ref": "#/components/schemas/identifier",
                                  "description": "Should be a valid project id."
                                },
                                "row_order": {
                                  "type": "integer"
                                },
                                "_destroy": {
                                  "type": [
                                    "boolean",
                                    "string"
                                  ]
                                },
                                "contact_id": {
                                  "$ref": "#/components/schemas/identifier",
                                  "description": "Should be a valid contact id."
                                }
                              },
                              "required": []
                            }
                          }
                        ]
                      }
                    },
                    "required": []
                  }
                },
                "required": []
              },
              "examples": {
                "CreatesTheGeneralJournalDocument": {
                  "summary": "Creates the general journal document",
                  "value": {
                    "general_journal_document": {
                      "reference": "foobar",
                      "general_journal_document_entries_attributes": {
                        "0": {
                          "ledger_account_id": 502689299843515800,
                          "debit": 100,
                          "credit": 0
                        },
                        "1": {
                          "ledger_account_id": 502689299883361660,
                          "debit": 0,
                          "credit": 100
                        }
                      }
                    }
                  }
                }
              }
            }
          }
        },
        "responses": {
          "201": {
            "description": "General journal document created",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/general_journal_document_response"
                },
                "examples": {
                  "CreatesTheGeneralJournalDocument": {
                    "summary": "Creates the general journal document",
                    "value": {
                      "id": "502689299902236025",
                      "administration_id": 123,
                      "reference": "foobar",
                      "date": "2026-11-02",
                      "journal_type": null,
                      "created_at": "2026-11-02T12:18:16.169Z",
                      "updated_at": "2026-11-02T12:18:16.169Z",
                      "version": 1793621896,
                      "general_journal_document_entries": [
                        {
                          "id": "502689299903284602",
                          "administration_id": 123,
                          "ledger_account_id": "502689299843515746",
                          "project_id": null,
                          "contact_id": null,
                          "debit": "100.0",
                          "credit": "0.0",
                          "row_order": null,
                          "created_at": "2026-11-02T12:18:16.171Z",
                          "updated_at": "2026-11-02T12:18:16.171Z",
                          "description": null
                        },
                        {
                          "id": "502689299904333179",
                          "administration_id": 123,
                          "ledger_account_id": "502689299883361655",
                          "project_id": null,
                          "contact_id": null,
                          "debit": "0.0",
                          "credit": "100.0",
                          "row_order": null,
                          "created_at": "2026-11-02T12:18:16.171Z",
                          "updated_at": "2026-11-02T12:18:16.171Z",
                          "description": null
                        }
                      ],
                      "notes": [],
                      "attachments": [],
                      "events": [
                        {
                          "administration_id": 123,
                          "user_id": "502689108256097381",
                          "action": "document_saved",
                          "link_entity_id": null,
                          "link_entity_type": null,
                          "data": {},
                          "created_at": "2026-11-02T12:18:16.173Z",
                          "updated_at": "2026-11-02T12:18:16.173Z"
                        }
                      ]
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "Bad request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/symbolic_error"
                },
                "examples": {
                  "RequiresAllInput": {
                    "summary": "Requires all input",
                    "value": {
                      "error": "General Journal Document is required",
                      "symbolic": {
                        "general_journal_document": "required"
                      }
                    }
                  }
                }
              }
            }
          },
          "402": {
            "$ref": "#/components/responses/402_payment_required"
          },
          "422": {
            "$ref": "#/components/responses/422_unprocessable_entity"
          }
        },
        "operationId": "post_administration_id_documents_general_journal_documents"
      }
    },
    "/{administration_id}/documents/purchase_invoices/synchronization{format}": {
      "get": {
        "summary": "List ids and versions of purchase invoices",
        "description": "Returns all documents in the administration. The list contains the document id and the version of the document.\nCheck if the version of the document is newer than the version you have stored locally, use the `POST`\nvariant for fetching documents with the given ids.\n\n### Required scope(s)\n `documents`",
        "tags": [
          "Documents: Purchase invoices"
        ],
        "security": [
          {
            "bearerAuth": [
              "documents"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/administration_id"
          },
          {
            "$ref": "#/components/parameters/format"
          },
          {
            "name": "filter",
            "in": "query",
            "required": false,
            "description": "Comma-separated `key:value` filter terms. Same syntax as `GET /documents/purchase_invoices` — see that operation's description for the available keys.",
            "schema": {
              "type": "string"
            },
            "examples": {
              "RetrievesAllIdsForSynchronizationUsingAFilter": {
                "summary": "Retrieves all ids for synchronization using a filter",
                "value": "period:this_month"
              },
              "RetrievesIdsForSynchronizationUsingAnUpdatedAfterFilter": {
                "summary": "Retrieves ids for synchronization using an updated after filter",
                "value": "updated_after:2026-11-01T12:18:25Z"
              }
            }
          }
        ],
        "responses": {
          "200": {
            "description": "IDs and versions of records",
            "content": {
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "type": "object",
                    "unevaluatedProperties": false,
                    "properties": {
                      "id": {
                        "type": [
                          "integer",
                          "string"
                        ]
                      },
                      "version": {
                        "type": [
                          "integer",
                          "string"
                        ]
                      }
                    }
                  }
                },
                "examples": {
                  "RetrievesAllIdsForSynchronizationUsingAFilter": {
                    "summary": "Retrieves all ids for synchronization using a filter",
                    "value": [
                      {
                        "id": "502689308884337888",
                        "version": 1793621904
                      },
                      {
                        "id": "502689308939912440",
                        "version": 1793621904
                      },
                      {
                        "id": "502689308966126852",
                        "version": 1793621904
                      }
                    ]
                  },
                  "RetrievesAllIdsForSynchronization": {
                    "summary": "Retrieves all ids for synchronization",
                    "value": [
                      {
                        "id": "502689309014361363",
                        "version": 1793621904
                      },
                      {
                        "id": "502689309075178795",
                        "version": 1793621904
                      },
                      {
                        "id": "502689309104538935",
                        "version": 1793621904
                      }
                    ]
                  },
                  "RetrievesIdsForSynchronizationUsingAnUpdatedAfterFilter": {
                    "summary": "Retrieves ids for synchronization using an updated after filter",
                    "value": [
                      {
                        "id": "502689309151724870",
                        "version": 1793621904
                      },
                      {
                        "id": "502689309205202270",
                        "version": 1793621905
                      },
                      {
                        "id": "502689309234562410",
                        "version": 1793621905
                      }
                    ]
                  }
                }
              }
            }
          }
        },
        "operationId": "get_administration_id_documents_purchase_invoices_synchronization"
      },
      "post": {
        "summary": "Fetch purchase invoices with given ids",
        "x-query": true,
        "description": "Given a list of document ids, returns the document information belonging to the documents.\nReturns a maximum of 100 documents, even if more ids are provided.\n\n### Required scope(s)\n `documents`",
        "tags": [
          "Documents: Purchase invoices"
        ],
        "security": [
          {
            "bearerAuth": [
              "documents"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/administration_id"
          },
          {
            "$ref": "#/components/parameters/format"
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/*": {
              "schema": {
                "unevaluatedProperties": false,
                "type": "object",
                "properties": {
                  "ids": {
                    "type": "array",
                    "items": {
                      "type": [
                        "integer",
                        "string"
                      ]
                    }
                  }
                },
                "required": [
                  "ids"
                ]
              },
              "examples": {
                "RetrievesDocumentsForGivenIds": {
                  "summary": "Retrieves documents for given ids",
                  "value": {
                    "ids": [
                      502689309534455230,
                      502689309570106800
                    ]
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "A list of purchase invoices",
            "content": {
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "$ref": "#/components/schemas/purchase_invoice_response"
                  }
                },
                "examples": {
                  "RetrievesDocumentsForGivenIds": {
                    "summary": "Retrieves documents for given ids",
                    "value": [
                      {
                        "id": "502689309534455238",
                        "administration_id": 123,
                        "contact_id": "502689309442180524",
                        "contact": {
                          "id": "502689309442180524",
                          "administration_id": 123,
                          "company_name": "Foobar Holding B.V.",
                          "firstname": null,
                          "lastname": null,
                          "address1": "Hoofdstraat 12",
                          "address2": null,
                          "zipcode": "1234AB",
                          "city": "Amsterdam",
                          "country": "NL",
                          "phone": null,
                          "delivery_method": "Email",
                          "customer_id": "customer-1",
                          "tax_number": null,
                          "chamber_of_commerce": null,
                          "bank_account": null,
                          "is_trusted": false,
                          "max_transfer_amount": null,
                          "attention": null,
                          "email": "info@example.com",
                          "email_ubl": true,
                          "send_invoices_to_attention": null,
                          "send_invoices_to_email": "info@example.com",
                          "send_estimates_to_attention": null,
                          "send_estimates_to_email": "info@example.com",
                          "direct_debit": false,
                          "sepa_active": false,
                          "sepa_iban": null,
                          "sepa_iban_account_name": null,
                          "sepa_bic": null,
                          "sepa_mandate_id": null,
                          "sepa_mandate_date": null,
                          "sepa_sequence_type": "RCUR",
                          "credit_card_number": null,
                          "credit_card_reference": null,
                          "credit_card_type": null,
                          "tax_number_validated_at": null,
                          "tax_number_valid": null,
                          "invoice_workflow_id": null,
                          "estimate_workflow_id": null,
                          "si_identifier": null,
                          "si_identifier_type": null,
                          "moneybird_payments_mandate": false,
                          "created_at": "2026-11-02T12:18:25.267Z",
                          "updated_at": "2026-11-02T12:18:25.267Z",
                          "version": 1793621905,
                          "sales_invoices_url": "https://moneybird.dev/123/sales_invoices/0000000000000000000000000000000000000000000000000000000000000001/all",
                          "notes": [],
                          "custom_fields": [],
                          "contact_people": [],
                          "archived": false
                        },
                        "reference": "2013-01234",
                        "date": "2026-11-02",
                        "due_date": "2026-11-16",
                        "entry_number": 3,
                        "state": "open",
                        "currency": "EUR",
                        "exchange_rate": "1.0",
                        "revenue_invoice": false,
                        "prices_are_incl_tax": false,
                        "origin": null,
                        "paid_at": null,
                        "tax_number": null,
                        "total_price_excl_tax": "300.0",
                        "total_price_excl_tax_base": "300.0",
                        "total_price_incl_tax": "363.0",
                        "total_price_incl_tax_base": "363.0",
                        "created_at": "2026-11-02T12:18:25.356Z",
                        "updated_at": "2026-11-02T12:18:25.359Z",
                        "version": 1793621905,
                        "details": [
                          {
                            "id": "502689309536552391",
                            "administration_id": 123,
                            "tax_rate_id": "502689108908311693",
                            "ledger_account_id": "502689108787725433",
                            "project_id": null,
                            "product_id": null,
                            "amount": null,
                            "amount_decimal": "1.0",
                            "description": "Delivery Apple iPad",
                            "price": "300.0",
                            "period": null,
                            "row_order": 0,
                            "total_price_excl_tax_with_discount": "300.0",
                            "total_price_excl_tax_with_discount_base": "300.0",
                            "tax_report_reference": [
                              "NL/5b"
                            ],
                            "mandatory_tax_text": null,
                            "created_at": "2026-11-02T12:18:25.357Z",
                            "updated_at": "2026-11-02T12:18:25.357Z"
                          }
                        ],
                        "fiscal_allocations": [],
                        "payments": [],
                        "notes": [],
                        "attachments": [],
                        "events": [
                          {
                            "administration_id": 123,
                            "user_id": "502689108256097381",
                            "action": "document_saved",
                            "link_entity_id": null,
                            "link_entity_type": null,
                            "data": {},
                            "created_at": "2026-11-02T12:18:25.361Z",
                            "updated_at": "2026-11-02T12:18:25.361Z"
                          }
                        ]
                      },
                      {
                        "id": "502689309570106834",
                        "administration_id": 123,
                        "contact_id": "502689309442180524",
                        "contact": {
                          "id": "502689309442180524",
                          "administration_id": 123,
                          "company_name": "Foobar Holding B.V.",
                          "firstname": null,
                          "lastname": null,
                          "address1": "Hoofdstraat 12",
                          "address2": null,
                          "zipcode": "1234AB",
                          "city": "Amsterdam",
                          "country": "NL",
                          "phone": null,
                          "delivery_method": "Email",
                          "customer_id": "customer-1",
                          "tax_number": null,
                          "chamber_of_commerce": null,
                          "bank_account": null,
                          "is_trusted": false,
                          "max_transfer_amount": null,
                          "attention": null,
                          "email": "info@example.com",
                          "email_ubl": true,
                          "send_invoices_to_attention": null,
                          "send_invoices_to_email": "info@example.com",
                          "send_estimates_to_attention": null,
                          "send_estimates_to_email": "info@example.com",
                          "direct_debit": false,
                          "sepa_active": false,
                          "sepa_iban": null,
                          "sepa_iban_account_name": null,
                          "sepa_bic": null,
                          "sepa_mandate_id": null,
                          "sepa_mandate_date": null,
                          "sepa_sequence_type": "RCUR",
                          "credit_card_number": null,
                          "credit_card_reference": null,
                          "credit_card_type": null,
                          "tax_number_validated_at": null,
                          "tax_number_valid": null,
                          "invoice_workflow_id": null,
                          "estimate_workflow_id": null,
                          "si_identifier": null,
                          "si_identifier_type": null,
                          "moneybird_payments_mandate": false,
                          "created_at": "2026-11-02T12:18:25.267Z",
                          "updated_at": "2026-11-02T12:18:25.267Z",
                          "version": 1793621905,
                          "sales_invoices_url": "https://moneybird.dev/123/sales_invoices/0000000000000000000000000000000000000000000000000000000000000001/all",
                          "notes": [],
                          "custom_fields": [],
                          "contact_people": [],
                          "archived": false
                        },
                        "reference": "2013-01234",
                        "date": "2026-11-02",
                        "due_date": "2026-11-16",
                        "entry_number": 4,
                        "state": "open",
                        "currency": "EUR",
                        "exchange_rate": "1.0",
                        "revenue_invoice": false,
                        "prices_are_incl_tax": false,
                        "origin": null,
                        "paid_at": null,
                        "tax_number": null,
                        "total_price_excl_tax": "300.0",
                        "total_price_excl_tax_base": "300.0",
                        "total_price_incl_tax": "363.0",
                        "total_price_incl_tax_base": "363.0",
                        "created_at": "2026-11-02T12:18:25.390Z",
                        "updated_at": "2026-11-02T12:18:25.392Z",
                        "version": 1793621905,
                        "details": [
                          {
                            "id": "502689309572203987",
                            "administration_id": 123,
                            "tax_rate_id": "502689108908311693",
                            "ledger_account_id": "502689108787725433",
                            "project_id": null,
                            "product_id": null,
                            "amount": null,
                            "amount_decimal": "1.0",
                            "description": "Delivery Apple iPad",
                            "price": "300.0",
                            "period": null,
                            "row_order": 0,
                            "total_price_excl_tax_with_discount": "300.0",
                            "total_price_excl_tax_with_discount_base": "300.0",
                            "tax_report_reference": [
                              "NL/5b"
                            ],
                            "mandatory_tax_text": null,
                            "created_at": "2026-11-02T12:18:25.391Z",
                            "updated_at": "2026-11-02T12:18:25.391Z"
                          }
                        ],
                        "fiscal_allocations": [],
                        "payments": [],
                        "notes": [],
                        "attachments": [],
                        "events": [
                          {
                            "administration_id": 123,
                            "user_id": "502689108256097381",
                            "action": "document_saved",
                            "link_entity_id": null,
                            "link_entity_type": null,
                            "data": {},
                            "created_at": "2026-11-02T12:18:25.394Z",
                            "updated_at": "2026-11-02T12:18:25.394Z"
                          }
                        ]
                      }
                    ]
                  }
                }
              }
            }
          }
        },
        "operationId": "post_administration_id_documents_purchase_invoices_synchronization"
      }
    },
    "/{administration_id}/documents/purchase_invoices/{id}/attachments/{attachment_id}/download{format}": {
      "get": {
        "summary": "Download attachment",
        "description": "Download the attachment. The response will be a redirect to a temporarily available URL\nwhere the attachment can be downloaded. Use the `Location` header in the response\nto download the attachment.\n\n### Required scope(s)\n `documents`",
        "tags": [
          "Documents: Purchase invoices"
        ],
        "security": [
          {
            "bearerAuth": [
              "documents"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/administration_id"
          },
          {
            "name": "id",
            "in": "path",
            "required": true,
            "schema": {
              "$ref": "#/components/schemas/identifier"
            }
          },
          {
            "name": "attachment_id",
            "in": "path",
            "required": true,
            "schema": {
              "$ref": "#/components/schemas/identifier"
            }
          },
          {
            "$ref": "#/components/parameters/format"
          }
        ],
        "responses": {
          "302": {
            "description": "Found",
            "content": {
              "text/plain": {
                "schema": {
                  "type": "string"
                },
                "examples": {
                  "DownloadsTheAttachment": {
                    "summary": "Downloads the attachment",
                    "value": "{\"message\":\"Use the Location header to download the attachment\"}"
                  }
                }
              }
            }
          },
          "404": {
            "$ref": "#/components/responses/404_not_found"
          }
        },
        "operationId": "get_administration_id_documents_purchase_invoices_id_attachments_attachment_id_download"
      }
    },
    "/{administration_id}/documents/purchase_invoices/{id}/attachments/{attachment_id}{format}": {
      "delete": {
        "summary": "Delete an attachment",
        "description": "Deletes an attachment of an attachable.\n\n### Required scope(s)\n `documents`",
        "tags": [
          "Documents: Purchase invoices"
        ],
        "security": [
          {
            "bearerAuth": [
              "documents"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/administration_id"
          },
          {
            "name": "id",
            "in": "path",
            "required": true,
            "schema": {
              "$ref": "#/components/schemas/identifier"
            }
          },
          {
            "name": "attachment_id",
            "in": "path",
            "required": true,
            "schema": {
              "$ref": "#/components/schemas/identifier"
            }
          },
          {
            "$ref": "#/components/parameters/format"
          }
        ],
        "responses": {
          "204": {
            "description": "Attachment deleted"
          },
          "404": {
            "$ref": "#/components/responses/404_not_found"
          }
        },
        "operationId": "delete_administration_id_documents_purchase_invoices_id_attachments_attachment_id"
      }
    },
    "/{administration_id}/documents/purchase_invoices/{id}/attachments{format}": {
      "post": {
        "summary": "Add attachment to purchase invoice",
        "description": "Add an attachment to a purchase invoice.\n\n### Required scope(s)\n `documents`",
        "tags": [
          "Documents: Purchase invoices"
        ],
        "security": [
          {
            "bearerAuth": [
              "documents"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/administration_id"
          },
          {
            "name": "id",
            "in": "path",
            "required": true,
            "schema": {
              "$ref": "#/components/schemas/identifier"
            }
          },
          {
            "$ref": "#/components/parameters/format"
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "multipart/form-data": {
              "schema": {
                "type": "object",
                "properties": {
                  "file": {
                    "type": "string",
                    "format": "binary"
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Status code",
            "content": {
              "application/json": {
                "schema": {
                  "type": "integer"
                },
                "examples": {
                  "UploadsAnAttachment": {
                    "summary": "Uploads an attachment",
                    "value": 200
                  }
                }
              }
            }
          },
          "400": {
            "$ref": "#/components/responses/400_bad_request"
          },
          "404": {
            "$ref": "#/components/responses/404_not_found"
          },
          "422": {
            "$ref": "#/components/responses/422_unprocessable_entity"
          }
        },
        "operationId": "post_administration_id_documents_purchase_invoices_id_attachments"
      }
    },
    "/{administration_id}/documents/purchase_invoices/{id}/payments/{payment_id}{format}": {
      "delete": {
        "summary": "Delete a payment",
        "description": "Deletes a payment from a purchase invoice.\n\nWhen the payment is linked to a financial mutation, the token also needs the `bank` scope. Such a payment is\nunlinked from the mutation instead and stays on the invoice, unless it was created by linking it to that\nmutation. When the purchase invoice itself was created from that mutation and is still new, the whole purchase\ninvoice is deleted.\n\n### Required scope(s)\n `documents`",
        "tags": [
          "Documents: Purchase invoices"
        ],
        "security": [
          {
            "bearerAuth": [
              "documents"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/administration_id"
          },
          {
            "name": "id",
            "in": "path",
            "required": true,
            "schema": {
              "$ref": "#/components/schemas/identifier"
            }
          },
          {
            "name": "payment_id",
            "in": "path",
            "required": true,
            "schema": {
              "$ref": "#/components/schemas/identifier"
            }
          },
          {
            "$ref": "#/components/parameters/format"
          }
        ],
        "responses": {
          "204": {
            "description": "Payment deleted"
          },
          "404": {
            "$ref": "#/components/responses/404_not_found"
          },
          "422": {
            "$ref": "#/components/responses/422_unprocessable_entity"
          }
        },
        "operationId": "delete_administration_id_documents_purchase_invoices_id_payments_payment_id"
      }
    },
    "/{administration_id}/documents/purchase_invoices/{id}/payments{format}": {
      "post": {
        "summary": "Create a payment",
        "description": "Registers a payment for a purchase invoice.\n\nA `cash_payment` with `financial_account_id` and without `financial_mutation_id` also needs the `bank` scope.\nAn `invoices_settlement` against an (external) sales invoice also needs the `sales_invoices` scope.\n\n### Required scope(s)\n `documents`",
        "tags": [
          "Documents: Purchase invoices"
        ],
        "security": [
          {
            "bearerAuth": [
              "documents"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/administration_id"
          },
          {
            "name": "id",
            "in": "path",
            "required": true,
            "schema": {
              "$ref": "#/components/schemas/identifier"
            }
          },
          {
            "$ref": "#/components/parameters/format"
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/*": {
              "schema": {
                "unevaluatedProperties": false,
                "type": "object",
                "properties": {
                  "payment": {
                    "type": "object",
                    "unevaluatedProperties": false,
                    "properties": {
                      "payment_date": {
                        "type": "string",
                        "description": "The date on which the payment was made."
                      },
                      "price": {
                        "$ref": "#/components/schemas/money",
                        "description": "The amount paid in the document's currency."
                      },
                      "price_base": {
                        "$ref": "#/components/schemas/money",
                        "description": "Amount paid expressed in the base currency of the administration. Required when the document uses a different currency than the administration's base currency."
                      },
                      "financial_account_id": {
                        "$ref": "#/components/schemas/identifier",
                        "description": "The ID of the financial account (bank account or cash register) associated with this payment. Required for `private_payment` and `cash_payment` actions. Should be a valid financial account id."
                      },
                      "financial_mutation_id": {
                        "$ref": "#/components/schemas/identifier",
                        "description": "The ID of the bank transaction to link this payment to. Required for `bank_transfer` actions. Should be a valid financial mutation id."
                      },
                      "transaction_identifier": {
                        "type": "string",
                        "description": "An external transaction reference, e.g. a bank transaction ID or PSP reference. Used to match the payment with financial mutations."
                      },
                      "manual_payment_action": {
                        "type": "string",
                        "description": "Can be `private_payment` (needs financial_account_id), `payment_without_proof`, `cash_payment` (needs financial_account_id), `rounding_error`, `bank_transfer` (needs financial_mutation_id), `balance_settlement` (needs ledger_account_id) or `invoices_settlement` (needs invoice_id). `payment_without_proof` is only accepted when the administration allows payments without proof."
                      },
                      "ledger_account_id": {
                        "$ref": "#/components/schemas/identifier",
                        "description": "The ID of the ledger account to book this payment to. Required for `balance_settlement` actions. Should be a valid ledger account id."
                      },
                      "invoice_id": {
                        "$ref": "#/components/schemas/identifier",
                        "description": "The ID of the document to settle this payment against. Required for `invoices_settlement` actions. Should be a valid document id (sales invoice, purchase invoice, receipt, etc.)."
                      }
                    },
                    "required": [
                      "payment_date",
                      "price"
                    ]
                  }
                },
                "required": []
              },
              "examples": {
                "CreateAPayment": {
                  "summary": "Create a payment",
                  "value": {
                    "payment": {
                      "payment_date": "2026-11-02T12:18:23.175Z",
                      "price": "363.0"
                    }
                  }
                }
              }
            }
          }
        },
        "responses": {
          "201": {
            "description": "Payment created",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/payment_response"
                },
                "examples": {
                  "CreateAPayment": {
                    "summary": "Create a payment",
                    "value": {
                      "id": "502689307259045642",
                      "administration_id": 123,
                      "invoice_type": "Document",
                      "invoice_id": "502689307194033906",
                      "financial_account_id": null,
                      "user_id": "502689108256097381",
                      "payment_transaction_id": null,
                      "transaction_identifier": null,
                      "price": "363.0",
                      "price_base": "363.0",
                      "payment_date": "2026-11-02",
                      "credit_invoice_id": null,
                      "financial_mutation_id": null,
                      "ledger_account_id": "502689108803454082",
                      "linked_payment_id": null,
                      "manual_payment_action": null,
                      "created_at": "2026-11-02T12:18:23.186Z",
                      "updated_at": "2026-11-02T12:18:23.186Z"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "$ref": "#/components/responses/400_bad_request"
          },
          "404": {
            "$ref": "#/components/responses/404_not_found"
          },
          "422": {
            "$ref": "#/components/responses/422_unprocessable_entity"
          }
        },
        "operationId": "post_administration_id_documents_purchase_invoices_id_payments"
      }
    },
    "/{administration_id}/documents/purchase_invoices/{id}/register_payment{format}": {
      "patch": {
        "summary": "Register a payment for a purchase invoice",
        "description": "This endpoint is deprecated and should no longer be used. It has been replaced by `Create a payment`.\n\n### Required scope(s)\n `documents`",
        "deprecated": true,
        "x-sunset": "2026-12-31",
        "tags": [
          "Documents: Purchase invoices"
        ],
        "security": [
          {
            "bearerAuth": [
              "documents"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/administration_id"
          },
          {
            "name": "id",
            "in": "path",
            "required": true,
            "schema": {
              "$ref": "#/components/schemas/identifier"
            }
          },
          {
            "$ref": "#/components/parameters/format"
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/*": {
              "schema": {
                "unevaluatedProperties": false,
                "type": "object",
                "properties": {
                  "payment": {
                    "type": "object",
                    "unevaluatedProperties": false,
                    "properties": {
                      "payment_date": {
                        "type": "string"
                      },
                      "price": {
                        "$ref": "#/components/schemas/money"
                      },
                      "price_base": {
                        "$ref": "#/components/schemas/money",
                        "description": "Amount paid expressed in the base currency. Required for foreign currencies."
                      },
                      "financial_account_id": {
                        "$ref": "#/components/schemas/identifier",
                        "description": "Should be a valid financial account id."
                      },
                      "financial_mutation_id": {
                        "$ref": "#/components/schemas/identifier",
                        "description": "Should be a valid financial mutation id."
                      },
                      "transaction_identifier": {
                        "type": "string"
                      },
                      "manual_payment_action": {
                        "type": "string",
                        "description": "Can be `private_payment`, `payment_without_proof`, `cash_payment`, `rounding_error`, `bank_transfer`, `balance_settlement` or `invoices_settlement`."
                      },
                      "ledger_account_id": {
                        "$ref": "#/components/schemas/identifier",
                        "description": "Should be a valid ledger account id."
                      },
                      "invoice_id": {
                        "$ref": "#/components/schemas/identifier"
                      }
                    },
                    "required": [
                      "payment_date",
                      "price"
                    ]
                  }
                },
                "required": []
              },
              "examples": {
                "CreateAPayment": {
                  "summary": "Create a payment",
                  "value": {
                    "payment": {
                      "payment_date": "2026-11-02T12:18:27.405Z",
                      "price": "363.0"
                    }
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Status code",
            "content": {
              "application/json": {
                "schema": {
                  "type": "integer"
                },
                "examples": {
                  "CreateAPayment": {
                    "summary": "Create a payment",
                    "value": 200
                  }
                }
              }
            }
          },
          "400": {
            "$ref": "#/components/responses/400_bad_request"
          },
          "404": {
            "$ref": "#/components/responses/404_not_found"
          }
        },
        "operationId": "patch_administration_id_documents_purchase_invoices_id_register_payment"
      }
    },
    "/{administration_id}/documents/purchase_invoices/{id}{format}": {
      "get": {
        "summary": "Get purchase invoice",
        "description": "Returns a purchase invoice by id.\n\n### Required scope(s)\n `documents`",
        "tags": [
          "Documents: Purchase invoices"
        ],
        "security": [
          {
            "bearerAuth": [
              "documents"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/administration_id"
          },
          {
            "name": "id",
            "in": "path",
            "required": true,
            "schema": {
              "$ref": "#/components/schemas/identifier"
            }
          },
          {
            "$ref": "#/components/parameters/format"
          }
        ],
        "responses": {
          "200": {
            "description": "A purchase invoice",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/purchase_invoice_response"
                },
                "examples": {
                  "ReturnsTheWantedPurchaseInvoice": {
                    "summary": "Returns the wanted purchase invoice",
                    "value": {
                      "id": "502689308686156970",
                      "administration_id": 123,
                      "contact_id": "502689308665185448",
                      "contact": {
                        "id": "502689308665185448",
                        "administration_id": 123,
                        "company_name": "Foobar Holding B.V.",
                        "firstname": null,
                        "lastname": null,
                        "address1": "Hoofdstraat 12",
                        "address2": null,
                        "zipcode": "1234AB",
                        "city": "Amsterdam",
                        "country": "NL",
                        "phone": null,
                        "delivery_method": "Email",
                        "customer_id": "customer-1",
                        "tax_number": null,
                        "chamber_of_commerce": null,
                        "bank_account": null,
                        "is_trusted": false,
                        "max_transfer_amount": null,
                        "attention": null,
                        "email": "info@example.com",
                        "email_ubl": true,
                        "send_invoices_to_attention": null,
                        "send_invoices_to_email": "info@example.com",
                        "send_estimates_to_attention": null,
                        "send_estimates_to_email": "info@example.com",
                        "direct_debit": false,
                        "sepa_active": false,
                        "sepa_iban": null,
                        "sepa_iban_account_name": null,
                        "sepa_bic": null,
                        "sepa_mandate_id": null,
                        "sepa_mandate_date": null,
                        "sepa_sequence_type": "RCUR",
                        "credit_card_number": null,
                        "credit_card_reference": null,
                        "credit_card_type": null,
                        "tax_number_validated_at": null,
                        "tax_number_valid": null,
                        "invoice_workflow_id": null,
                        "estimate_workflow_id": null,
                        "si_identifier": null,
                        "si_identifier_type": null,
                        "moneybird_payments_mandate": false,
                        "created_at": "2026-11-02T12:18:24.526Z",
                        "updated_at": "2026-11-02T12:18:24.526Z",
                        "version": 1793621904,
                        "sales_invoices_url": "https://moneybird.dev/123/sales_invoices/0000000000000000000000000000000000000000000000000000000000000001/all",
                        "notes": [],
                        "custom_fields": [],
                        "contact_people": [],
                        "archived": false
                      },
                      "reference": "2013-01234",
                      "date": "2026-11-02",
                      "due_date": "2026-11-16",
                      "entry_number": 1,
                      "state": "open",
                      "currency": "EUR",
                      "exchange_rate": "1.0",
                      "revenue_invoice": false,
                      "prices_are_incl_tax": false,
                      "origin": null,
                      "paid_at": null,
                      "tax_number": null,
                      "total_price_excl_tax": "300.0",
                      "total_price_excl_tax_base": "300.0",
                      "total_price_incl_tax": "363.0",
                      "total_price_incl_tax_base": "363.0",
                      "created_at": "2026-11-02T12:18:24.546Z",
                      "updated_at": "2026-11-02T12:18:24.549Z",
                      "version": 1793621904,
                      "details": [
                        {
                          "id": "502689308687205547",
                          "administration_id": 123,
                          "tax_rate_id": "502689108908311693",
                          "ledger_account_id": "502689108787725433",
                          "project_id": null,
                          "product_id": null,
                          "amount": null,
                          "amount_decimal": "1.0",
                          "description": "Delivery Apple iPad",
                          "price": "300.0",
                          "period": null,
                          "row_order": 0,
                          "total_price_excl_tax_with_discount": "300.0",
                          "total_price_excl_tax_with_discount_base": "300.0",
                          "tax_report_reference": [
                            "NL/5b"
                          ],
                          "mandatory_tax_text": null,
                          "created_at": "2026-11-02T12:18:24.547Z",
                          "updated_at": "2026-11-02T12:18:24.547Z"
                        }
                      ],
                      "fiscal_allocations": [],
                      "payments": [],
                      "notes": [],
                      "attachments": [],
                      "events": [
                        {
                          "administration_id": 123,
                          "user_id": "502689108256097381",
                          "action": "document_saved",
                          "link_entity_id": null,
                          "link_entity_type": null,
                          "data": {},
                          "created_at": "2026-11-02T12:18:24.551Z",
                          "updated_at": "2026-11-02T12:18:24.551Z"
                        }
                      ]
                    }
                  },
                  "IncludesFiscalAllocations": {
                    "summary": "Includes fiscal allocations",
                    "value": {
                      "id": "502689312601539720",
                      "administration_id": 123,
                      "contact_id": "502689312528139374",
                      "contact": {
                        "id": "502689312528139374",
                        "administration_id": 123,
                        "company_name": "Foobar Holding B.V.",
                        "firstname": null,
                        "lastname": null,
                        "address1": "Hoofdstraat 12",
                        "address2": null,
                        "zipcode": "1234AB",
                        "city": "Amsterdam",
                        "country": "NL",
                        "phone": null,
                        "delivery_method": "Email",
                        "customer_id": "customer-1",
                        "tax_number": null,
                        "chamber_of_commerce": null,
                        "bank_account": null,
                        "is_trusted": false,
                        "max_transfer_amount": null,
                        "attention": null,
                        "email": "info@example.com",
                        "email_ubl": true,
                        "send_invoices_to_attention": null,
                        "send_invoices_to_email": "info@example.com",
                        "send_estimates_to_attention": null,
                        "send_estimates_to_email": "info@example.com",
                        "direct_debit": false,
                        "sepa_active": false,
                        "sepa_iban": null,
                        "sepa_iban_account_name": null,
                        "sepa_bic": null,
                        "sepa_mandate_id": null,
                        "sepa_mandate_date": null,
                        "sepa_sequence_type": "RCUR",
                        "credit_card_number": null,
                        "credit_card_reference": null,
                        "credit_card_type": null,
                        "tax_number_validated_at": null,
                        "tax_number_valid": null,
                        "invoice_workflow_id": null,
                        "estimate_workflow_id": null,
                        "si_identifier": null,
                        "si_identifier_type": null,
                        "moneybird_payments_mandate": false,
                        "created_at": "2026-11-02T12:18:28.210Z",
                        "updated_at": "2026-11-02T12:18:28.210Z",
                        "version": 1793621908,
                        "sales_invoices_url": "https://moneybird.dev/123/sales_invoices/0000000000000000000000000000000000000000000000000000000000000001/all",
                        "notes": [],
                        "custom_fields": [],
                        "contact_people": [],
                        "archived": false
                      },
                      "reference": "2013-01234",
                      "date": "2026-11-02",
                      "due_date": "2026-11-16",
                      "entry_number": 3,
                      "state": "open",
                      "currency": "EUR",
                      "exchange_rate": "1.0",
                      "revenue_invoice": false,
                      "prices_are_incl_tax": false,
                      "origin": null,
                      "paid_at": null,
                      "tax_number": null,
                      "total_price_excl_tax": "300.0",
                      "total_price_excl_tax_base": "300.0",
                      "total_price_incl_tax": "363.0",
                      "total_price_incl_tax_base": "363.0",
                      "created_at": "2026-11-02T12:18:28.280Z",
                      "updated_at": "2026-11-02T12:18:28.283Z",
                      "version": 1793621908,
                      "details": [
                        {
                          "id": "502689312603636873",
                          "administration_id": 123,
                          "tax_rate_id": "502689108908311693",
                          "ledger_account_id": "502689108787725433",
                          "project_id": null,
                          "product_id": null,
                          "amount": null,
                          "amount_decimal": "1.0",
                          "description": "Delivery Apple iPad",
                          "price": "300.0",
                          "period": null,
                          "row_order": 0,
                          "total_price_excl_tax_with_discount": "300.0",
                          "total_price_excl_tax_with_discount_base": "300.0",
                          "tax_report_reference": [
                            "NL/5b"
                          ],
                          "mandatory_tax_text": null,
                          "created_at": "2026-11-02T12:18:28.282Z",
                          "updated_at": "2026-11-02T12:18:28.282Z"
                        }
                      ],
                      "fiscal_allocations": [
                        {
                          "id": "502689312621462677",
                          "administration_id": 123,
                          "ledger_account_id": "502689108787725433",
                          "private_ledger_account_id": "502689312618316948",
                          "percentage": "25.0",
                          "price": "90.75",
                          "price_base": "90.75",
                          "created_at": "2026-11-02T12:18:28.300Z",
                          "updated_at": "2026-11-02T12:18:28.300Z"
                        }
                      ],
                      "payments": [],
                      "notes": [],
                      "attachments": [],
                      "events": [
                        {
                          "administration_id": 123,
                          "user_id": "502689108256097381",
                          "action": "document_saved",
                          "link_entity_id": null,
                          "link_entity_type": null,
                          "data": {},
                          "created_at": "2026-11-02T12:18:28.285Z",
                          "updated_at": "2026-11-02T12:18:28.285Z"
                        }
                      ]
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Not found",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/symbolic_error"
                },
                "examples": {
                  "OnlyReturnsPurchaseInvoices": {
                    "summary": "Only returns purchase invoices",
                    "value": {
                      "error": "Record not found for model name: Purchase invoice"
                    }
                  }
                }
              }
            }
          }
        },
        "operationId": "get_administration_id_documents_purchase_invoices_id"
      },
      "delete": {
        "summary": "Delete a purchase invoices",
        "description": "Deletes a purchase invoice.\n\n### Required scope(s)\n `documents`",
        "tags": [
          "Documents: Purchase invoices"
        ],
        "security": [
          {
            "bearerAuth": [
              "documents"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/administration_id"
          },
          {
            "name": "id",
            "in": "path",
            "required": true,
            "schema": {
              "$ref": "#/components/schemas/identifier"
            }
          },
          {
            "$ref": "#/components/parameters/format"
          }
        ],
        "responses": {
          "200": {
            "description": "Status code",
            "content": {
              "application/json": {
                "schema": {
                  "type": "integer"
                },
                "examples": {
                  "DeletesThePurchaseInvoice": {
                    "summary": "Deletes the purchase invoice",
                    "value": 200
                  }
                }
              }
            }
          },
          "404": {
            "$ref": "#/components/responses/404_not_found"
          },
          "422": {
            "$ref": "#/components/responses/422_unprocessable_entity"
          }
        },
        "operationId": "delete_administration_id_documents_purchase_invoices_id"
      },
      "patch": {
        "summary": "Update purchase invoice",
        "description": "Updates a purchase invoice.\n\n### Required scope(s)\n `documents`",
        "tags": [
          "Documents: Purchase invoices"
        ],
        "security": [
          {
            "bearerAuth": [
              "documents"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/administration_id"
          },
          {
            "name": "id",
            "in": "path",
            "required": true,
            "schema": {
              "$ref": "#/components/schemas/identifier"
            }
          },
          {
            "$ref": "#/components/parameters/format"
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/*": {
              "schema": {
                "unevaluatedProperties": false,
                "type": "object",
                "properties": {
                  "purchase_invoice": {
                    "type": "object",
                    "unevaluatedProperties": false,
                    "properties": {
                      "contact_id": {
                        "$ref": "#/components/schemas/identifier",
                        "description": "Should be a valid contact id."
                      },
                      "reference": {
                        "type": "string",
                        "description": "The supplier's invoice number or reference."
                      },
                      "date": {
                        "type": "string",
                        "description": "The date on the supplier's invoice.",
                        "format": "date"
                      },
                      "due_date": {
                        "type": "string",
                        "description": "The date by which the invoice should be paid.",
                        "format": "date"
                      },
                      "currency": {
                        "type": "string",
                        "description": "ISO three-character currency code, e.g. EUR or USD."
                      },
                      "prices_are_incl_tax": {
                        "type": [
                          "boolean",
                          "string"
                        ],
                        "description": "Whether the prices on the purchase invoice are inclusive of tax."
                      },
                      "revenue_invoice": {
                        "type": [
                          "boolean",
                          "string"
                        ],
                        "description": "When `true`, this purchase invoice is treated as a revenue invoice (e.g. a credit note from a supplier)."
                      },
                      "details_attributes": {
                        "$ref": "#/components/schemas/details_attributes"
                      },
                      "fiscal_allocations_attributes": {
                        "$ref": "#/components/schemas/fiscal_allocations_attributes"
                      }
                    },
                    "required": []
                  }
                },
                "required": []
              },
              "examples": {
                "UpdatesThePurchaseInvoice": {
                  "summary": "Updates the purchase invoice",
                  "value": {
                    "purchase_invoice": {
                      "reference": "updated reference"
                    }
                  }
                },
                "UpdatesInvoiceDetails": {
                  "summary": "Updates invoice details",
                  "value": {
                    "purchase_invoice": {
                      "details_attributes": {
                        "0": {
                          "description": "New detail",
                          "price": 99,
                          "amount": 1,
                          "tax_rate_id": 502689108908311700,
                          "ledger_account_id": 502689108787725440
                        },
                        "1": {
                          "id": 502689306850100860,
                          "_destroy": true
                        }
                      }
                    }
                  }
                },
                "RemovesAFiscalAllocationWithDestroy": {
                  "summary": "Removes a fiscal allocation with  destroy",
                  "value": {
                    "purchase_invoice": {
                      "fiscal_allocations_attributes": {
                        "0": {
                          "id": 502689312272286700,
                          "_destroy": true
                        }
                      }
                    }
                  }
                },
                "AddsFiscalAllocationsToAnExistingDocument": {
                  "summary": "Adds fiscal allocations to an existing document",
                  "value": {
                    "purchase_invoice": {
                      "fiscal_allocations_attributes": [
                        {
                          "ledger_account_id": 502689108787725440,
                          "private_ledger_account_id": 502689312462079040,
                          "percentage": "40"
                        }
                      ]
                    }
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Purchase invoice updated",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/purchase_invoice_response"
                },
                "examples": {
                  "UpdatesThePurchaseInvoice": {
                    "summary": "Updates the purchase invoice",
                    "value": {
                      "id": "502689306424378867",
                      "administration_id": 123,
                      "contact_id": "502689306407601649",
                      "contact": {
                        "id": "502689306407601649",
                        "administration_id": 123,
                        "company_name": "Foobar Holding B.V.",
                        "firstname": null,
                        "lastname": null,
                        "address1": "Hoofdstraat 12",
                        "address2": null,
                        "zipcode": "1234AB",
                        "city": "Amsterdam",
                        "country": "NL",
                        "phone": null,
                        "delivery_method": "Email",
                        "customer_id": "customer-1",
                        "tax_number": null,
                        "chamber_of_commerce": null,
                        "bank_account": null,
                        "is_trusted": false,
                        "max_transfer_amount": null,
                        "attention": null,
                        "email": "info@example.com",
                        "email_ubl": true,
                        "send_invoices_to_attention": null,
                        "send_invoices_to_email": "info@example.com",
                        "send_estimates_to_attention": null,
                        "send_estimates_to_email": "info@example.com",
                        "direct_debit": false,
                        "sepa_active": false,
                        "sepa_iban": null,
                        "sepa_iban_account_name": null,
                        "sepa_bic": null,
                        "sepa_mandate_id": null,
                        "sepa_mandate_date": null,
                        "sepa_sequence_type": "RCUR",
                        "credit_card_number": null,
                        "credit_card_reference": null,
                        "credit_card_type": null,
                        "tax_number_validated_at": null,
                        "tax_number_valid": null,
                        "invoice_workflow_id": null,
                        "estimate_workflow_id": null,
                        "si_identifier": null,
                        "si_identifier_type": null,
                        "moneybird_payments_mandate": false,
                        "created_at": "2026-11-02T12:18:22.374Z",
                        "updated_at": "2026-11-02T12:18:22.374Z",
                        "version": 1793621902,
                        "sales_invoices_url": "https://moneybird.dev/123/sales_invoices/0000000000000000000000000000000000000000000000000000000000000001/all",
                        "notes": [],
                        "custom_fields": [],
                        "contact_people": [],
                        "archived": false
                      },
                      "reference": "updated reference",
                      "date": "2026-11-02",
                      "due_date": "2026-11-16",
                      "entry_number": 1,
                      "state": "open",
                      "currency": "EUR",
                      "exchange_rate": "1.0",
                      "revenue_invoice": false,
                      "prices_are_incl_tax": false,
                      "origin": null,
                      "paid_at": null,
                      "tax_number": null,
                      "total_price_excl_tax": "300.0",
                      "total_price_excl_tax_base": "300.0",
                      "total_price_incl_tax": "363.0",
                      "total_price_incl_tax_base": "363.0",
                      "created_at": "2026-11-02T12:18:22.389Z",
                      "updated_at": "2026-11-02T12:18:22.438Z",
                      "version": 1793621902,
                      "details": [
                        {
                          "id": "502689306425427444",
                          "administration_id": 123,
                          "tax_rate_id": "502689108908311693",
                          "ledger_account_id": "502689108787725433",
                          "project_id": null,
                          "product_id": null,
                          "amount": null,
                          "amount_decimal": "1.0",
                          "description": "Delivery Apple iPad",
                          "price": "300.0",
                          "period": null,
                          "row_order": 0,
                          "total_price_excl_tax_with_discount": "300.0",
                          "total_price_excl_tax_with_discount_base": "300.0",
                          "tax_report_reference": [
                            "NL/5b"
                          ],
                          "mandatory_tax_text": null,
                          "created_at": "2026-11-02T12:18:22.391Z",
                          "updated_at": "2026-11-02T12:18:22.391Z"
                        }
                      ],
                      "fiscal_allocations": [],
                      "payments": [],
                      "notes": [],
                      "attachments": [],
                      "events": [
                        {
                          "administration_id": 123,
                          "user_id": "502689108256097381",
                          "action": "document_saved",
                          "link_entity_id": null,
                          "link_entity_type": null,
                          "data": {},
                          "created_at": "2026-11-02T12:18:22.393Z",
                          "updated_at": "2026-11-02T12:18:22.393Z"
                        },
                        {
                          "administration_id": 123,
                          "user_id": "502689108256097381",
                          "action": "document_updated",
                          "link_entity_id": null,
                          "link_entity_type": null,
                          "data": {
                            "changes": {
                              "reference": [
                                "2013-01234",
                                "updated reference"
                              ],
                              "updated_at": [
                                "2026-11-02T13:18:22.392+01:00",
                                "2026-11-02T13:18:22.438+01:00"
                              ]
                            }
                          },
                          "created_at": "2026-11-02T12:18:22.441Z",
                          "updated_at": "2026-11-02T12:18:22.441Z"
                        }
                      ]
                    }
                  },
                  "UpdatesInvoiceDetails": {
                    "summary": "Updates invoice details",
                    "value": {
                      "id": "502689306848003725",
                      "administration_id": 123,
                      "contact_id": "502689306822837899",
                      "contact": {
                        "id": "502689306822837899",
                        "administration_id": 123,
                        "company_name": "Foobar Holding B.V.",
                        "firstname": null,
                        "lastname": null,
                        "address1": "Hoofdstraat 12",
                        "address2": null,
                        "zipcode": "1234AB",
                        "city": "Amsterdam",
                        "country": "NL",
                        "phone": null,
                        "delivery_method": "Email",
                        "customer_id": "customer-1",
                        "tax_number": null,
                        "chamber_of_commerce": null,
                        "bank_account": null,
                        "is_trusted": false,
                        "max_transfer_amount": null,
                        "attention": null,
                        "email": "info@example.com",
                        "email_ubl": true,
                        "send_invoices_to_attention": null,
                        "send_invoices_to_email": "info@example.com",
                        "send_estimates_to_attention": null,
                        "send_estimates_to_email": "info@example.com",
                        "direct_debit": false,
                        "sepa_active": false,
                        "sepa_iban": null,
                        "sepa_iban_account_name": null,
                        "sepa_bic": null,
                        "sepa_mandate_id": null,
                        "sepa_mandate_date": null,
                        "sepa_sequence_type": "RCUR",
                        "credit_card_number": null,
                        "credit_card_reference": null,
                        "credit_card_type": null,
                        "tax_number_validated_at": null,
                        "tax_number_valid": null,
                        "invoice_workflow_id": null,
                        "estimate_workflow_id": null,
                        "si_identifier": null,
                        "si_identifier_type": null,
                        "moneybird_payments_mandate": false,
                        "created_at": "2026-11-02T12:18:22.769Z",
                        "updated_at": "2026-11-02T12:18:22.769Z",
                        "version": 1793621902,
                        "sales_invoices_url": "https://moneybird.dev/123/sales_invoices/0000000000000000000000000000000000000000000000000000000000000001/all",
                        "notes": [],
                        "custom_fields": [],
                        "contact_people": [],
                        "archived": false
                      },
                      "reference": "2013-01234",
                      "date": "2026-11-02",
                      "due_date": "2026-11-16",
                      "entry_number": 1,
                      "state": "open",
                      "currency": "EUR",
                      "exchange_rate": "1.0",
                      "revenue_invoice": false,
                      "prices_are_incl_tax": false,
                      "origin": null,
                      "paid_at": null,
                      "tax_number": null,
                      "total_price_excl_tax": "99.0",
                      "total_price_excl_tax_base": "99.0",
                      "total_price_incl_tax": "119.79",
                      "total_price_incl_tax_base": "119.79",
                      "created_at": "2026-11-02T12:18:22.794Z",
                      "updated_at": "2026-11-02T12:18:22.868Z",
                      "version": 1793621902,
                      "details": [
                        {
                          "id": "502689306924549797",
                          "administration_id": 123,
                          "tax_rate_id": "502689108908311693",
                          "ledger_account_id": "502689108787725433",
                          "project_id": null,
                          "product_id": null,
                          "amount": "1",
                          "amount_decimal": "1.0",
                          "description": "New detail",
                          "price": "99.0",
                          "period": null,
                          "row_order": 0,
                          "total_price_excl_tax_with_discount": "99.0",
                          "total_price_excl_tax_with_discount_base": "99.0",
                          "tax_report_reference": [
                            "NL/5b"
                          ],
                          "mandatory_tax_text": null,
                          "created_at": "2026-11-02T12:18:22.866Z",
                          "updated_at": "2026-11-02T12:18:22.866Z"
                        }
                      ],
                      "fiscal_allocations": [],
                      "payments": [],
                      "notes": [],
                      "attachments": [],
                      "events": [
                        {
                          "administration_id": 123,
                          "user_id": "502689108256097381",
                          "action": "document_saved",
                          "link_entity_id": null,
                          "link_entity_type": null,
                          "data": {},
                          "created_at": "2026-11-02T12:18:22.799Z",
                          "updated_at": "2026-11-02T12:18:22.799Z"
                        },
                        {
                          "administration_id": 123,
                          "user_id": "502689108256097381",
                          "action": "document_updated",
                          "link_entity_id": null,
                          "link_entity_type": null,
                          "data": {
                            "changes": {
                              "total_price_excl_tax": [
                                "300.0",
                                "99.0"
                              ],
                              "total_price_excl_tax_base": [
                                "300.0",
                                "99.0"
                              ],
                              "total_price_incl_tax": [
                                "363.0",
                                "119.79"
                              ],
                              "total_price_incl_tax_base": [
                                "363.0",
                                "119.79"
                              ],
                              "cached_taxes": [
                                [
                                  {
                                    "tax_rate_id": "502689108908311693",
                                    "report_reference": "NL/5b",
                                    "payable": false,
                                    "debit": "63.0",
                                    "credit": 0
                                  }
                                ],
                                [
                                  {
                                    "tax_rate_id": "502689108908311693",
                                    "report_reference": "NL/5b",
                                    "payable": false,
                                    "debit": "20.79",
                                    "credit": 0
                                  }
                                ]
                              ],
                              "updated_at": [
                                "2026-11-02T13:18:22.797+01:00",
                                "2026-11-02T13:18:22.861+01:00"
                              ]
                            },
                            "detail_changes": [
                              {
                                "id": "502689306850100878",
                                "change": "removed",
                                "ledger_account_id": [
                                  "502689108787725433",
                                  null
                                ],
                                "tax_rate_id": [
                                  "502689108908311693",
                                  null
                                ],
                                "description": [
                                  "Delivery Apple iPad",
                                  null
                                ],
                                "price": [
                                  "300.0",
                                  null
                                ],
                                "amount": [
                                  "",
                                  null
                                ]
                              },
                              {
                                "id": "502689306924549797",
                                "change": "added",
                                "ledger_account_id": [
                                  null,
                                  "502689108787725433"
                                ],
                                "tax_rate_id": [
                                  null,
                                  "502689108908311693"
                                ],
                                "description": [
                                  null,
                                  "New detail"
                                ],
                                "price": [
                                  "0.0",
                                  "99.0"
                                ],
                                "amount": [
                                  "",
                                  "1"
                                ]
                              }
                            ]
                          },
                          "created_at": "2026-11-02T12:18:22.870Z",
                          "updated_at": "2026-11-02T12:18:22.870Z"
                        }
                      ]
                    }
                  },
                  "RemovesAFiscalAllocationWithDestroy": {
                    "summary": "Removes a fiscal allocation with  destroy",
                    "value": {
                      "id": "502689312254460941",
                      "administration_id": 123,
                      "contact_id": "502689312171624435",
                      "contact": {
                        "id": "502689312171624435",
                        "administration_id": 123,
                        "company_name": "Foobar Holding B.V.",
                        "firstname": null,
                        "lastname": null,
                        "address1": "Hoofdstraat 12",
                        "address2": null,
                        "zipcode": "1234AB",
                        "city": "Amsterdam",
                        "country": "NL",
                        "phone": null,
                        "delivery_method": "Email",
                        "customer_id": "customer-1",
                        "tax_number": null,
                        "chamber_of_commerce": null,
                        "bank_account": null,
                        "is_trusted": false,
                        "max_transfer_amount": null,
                        "attention": null,
                        "email": "info@example.com",
                        "email_ubl": true,
                        "send_invoices_to_attention": null,
                        "send_invoices_to_email": "info@example.com",
                        "send_estimates_to_attention": null,
                        "send_estimates_to_email": "info@example.com",
                        "direct_debit": false,
                        "sepa_active": false,
                        "sepa_iban": null,
                        "sepa_iban_account_name": null,
                        "sepa_bic": null,
                        "sepa_mandate_id": null,
                        "sepa_mandate_date": null,
                        "sepa_sequence_type": "RCUR",
                        "credit_card_number": null,
                        "credit_card_reference": null,
                        "credit_card_type": null,
                        "tax_number_validated_at": null,
                        "tax_number_valid": null,
                        "invoice_workflow_id": null,
                        "estimate_workflow_id": null,
                        "si_identifier": null,
                        "si_identifier_type": null,
                        "moneybird_payments_mandate": false,
                        "created_at": "2026-11-02T12:18:27.870Z",
                        "updated_at": "2026-11-02T12:18:27.870Z",
                        "version": 1793621907,
                        "sales_invoices_url": "https://moneybird.dev/123/sales_invoices/0000000000000000000000000000000000000000000000000000000000000001/all",
                        "notes": [],
                        "custom_fields": [],
                        "contact_people": [],
                        "archived": false
                      },
                      "reference": "2013-01234",
                      "date": "2026-11-02",
                      "due_date": "2026-11-16",
                      "entry_number": 3,
                      "state": "open",
                      "currency": "EUR",
                      "exchange_rate": "1.0",
                      "revenue_invoice": false,
                      "prices_are_incl_tax": false,
                      "origin": null,
                      "paid_at": null,
                      "tax_number": null,
                      "total_price_excl_tax": "300.0",
                      "total_price_excl_tax_base": "300.0",
                      "total_price_incl_tax": "363.0",
                      "total_price_incl_tax_base": "363.0",
                      "created_at": "2026-11-02T12:18:27.949Z",
                      "updated_at": "2026-11-02T12:18:27.952Z",
                      "version": 1793621907,
                      "details": [
                        {
                          "id": "502689312255509518",
                          "administration_id": 123,
                          "tax_rate_id": "502689108908311693",
                          "ledger_account_id": "502689108787725433",
                          "project_id": null,
                          "product_id": null,
                          "amount": null,
                          "amount_decimal": "1.0",
                          "description": "Delivery Apple iPad",
                          "price": "300.0",
                          "period": null,
                          "row_order": 0,
                          "total_price_excl_tax_with_discount": "300.0",
                          "total_price_excl_tax_with_discount_base": "300.0",
                          "tax_report_reference": [
                            "NL/5b"
                          ],
                          "mandatory_tax_text": null,
                          "created_at": "2026-11-02T12:18:27.950Z",
                          "updated_at": "2026-11-02T12:18:27.950Z"
                        }
                      ],
                      "fiscal_allocations": [],
                      "payments": [],
                      "notes": [],
                      "attachments": [],
                      "events": [
                        {
                          "administration_id": 123,
                          "user_id": "502689108256097381",
                          "action": "document_saved",
                          "link_entity_id": null,
                          "link_entity_type": null,
                          "data": {},
                          "created_at": "2026-11-02T12:18:27.953Z",
                          "updated_at": "2026-11-02T12:18:27.953Z"
                        },
                        {
                          "administration_id": 123,
                          "user_id": "502689108256097381",
                          "action": "document_updated",
                          "link_entity_id": null,
                          "link_entity_type": null,
                          "data": {
                            "changes": {}
                          },
                          "created_at": "2026-11-02T12:18:27.988Z",
                          "updated_at": "2026-11-02T12:18:27.988Z"
                        }
                      ]
                    }
                  },
                  "AddsFiscalAllocationsToAnExistingDocument": {
                    "summary": "Adds fiscal allocations to an existing document",
                    "value": {
                      "id": "502689312446350409",
                      "administration_id": 123,
                      "contact_id": "502689312338347055",
                      "contact": {
                        "id": "502689312338347055",
                        "administration_id": 123,
                        "company_name": "Foobar Holding B.V.",
                        "firstname": null,
                        "lastname": null,
                        "address1": "Hoofdstraat 12",
                        "address2": null,
                        "zipcode": "1234AB",
                        "city": "Amsterdam",
                        "country": "NL",
                        "phone": null,
                        "delivery_method": "Email",
                        "customer_id": "customer-1",
                        "tax_number": null,
                        "chamber_of_commerce": null,
                        "bank_account": null,
                        "is_trusted": false,
                        "max_transfer_amount": null,
                        "attention": null,
                        "email": "info@example.com",
                        "email_ubl": true,
                        "send_invoices_to_attention": null,
                        "send_invoices_to_email": "info@example.com",
                        "send_estimates_to_attention": null,
                        "send_estimates_to_email": "info@example.com",
                        "direct_debit": false,
                        "sepa_active": false,
                        "sepa_iban": null,
                        "sepa_iban_account_name": null,
                        "sepa_bic": null,
                        "sepa_mandate_id": null,
                        "sepa_mandate_date": null,
                        "sepa_sequence_type": "RCUR",
                        "credit_card_number": null,
                        "credit_card_reference": null,
                        "credit_card_type": null,
                        "tax_number_validated_at": null,
                        "tax_number_valid": null,
                        "invoice_workflow_id": null,
                        "estimate_workflow_id": null,
                        "si_identifier": null,
                        "si_identifier_type": null,
                        "moneybird_payments_mandate": false,
                        "created_at": "2026-11-02T12:18:28.029Z",
                        "updated_at": "2026-11-02T12:18:28.029Z",
                        "version": 1793621908,
                        "sales_invoices_url": "https://moneybird.dev/123/sales_invoices/0000000000000000000000000000000000000000000000000000000000000001/all",
                        "notes": [],
                        "custom_fields": [],
                        "contact_people": [],
                        "archived": false
                      },
                      "reference": "2013-01234",
                      "date": "2026-11-02",
                      "due_date": "2026-11-16",
                      "entry_number": 3,
                      "state": "open",
                      "currency": "EUR",
                      "exchange_rate": "1.0",
                      "revenue_invoice": false,
                      "prices_are_incl_tax": false,
                      "origin": null,
                      "paid_at": null,
                      "tax_number": null,
                      "total_price_excl_tax": "325.2",
                      "total_price_excl_tax_base": "325.2",
                      "total_price_incl_tax": "363.0",
                      "total_price_incl_tax_base": "363.0",
                      "created_at": "2026-11-02T12:18:28.132Z",
                      "updated_at": "2026-11-02T12:18:28.173Z",
                      "version": 1793621908,
                      "details": [
                        {
                          "id": "502689312447398986",
                          "administration_id": 123,
                          "tax_rate_id": "502689108908311693",
                          "ledger_account_id": "502689108787725433",
                          "project_id": null,
                          "product_id": null,
                          "amount": null,
                          "amount_decimal": "1.0",
                          "description": "Delivery Apple iPad",
                          "price": "300.0",
                          "period": null,
                          "row_order": 0,
                          "total_price_excl_tax_with_discount": "180.0",
                          "total_price_excl_tax_with_discount_base": "180.0",
                          "tax_report_reference": [
                            "NL/5b"
                          ],
                          "mandatory_tax_text": null,
                          "created_at": "2026-11-02T12:18:28.134Z",
                          "updated_at": "2026-11-02T12:18:28.172Z"
                        }
                      ],
                      "fiscal_allocations": [
                        {
                          "id": "502689312486196310",
                          "administration_id": 123,
                          "ledger_account_id": "502689108787725433",
                          "private_ledger_account_id": "502689312462079061",
                          "percentage": "40.0",
                          "price": "145.2",
                          "price_base": "145.2",
                          "created_at": "2026-11-02T12:18:28.170Z",
                          "updated_at": "2026-11-02T12:18:28.170Z"
                        }
                      ],
                      "payments": [],
                      "notes": [],
                      "attachments": [],
                      "events": [
                        {
                          "administration_id": 123,
                          "user_id": "502689108256097381",
                          "action": "document_saved",
                          "link_entity_id": null,
                          "link_entity_type": null,
                          "data": {},
                          "created_at": "2026-11-02T12:18:28.136Z",
                          "updated_at": "2026-11-02T12:18:28.136Z"
                        },
                        {
                          "administration_id": 123,
                          "user_id": "502689108256097381",
                          "action": "document_updated",
                          "link_entity_id": null,
                          "link_entity_type": null,
                          "data": {
                            "changes": {
                              "total_price_excl_tax": [
                                "300.0",
                                "325.2"
                              ],
                              "total_price_excl_tax_base": [
                                "300.0",
                                "325.2"
                              ],
                              "cached_taxes": [
                                [
                                  {
                                    "tax_rate_id": "502689108908311693",
                                    "report_reference": "NL/5b",
                                    "payable": false,
                                    "debit": "63.0",
                                    "credit": 0
                                  }
                                ],
                                [
                                  {
                                    "tax_rate_id": "502689108908311693",
                                    "report_reference": "NL/5b",
                                    "payable": false,
                                    "debit": "37.8",
                                    "credit": 0
                                  }
                                ]
                              ],
                              "updated_at": [
                                "2026-11-02T13:18:28.135+01:00",
                                "2026-11-02T13:18:28.169+01:00"
                              ]
                            }
                          },
                          "created_at": "2026-11-02T12:18:28.175Z",
                          "updated_at": "2026-11-02T12:18:28.175Z"
                        }
                      ]
                    }
                  }
                }
              }
            }
          },
          "400": {
            "$ref": "#/components/responses/400_bad_request"
          },
          "404": {
            "$ref": "#/components/responses/404_not_found"
          },
          "422": {
            "$ref": "#/components/responses/422_unprocessable_entity"
          }
        },
        "operationId": "patch_administration_id_documents_purchase_invoices_id"
      }
    },
    "/{administration_id}/documents/purchase_invoices/{purchase_invoice_id}/notes/{id}{format}": {
      "delete": {
        "summary": "Destroys note from entity",
        "description": "Deletes a note from the purchase invoice.\n\n### Required scope(s)\n `documents`",
        "tags": [
          "Documents: Purchase invoices"
        ],
        "security": [
          {
            "bearerAuth": [
              "documents"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/administration_id"
          },
          {
            "name": "purchase_invoice_id",
            "in": "path",
            "required": true,
            "schema": {
              "$ref": "#/components/schemas/identifier"
            }
          },
          {
            "name": "id",
            "in": "path",
            "required": true,
            "schema": {
              "$ref": "#/components/schemas/identifier"
            }
          },
          {
            "$ref": "#/components/parameters/format"
          }
        ],
        "responses": {
          "204": {
            "description": "Note deleted"
          },
          "400": {
            "$ref": "#/components/responses/400_bad_request"
          }
        },
        "operationId": "delete_administration_id_documents_purchase_invoices_purchase_invoice_id_notes_id"
      }
    },
    "/{administration_id}/documents/purchase_invoices/{purchase_invoice_id}/notes{format}": {
      "post": {
        "summary": "Adds note to entity",
        "description": "Adds a note to the purchase invoice.\n\n### Required scope(s)\n `documents`",
        "tags": [
          "Documents: Purchase invoices"
        ],
        "security": [
          {
            "bearerAuth": [
              "documents"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/administration_id"
          },
          {
            "name": "purchase_invoice_id",
            "in": "path",
            "required": true,
            "schema": {
              "$ref": "#/components/schemas/identifier"
            }
          },
          {
            "$ref": "#/components/parameters/format"
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/*": {
              "schema": {
                "unevaluatedProperties": false,
                "type": "object",
                "properties": {
                  "note": {
                    "type": "object",
                    "unevaluatedProperties": false,
                    "properties": {
                      "note": {
                        "type": "string",
                        "description": "**Required**. Text for the note or to-do."
                      },
                      "todo": {
                        "type": [
                          "boolean",
                          "string"
                        ],
                        "description": "If `true` the note is a to-do."
                      },
                      "assignee_id": {
                        "$ref": "#/components/schemas/identifier",
                        "description": "Assign to-do to user. Should be a valid user id. If assignee_id is provided the note will be a to-do."
                      }
                    },
                    "required": []
                  }
                },
                "required": []
              },
              "examples": {
                "CreateANote": {
                  "summary": "Create a note",
                  "value": {
                    "note": {
                      "note": "Text of the note",
                      "assignee_id": 502689306141263200,
                      "todo": true
                    }
                  }
                }
              }
            }
          }
        },
        "responses": {
          "201": {
            "description": "Note created",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/note_response"
                },
                "examples": {
                  "CreateANote": {
                    "summary": "Create a note",
                    "value": {
                      "id": "502689306152797597",
                      "administration_id": 123,
                      "entity_id": "502689306098271619",
                      "entity_type": "Document",
                      "user_id": "502689108256097381",
                      "assignee_id": "502689306141263259",
                      "todo": true,
                      "note": "Text of the note",
                      "completed_at": null,
                      "completed_by_id": null,
                      "todo_type": null,
                      "data": {},
                      "created_at": "2026-11-02T12:18:22.130Z",
                      "updated_at": "2026-11-02T12:18:22.130Z"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "$ref": "#/components/responses/400_bad_request"
          },
          "422": {
            "$ref": "#/components/responses/422_unprocessable_entity"
          }
        },
        "operationId": "post_administration_id_documents_purchase_invoices_purchase_invoice_id_notes"
      }
    },
    "/{administration_id}/documents/purchase_invoices{format}": {
      "get": {
        "summary": "Get purchase invoices",
        "description": "Returns a paginated list of documents of this type in the administration.\n\n### Required scope(s)\n `documents`",
        "tags": [
          "Documents: Purchase invoices"
        ],
        "security": [
          {
            "bearerAuth": [
              "documents"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/administration_id"
          },
          {
            "$ref": "#/components/parameters/format"
          },
          {
            "name": "filter",
            "in": "query",
            "required": false,
            "description": "Filters are `key:value` terms separated by commas (e.g. `period:this_year,state:open`). Any filter you pass replaces the defaults below entirely, so include every key you need. Available filters:\n\n| **Filter** | **Type** | **Default** | **Description** |\n| - | - | - | - |\n| period | `String` | `this_year` | Matches on the document date. A named period (`this_week`, `prev_week`, `next_week`, `this_month`, `prev_month`, `next_month`, `this_quarter`, `prev_quarter`, `next_quarter`, `this_year`, `prev_year`, `next_year`) or a custom range (`201301..201302`, `20130101..20130131`). A custom period must have a start and an end date. It must not be longer than 10 years and must be between `20000101` and `21000101`. For one month, use `202401..202401`, not `202401`. Without `period`, the filter does not limit the dates. The default `this_year` applies only when you send no `filter`. |\n| state | `String` | `all` | `all`, `new`, `saved`, `open`, `paid`, `late` or `pending_payment`. `paid`, `late` and `pending_payment` only apply to documents with a payment lifecycle (purchase invoices and receipts) |\n| recurring | `String` | `all` | `all`, `enabled` or `disabled` |\n| attachment | `String` | `all` | `all`, `with` or `without` |\n| automatic_saving | `String` | `all` | `all`, `automatic` or `manual`. `automatic` matches documents Moneybird saved by itself after analysing them; `manual` matches everything else, including documents nobody has saved yet |\n| reference | `String` | | Documents with the given reference value |\n| contact_id | `Integer` | | Documents belonging to the given contact |\n| ledger_account_id | `Integer` | | Documents booking against the given ledger account |\n| updated_after | `String` | | ISO 8601 timestamp in UTC; documents updated strictly after this time |\n\nThe `period` filter matches on the document date. It does not look at the `period` of the individual details, which says which months the expenses belong to. Read `details[].period` in the response when you need those months, or use the reports endpoints, which already spread the amounts over that period. A detail's period can fall outside the filtered range, however wide you make it, so this filter cannot tell you which periods amounts fall in. Use the reports endpoints for that.\n\nMultiple values for `state`, `recurring` and `attachment` can be combined with a pipe, e.g. `state:open|paid`.",
            "schema": {
              "type": "string",
              "default": "period:this_year"
            },
            "examples": {
              "FiltersOnAutomaticSaving": {
                "summary": "Filters on automatic saving",
                "value": "automatic_saving:automatic"
              },
              "ReturnsTheOldestPurchaseInvoiceFirstWhenSortedByDateAscending": {
                "summary": "Returns the oldest purchase invoice first when sorted by date ascending",
                "value": "period:20251102..20261102"
              }
            }
          },
          {
            "name": "new_filter",
            "in": "query",
            "required": false,
            "schema": {
              "type": "string",
              "description": "String terms, example: `key1:value1,key2:value2`."
            }
          },
          {
            "$ref": "#/components/parameters/page"
          },
          {
            "$ref": "#/components/parameters/sort"
          },
          {
            "$ref": "#/components/parameters/per_page"
          }
        ],
        "responses": {
          "200": {
            "description": "A list of purchase invoices",
            "content": {
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "$ref": "#/components/schemas/purchase_invoice_response"
                  }
                },
                "examples": {
                  "FiltersOnAutomaticSaving": {
                    "summary": "Filters on automatic saving",
                    "value": [
                      {
                        "id": "502689307414234922",
                        "administration_id": 123,
                        "contact_id": "502689307393263400",
                        "contact": {
                          "id": "502689307393263400",
                          "administration_id": 123,
                          "company_name": "Foobar Holding B.V.",
                          "firstname": null,
                          "lastname": null,
                          "address1": "Hoofdstraat 12",
                          "address2": null,
                          "zipcode": "1234AB",
                          "city": "Amsterdam",
                          "country": "NL",
                          "phone": null,
                          "delivery_method": "Email",
                          "customer_id": "customer-1",
                          "tax_number": null,
                          "chamber_of_commerce": null,
                          "bank_account": null,
                          "is_trusted": false,
                          "max_transfer_amount": null,
                          "attention": null,
                          "email": "info@example.com",
                          "email_ubl": true,
                          "send_invoices_to_attention": null,
                          "send_invoices_to_email": "info@example.com",
                          "send_estimates_to_attention": null,
                          "send_estimates_to_email": "info@example.com",
                          "direct_debit": false,
                          "sepa_active": false,
                          "sepa_iban": null,
                          "sepa_iban_account_name": null,
                          "sepa_bic": null,
                          "sepa_mandate_id": null,
                          "sepa_mandate_date": null,
                          "sepa_sequence_type": "RCUR",
                          "credit_card_number": null,
                          "credit_card_reference": null,
                          "credit_card_type": null,
                          "tax_number_validated_at": null,
                          "tax_number_valid": null,
                          "invoice_workflow_id": null,
                          "estimate_workflow_id": null,
                          "si_identifier": null,
                          "si_identifier_type": null,
                          "moneybird_payments_mandate": false,
                          "created_at": "2026-11-02T12:18:23.313Z",
                          "updated_at": "2026-11-02T12:18:23.313Z",
                          "version": 1793621903,
                          "sales_invoices_url": "https://moneybird.dev/123/sales_invoices/0000000000000000000000000000000000000000000000000000000000000001/all",
                          "notes": [],
                          "custom_fields": [],
                          "contact_people": [],
                          "archived": false
                        },
                        "reference": "2013-01234",
                        "date": "2026-11-02",
                        "due_date": "2026-11-16",
                        "entry_number": 1,
                        "state": "open",
                        "currency": "EUR",
                        "exchange_rate": "1.0",
                        "revenue_invoice": false,
                        "prices_are_incl_tax": false,
                        "origin": null,
                        "paid_at": null,
                        "tax_number": null,
                        "total_price_excl_tax": "300.0",
                        "total_price_excl_tax_base": "300.0",
                        "total_price_incl_tax": "363.0",
                        "total_price_incl_tax_base": "363.0",
                        "created_at": "2026-11-02T12:18:23.333Z",
                        "updated_at": "2026-11-02T12:18:23.336Z",
                        "version": 1793621903,
                        "details": [
                          {
                            "id": "502689307415283499",
                            "administration_id": 123,
                            "tax_rate_id": "502689108908311693",
                            "ledger_account_id": "502689108787725433",
                            "project_id": null,
                            "product_id": null,
                            "amount": null,
                            "amount_decimal": "1.0",
                            "description": "Delivery Apple iPad",
                            "price": "300.0",
                            "period": null,
                            "row_order": 0,
                            "total_price_excl_tax_with_discount": "300.0",
                            "total_price_excl_tax_with_discount_base": "300.0",
                            "tax_report_reference": [
                              "NL/5b"
                            ],
                            "mandatory_tax_text": null,
                            "created_at": "2026-11-02T12:18:23.335Z",
                            "updated_at": "2026-11-02T12:18:23.335Z"
                          }
                        ],
                        "fiscal_allocations": [],
                        "payments": [],
                        "notes": [],
                        "attachments": [],
                        "events": [
                          {
                            "administration_id": 123,
                            "user_id": "502689108256097381",
                            "action": "document_saved",
                            "link_entity_id": null,
                            "link_entity_type": null,
                            "data": {},
                            "created_at": "2026-11-02T12:18:23.338Z",
                            "updated_at": "2026-11-02T12:18:23.338Z"
                          },
                          {
                            "administration_id": 123,
                            "user_id": 1,
                            "action": "document_automatically_saved",
                            "link_entity_id": null,
                            "link_entity_type": null,
                            "data": {},
                            "created_at": "2026-11-02T12:18:23.488Z",
                            "updated_at": "2026-11-02T12:18:23.488Z"
                          }
                        ]
                      }
                    ]
                  },
                  "ReturnsPaginatedPurchaseInvoicesOnPage1": {
                    "summary": "Returns paginated purchase invoices on page 1",
                    "value": [
                      {
                        "id": "502689307770750875",
                        "administration_id": 123,
                        "contact_id": "502689307621853033",
                        "contact": {
                          "id": "502689307621853033",
                          "administration_id": 123,
                          "company_name": "Foobar Holding B.V.",
                          "firstname": null,
                          "lastname": null,
                          "address1": "Hoofdstraat 12",
                          "address2": null,
                          "zipcode": "1234AB",
                          "city": "Amsterdam",
                          "country": "NL",
                          "phone": null,
                          "delivery_method": "Email",
                          "customer_id": "customer-1",
                          "tax_number": null,
                          "chamber_of_commerce": null,
                          "bank_account": null,
                          "is_trusted": false,
                          "max_transfer_amount": null,
                          "attention": null,
                          "email": "info@example.com",
                          "email_ubl": true,
                          "send_invoices_to_attention": null,
                          "send_invoices_to_email": "info@example.com",
                          "send_estimates_to_attention": null,
                          "send_estimates_to_email": "info@example.com",
                          "direct_debit": false,
                          "sepa_active": false,
                          "sepa_iban": null,
                          "sepa_iban_account_name": null,
                          "sepa_bic": null,
                          "sepa_mandate_id": null,
                          "sepa_mandate_date": null,
                          "sepa_sequence_type": "RCUR",
                          "credit_card_number": null,
                          "credit_card_reference": null,
                          "credit_card_type": null,
                          "tax_number_validated_at": null,
                          "tax_number_valid": null,
                          "invoice_workflow_id": null,
                          "estimate_workflow_id": null,
                          "si_identifier": null,
                          "si_identifier_type": null,
                          "moneybird_payments_mandate": false,
                          "created_at": "2026-11-02T12:18:23.531Z",
                          "updated_at": "2026-11-02T12:18:23.531Z",
                          "version": 1793621903,
                          "sales_invoices_url": "https://moneybird.dev/123/sales_invoices/0000000000000000000000000000000000000000000000000000000000000001/all",
                          "notes": [],
                          "custom_fields": [],
                          "contact_people": [],
                          "archived": false
                        },
                        "reference": "2013-01234",
                        "date": "2026-11-02",
                        "due_date": "2026-11-16",
                        "entry_number": 5,
                        "state": "open",
                        "currency": "EUR",
                        "exchange_rate": "1.0",
                        "revenue_invoice": false,
                        "prices_are_incl_tax": false,
                        "origin": null,
                        "paid_at": null,
                        "tax_number": null,
                        "total_price_excl_tax": "300.0",
                        "total_price_excl_tax_base": "300.0",
                        "total_price_incl_tax": "363.0",
                        "total_price_incl_tax_base": "363.0",
                        "created_at": "2026-11-02T12:18:23.674Z",
                        "updated_at": "2026-11-02T12:18:23.676Z",
                        "version": 1793621903,
                        "details": [
                          {
                            "id": "502689307772848028",
                            "administration_id": 123,
                            "tax_rate_id": "502689108908311693",
                            "ledger_account_id": "502689108787725433",
                            "project_id": null,
                            "product_id": null,
                            "amount": null,
                            "amount_decimal": "1.0",
                            "description": "Delivery Apple iPad",
                            "price": "300.0",
                            "period": null,
                            "row_order": 0,
                            "total_price_excl_tax_with_discount": "300.0",
                            "total_price_excl_tax_with_discount_base": "300.0",
                            "tax_report_reference": [
                              "NL/5b"
                            ],
                            "mandatory_tax_text": null,
                            "created_at": "2026-11-02T12:18:23.675Z",
                            "updated_at": "2026-11-02T12:18:23.675Z"
                          }
                        ],
                        "fiscal_allocations": [],
                        "payments": [],
                        "notes": [],
                        "attachments": [],
                        "events": [
                          {
                            "administration_id": 123,
                            "user_id": "502689108256097381",
                            "action": "document_saved",
                            "link_entity_id": null,
                            "link_entity_type": null,
                            "data": {},
                            "created_at": "2026-11-02T12:18:23.678Z",
                            "updated_at": "2026-11-02T12:18:23.678Z"
                          }
                        ]
                      }
                    ]
                  },
                  "ReturnsPaginatedPurchaseInvoicesOnPage2": {
                    "summary": "Returns paginated purchase invoices on page 2",
                    "value": [
                      {
                        "id": "502689307946911694",
                        "administration_id": 123,
                        "contact_id": "502689307831568296",
                        "contact": {
                          "id": "502689307831568296",
                          "administration_id": 123,
                          "company_name": "Foobar Holding B.V.",
                          "firstname": null,
                          "lastname": null,
                          "address1": "Hoofdstraat 12",
                          "address2": null,
                          "zipcode": "1234AB",
                          "city": "Amsterdam",
                          "country": "NL",
                          "phone": null,
                          "delivery_method": "Email",
                          "customer_id": "customer-1",
                          "tax_number": null,
                          "chamber_of_commerce": null,
                          "bank_account": null,
                          "is_trusted": false,
                          "max_transfer_amount": null,
                          "attention": null,
                          "email": "info@example.com",
                          "email_ubl": true,
                          "send_invoices_to_attention": null,
                          "send_invoices_to_email": "info@example.com",
                          "send_estimates_to_attention": null,
                          "send_estimates_to_email": "info@example.com",
                          "direct_debit": false,
                          "sepa_active": false,
                          "sepa_iban": null,
                          "sepa_iban_account_name": null,
                          "sepa_bic": null,
                          "sepa_mandate_id": null,
                          "sepa_mandate_date": null,
                          "sepa_sequence_type": "RCUR",
                          "credit_card_number": null,
                          "credit_card_reference": null,
                          "credit_card_type": null,
                          "tax_number_validated_at": null,
                          "tax_number_valid": null,
                          "invoice_workflow_id": null,
                          "estimate_workflow_id": null,
                          "si_identifier": null,
                          "si_identifier_type": null,
                          "moneybird_payments_mandate": false,
                          "created_at": "2026-11-02T12:18:23.731Z",
                          "updated_at": "2026-11-02T12:18:23.731Z",
                          "version": 1793621903,
                          "sales_invoices_url": "https://moneybird.dev/123/sales_invoices/0000000000000000000000000000000000000000000000000000000000000001/all",
                          "notes": [],
                          "custom_fields": [],
                          "contact_people": [],
                          "archived": false
                        },
                        "reference": "2013-01234",
                        "date": "2026-11-02",
                        "due_date": "2026-11-16",
                        "entry_number": 4,
                        "state": "open",
                        "currency": "EUR",
                        "exchange_rate": "1.0",
                        "revenue_invoice": false,
                        "prices_are_incl_tax": false,
                        "origin": null,
                        "paid_at": null,
                        "tax_number": null,
                        "total_price_excl_tax": "300.0",
                        "total_price_excl_tax_base": "300.0",
                        "total_price_incl_tax": "363.0",
                        "total_price_incl_tax_base": "363.0",
                        "created_at": "2026-11-02T12:18:23.841Z",
                        "updated_at": "2026-11-02T12:18:23.844Z",
                        "version": 1793621903,
                        "details": [
                          {
                            "id": "502689307947960271",
                            "administration_id": 123,
                            "tax_rate_id": "502689108908311693",
                            "ledger_account_id": "502689108787725433",
                            "project_id": null,
                            "product_id": null,
                            "amount": null,
                            "amount_decimal": "1.0",
                            "description": "Delivery Apple iPad",
                            "price": "300.0",
                            "period": null,
                            "row_order": 0,
                            "total_price_excl_tax_with_discount": "300.0",
                            "total_price_excl_tax_with_discount_base": "300.0",
                            "tax_report_reference": [
                              "NL/5b"
                            ],
                            "mandatory_tax_text": null,
                            "created_at": "2026-11-02T12:18:23.843Z",
                            "updated_at": "2026-11-02T12:18:23.843Z"
                          }
                        ],
                        "fiscal_allocations": [],
                        "payments": [],
                        "notes": [],
                        "attachments": [],
                        "events": [
                          {
                            "administration_id": 123,
                            "user_id": "502689108256097381",
                            "action": "document_saved",
                            "link_entity_id": null,
                            "link_entity_type": null,
                            "data": {},
                            "created_at": "2026-11-02T12:18:23.846Z",
                            "updated_at": "2026-11-02T12:18:23.846Z"
                          }
                        ]
                      }
                    ]
                  },
                  "ReturnsTheOldestPurchaseInvoiceFirstWhenSortedByDateAscending": {
                    "summary": "Returns the oldest purchase invoice first when sorted by date ascending",
                    "value": [
                      {
                        "id": "502689308217443367",
                        "administration_id": 123,
                        "contact_id": "502689308210103334",
                        "contact": {
                          "id": "502689308210103334",
                          "administration_id": 123,
                          "company_name": "Relation 1",
                          "firstname": null,
                          "lastname": null,
                          "address1": null,
                          "address2": null,
                          "zipcode": null,
                          "city": null,
                          "country": "NL",
                          "phone": null,
                          "delivery_method": "Email",
                          "customer_id": "customer-2",
                          "tax_number": null,
                          "chamber_of_commerce": null,
                          "bank_account": null,
                          "is_trusted": false,
                          "max_transfer_amount": null,
                          "attention": null,
                          "email": "contact1@example.com",
                          "email_ubl": false,
                          "send_invoices_to_attention": null,
                          "send_invoices_to_email": "contact1@example.com",
                          "send_estimates_to_attention": null,
                          "send_estimates_to_email": null,
                          "direct_debit": false,
                          "sepa_active": false,
                          "sepa_iban": null,
                          "sepa_iban_account_name": null,
                          "sepa_bic": null,
                          "sepa_mandate_id": null,
                          "sepa_mandate_date": null,
                          "sepa_sequence_type": "RCUR",
                          "credit_card_number": null,
                          "credit_card_reference": null,
                          "credit_card_type": null,
                          "tax_number_validated_at": null,
                          "tax_number_valid": null,
                          "invoice_workflow_id": null,
                          "estimate_workflow_id": null,
                          "si_identifier": null,
                          "si_identifier_type": null,
                          "moneybird_payments_mandate": false,
                          "created_at": "2026-11-02T12:18:24.093Z",
                          "updated_at": "2026-11-02T12:18:24.093Z",
                          "version": 1793621904,
                          "sales_invoices_url": "https://moneybird.dev/123/sales_invoices/0000000000000000000000000000000000000000000000000000000000000002/all",
                          "notes": [],
                          "custom_fields": [],
                          "contact_people": [],
                          "archived": false
                        },
                        "reference": "2026-0002",
                        "date": "2025-11-02",
                        "due_date": null,
                        "entry_number": null,
                        "state": "open",
                        "currency": "EUR",
                        "exchange_rate": "1.0",
                        "revenue_invoice": false,
                        "prices_are_incl_tax": false,
                        "origin": null,
                        "paid_at": null,
                        "tax_number": null,
                        "total_price_excl_tax": "100.0",
                        "total_price_excl_tax_base": "100.0",
                        "total_price_incl_tax": "121.0",
                        "total_price_incl_tax_base": "121.0",
                        "created_at": "2026-11-02T12:18:24.100Z",
                        "updated_at": "2026-11-02T12:18:24.103Z",
                        "version": 1793621904,
                        "details": [
                          {
                            "id": "502689308219540520",
                            "administration_id": 123,
                            "tax_rate_id": "502689108908311693",
                            "ledger_account_id": "502689108787725433",
                            "project_id": null,
                            "product_id": null,
                            "amount": "1 x",
                            "amount_decimal": "1.0",
                            "description": "Invoice detail description",
                            "price": "100.0",
                            "period": null,
                            "row_order": 0,
                            "total_price_excl_tax_with_discount": "100.0",
                            "total_price_excl_tax_with_discount_base": "100.0",
                            "tax_report_reference": [],
                            "mandatory_tax_text": null,
                            "created_at": "2026-11-02T12:18:24.101Z",
                            "updated_at": "2026-11-02T12:18:24.101Z"
                          }
                        ],
                        "fiscal_allocations": [],
                        "payments": [],
                        "notes": [],
                        "attachments": [],
                        "events": []
                      }
                    ]
                  },
                  "ReturnsAListOfPurchaseInvoices": {
                    "summary": "Returns a list of purchase invoices",
                    "value": [
                      {
                        "id": "502689308426110044",
                        "administration_id": 123,
                        "contact_id": "502689308265677866",
                        "contact": {
                          "id": "502689308265677866",
                          "administration_id": 123,
                          "company_name": "Foobar Holding B.V.",
                          "firstname": null,
                          "lastname": null,
                          "address1": "Hoofdstraat 12",
                          "address2": null,
                          "zipcode": "1234AB",
                          "city": "Amsterdam",
                          "country": "NL",
                          "phone": null,
                          "delivery_method": "Email",
                          "customer_id": "customer-1",
                          "tax_number": null,
                          "chamber_of_commerce": null,
                          "bank_account": null,
                          "is_trusted": false,
                          "max_transfer_amount": null,
                          "attention": null,
                          "email": "info@example.com",
                          "email_ubl": true,
                          "send_invoices_to_attention": null,
                          "send_invoices_to_email": "info@example.com",
                          "send_estimates_to_attention": null,
                          "send_estimates_to_email": "info@example.com",
                          "direct_debit": false,
                          "sepa_active": false,
                          "sepa_iban": null,
                          "sepa_iban_account_name": null,
                          "sepa_bic": null,
                          "sepa_mandate_id": null,
                          "sepa_mandate_date": null,
                          "sepa_sequence_type": "RCUR",
                          "credit_card_number": null,
                          "credit_card_reference": null,
                          "credit_card_type": null,
                          "tax_number_validated_at": null,
                          "tax_number_valid": null,
                          "invoice_workflow_id": null,
                          "estimate_workflow_id": null,
                          "si_identifier": null,
                          "si_identifier_type": null,
                          "moneybird_payments_mandate": false,
                          "created_at": "2026-11-02T12:18:24.146Z",
                          "updated_at": "2026-11-02T12:18:24.146Z",
                          "version": 1793621904,
                          "sales_invoices_url": "https://moneybird.dev/123/sales_invoices/0000000000000000000000000000000000000000000000000000000000000001/all",
                          "notes": [],
                          "custom_fields": [],
                          "contact_people": [],
                          "archived": false
                        },
                        "reference": "2013-01234",
                        "date": "2026-11-02",
                        "due_date": "2026-11-16",
                        "entry_number": 5,
                        "state": "open",
                        "currency": "EUR",
                        "exchange_rate": "1.0",
                        "revenue_invoice": false,
                        "prices_are_incl_tax": false,
                        "origin": null,
                        "paid_at": null,
                        "tax_number": null,
                        "total_price_excl_tax": "300.0",
                        "total_price_excl_tax_base": "300.0",
                        "total_price_incl_tax": "363.0",
                        "total_price_incl_tax_base": "363.0",
                        "created_at": "2026-11-02T12:18:24.298Z",
                        "updated_at": "2026-11-02T12:18:24.301Z",
                        "version": 1793621904,
                        "details": [
                          {
                            "id": "502689308427158621",
                            "administration_id": 123,
                            "tax_rate_id": "502689108908311693",
                            "ledger_account_id": "502689108787725433",
                            "project_id": null,
                            "product_id": null,
                            "amount": null,
                            "amount_decimal": "1.0",
                            "description": "Delivery Apple iPad",
                            "price": "300.0",
                            "period": null,
                            "row_order": 0,
                            "total_price_excl_tax_with_discount": "300.0",
                            "total_price_excl_tax_with_discount_base": "300.0",
                            "tax_report_reference": [
                              "NL/5b"
                            ],
                            "mandatory_tax_text": null,
                            "created_at": "2026-11-02T12:18:24.300Z",
                            "updated_at": "2026-11-02T12:18:24.300Z"
                          }
                        ],
                        "fiscal_allocations": [],
                        "payments": [],
                        "notes": [],
                        "attachments": [],
                        "events": [
                          {
                            "administration_id": 123,
                            "user_id": "502689108256097381",
                            "action": "document_saved",
                            "link_entity_id": null,
                            "link_entity_type": null,
                            "data": {},
                            "created_at": "2026-11-02T12:18:24.303Z",
                            "updated_at": "2026-11-02T12:18:24.303Z"
                          }
                        ]
                      },
                      {
                        "id": "502689308390458448",
                        "administration_id": 123,
                        "contact_id": "502689308265677866",
                        "contact": {
                          "id": "502689308265677866",
                          "administration_id": 123,
                          "company_name": "Foobar Holding B.V.",
                          "firstname": null,
                          "lastname": null,
                          "address1": "Hoofdstraat 12",
                          "address2": null,
                          "zipcode": "1234AB",
                          "city": "Amsterdam",
                          "country": "NL",
                          "phone": null,
                          "delivery_method": "Email",
                          "customer_id": "customer-1",
                          "tax_number": null,
                          "chamber_of_commerce": null,
                          "bank_account": null,
                          "is_trusted": false,
                          "max_transfer_amount": null,
                          "attention": null,
                          "email": "info@example.com",
                          "email_ubl": true,
                          "send_invoices_to_attention": null,
                          "send_invoices_to_email": "info@example.com",
                          "send_estimates_to_attention": null,
                          "send_estimates_to_email": "info@example.com",
                          "direct_debit": false,
                          "sepa_active": false,
                          "sepa_iban": null,
                          "sepa_iban_account_name": null,
                          "sepa_bic": null,
                          "sepa_mandate_id": null,
                          "sepa_mandate_date": null,
                          "sepa_sequence_type": "RCUR",
                          "credit_card_number": null,
                          "credit_card_reference": null,
                          "credit_card_type": null,
                          "tax_number_validated_at": null,
                          "tax_number_valid": null,
                          "invoice_workflow_id": null,
                          "estimate_workflow_id": null,
                          "si_identifier": null,
                          "si_identifier_type": null,
                          "moneybird_payments_mandate": false,
                          "created_at": "2026-11-02T12:18:24.146Z",
                          "updated_at": "2026-11-02T12:18:24.146Z",
                          "version": 1793621904,
                          "sales_invoices_url": "https://moneybird.dev/123/sales_invoices/0000000000000000000000000000000000000000000000000000000000000001/all",
                          "notes": [],
                          "custom_fields": [],
                          "contact_people": [],
                          "archived": false
                        },
                        "reference": "2013-01234",
                        "date": "2026-11-02",
                        "due_date": "2026-11-16",
                        "entry_number": 4,
                        "state": "open",
                        "currency": "EUR",
                        "exchange_rate": "1.0",
                        "revenue_invoice": false,
                        "prices_are_incl_tax": false,
                        "origin": null,
                        "paid_at": null,
                        "tax_number": null,
                        "total_price_excl_tax": "300.0",
                        "total_price_excl_tax_base": "300.0",
                        "total_price_incl_tax": "363.0",
                        "total_price_incl_tax_base": "363.0",
                        "created_at": "2026-11-02T12:18:24.264Z",
                        "updated_at": "2026-11-02T12:18:24.268Z",
                        "version": 1793621904,
                        "details": [
                          {
                            "id": "502689308392555601",
                            "administration_id": 123,
                            "tax_rate_id": "502689108908311693",
                            "ledger_account_id": "502689108787725433",
                            "project_id": null,
                            "product_id": null,
                            "amount": null,
                            "amount_decimal": "1.0",
                            "description": "Delivery Apple iPad",
                            "price": "300.0",
                            "period": null,
                            "row_order": 0,
                            "total_price_excl_tax_with_discount": "300.0",
                            "total_price_excl_tax_with_discount_base": "300.0",
                            "tax_report_reference": [
                              "NL/5b"
                            ],
                            "mandatory_tax_text": null,
                            "created_at": "2026-11-02T12:18:24.266Z",
                            "updated_at": "2026-11-02T12:18:24.266Z"
                          }
                        ],
                        "fiscal_allocations": [],
                        "payments": [],
                        "notes": [],
                        "attachments": [],
                        "events": [
                          {
                            "administration_id": 123,
                            "user_id": "502689108256097381",
                            "action": "document_saved",
                            "link_entity_id": null,
                            "link_entity_type": null,
                            "data": {},
                            "created_at": "2026-11-02T12:18:24.270Z",
                            "updated_at": "2026-11-02T12:18:24.270Z"
                          }
                        ]
                      },
                      {
                        "id": "502689308356904004",
                        "administration_id": 123,
                        "contact_id": "502689308265677866",
                        "contact": {
                          "id": "502689308265677866",
                          "administration_id": 123,
                          "company_name": "Foobar Holding B.V.",
                          "firstname": null,
                          "lastname": null,
                          "address1": "Hoofdstraat 12",
                          "address2": null,
                          "zipcode": "1234AB",
                          "city": "Amsterdam",
                          "country": "NL",
                          "phone": null,
                          "delivery_method": "Email",
                          "customer_id": "customer-1",
                          "tax_number": null,
                          "chamber_of_commerce": null,
                          "bank_account": null,
                          "is_trusted": false,
                          "max_transfer_amount": null,
                          "attention": null,
                          "email": "info@example.com",
                          "email_ubl": true,
                          "send_invoices_to_attention": null,
                          "send_invoices_to_email": "info@example.com",
                          "send_estimates_to_attention": null,
                          "send_estimates_to_email": "info@example.com",
                          "direct_debit": false,
                          "sepa_active": false,
                          "sepa_iban": null,
                          "sepa_iban_account_name": null,
                          "sepa_bic": null,
                          "sepa_mandate_id": null,
                          "sepa_mandate_date": null,
                          "sepa_sequence_type": "RCUR",
                          "credit_card_number": null,
                          "credit_card_reference": null,
                          "credit_card_type": null,
                          "tax_number_validated_at": null,
                          "tax_number_valid": null,
                          "invoice_workflow_id": null,
                          "estimate_workflow_id": null,
                          "si_identifier": null,
                          "si_identifier_type": null,
                          "moneybird_payments_mandate": false,
                          "created_at": "2026-11-02T12:18:24.146Z",
                          "updated_at": "2026-11-02T12:18:24.146Z",
                          "version": 1793621904,
                          "sales_invoices_url": "https://moneybird.dev/123/sales_invoices/0000000000000000000000000000000000000000000000000000000000000001/all",
                          "notes": [],
                          "custom_fields": [],
                          "contact_people": [],
                          "archived": false
                        },
                        "reference": "2013-01234",
                        "date": "2026-11-02",
                        "due_date": "2026-11-16",
                        "entry_number": 3,
                        "state": "open",
                        "currency": "EUR",
                        "exchange_rate": "1.0",
                        "revenue_invoice": false,
                        "prices_are_incl_tax": false,
                        "origin": null,
                        "paid_at": null,
                        "tax_number": null,
                        "total_price_excl_tax": "300.0",
                        "total_price_excl_tax_base": "300.0",
                        "total_price_incl_tax": "363.0",
                        "total_price_incl_tax_base": "363.0",
                        "created_at": "2026-11-02T12:18:24.232Z",
                        "updated_at": "2026-11-02T12:18:24.235Z",
                        "version": 1793621904,
                        "details": [
                          {
                            "id": "502689308359001157",
                            "administration_id": 123,
                            "tax_rate_id": "502689108908311693",
                            "ledger_account_id": "502689108787725433",
                            "project_id": null,
                            "product_id": null,
                            "amount": null,
                            "amount_decimal": "1.0",
                            "description": "Delivery Apple iPad",
                            "price": "300.0",
                            "period": null,
                            "row_order": 0,
                            "total_price_excl_tax_with_discount": "300.0",
                            "total_price_excl_tax_with_discount_base": "300.0",
                            "tax_report_reference": [
                              "NL/5b"
                            ],
                            "mandatory_tax_text": null,
                            "created_at": "2026-11-02T12:18:24.234Z",
                            "updated_at": "2026-11-02T12:18:24.234Z"
                          }
                        ],
                        "fiscal_allocations": [],
                        "payments": [],
                        "notes": [],
                        "attachments": [],
                        "events": [
                          {
                            "administration_id": 123,
                            "user_id": "502689108256097381",
                            "action": "document_saved",
                            "link_entity_id": null,
                            "link_entity_type": null,
                            "data": {},
                            "created_at": "2026-11-02T12:18:24.238Z",
                            "updated_at": "2026-11-02T12:18:24.238Z"
                          }
                        ]
                      },
                      {
                        "id": "502689308288746540",
                        "administration_id": 123,
                        "contact_id": "502689308265677866",
                        "contact": {
                          "id": "502689308265677866",
                          "administration_id": 123,
                          "company_name": "Foobar Holding B.V.",
                          "firstname": null,
                          "lastname": null,
                          "address1": "Hoofdstraat 12",
                          "address2": null,
                          "zipcode": "1234AB",
                          "city": "Amsterdam",
                          "country": "NL",
                          "phone": null,
                          "delivery_method": "Email",
                          "customer_id": "customer-1",
                          "tax_number": null,
                          "chamber_of_commerce": null,
                          "bank_account": null,
                          "is_trusted": false,
                          "max_transfer_amount": null,
                          "attention": null,
                          "email": "info@example.com",
                          "email_ubl": true,
                          "send_invoices_to_attention": null,
                          "send_invoices_to_email": "info@example.com",
                          "send_estimates_to_attention": null,
                          "send_estimates_to_email": "info@example.com",
                          "direct_debit": false,
                          "sepa_active": false,
                          "sepa_iban": null,
                          "sepa_iban_account_name": null,
                          "sepa_bic": null,
                          "sepa_mandate_id": null,
                          "sepa_mandate_date": null,
                          "sepa_sequence_type": "RCUR",
                          "credit_card_number": null,
                          "credit_card_reference": null,
                          "credit_card_type": null,
                          "tax_number_validated_at": null,
                          "tax_number_valid": null,
                          "invoice_workflow_id": null,
                          "estimate_workflow_id": null,
                          "si_identifier": null,
                          "si_identifier_type": null,
                          "moneybird_payments_mandate": false,
                          "created_at": "2026-11-02T12:18:24.146Z",
                          "updated_at": "2026-11-02T12:18:24.146Z",
                          "version": 1793621904,
                          "sales_invoices_url": "https://moneybird.dev/123/sales_invoices/0000000000000000000000000000000000000000000000000000000000000001/all",
                          "notes": [],
                          "custom_fields": [],
                          "contact_people": [],
                          "archived": false
                        },
                        "reference": "2013-01234",
                        "date": "2026-11-02",
                        "due_date": "2026-11-16",
                        "entry_number": 1,
                        "state": "open",
                        "currency": "EUR",
                        "exchange_rate": "1.0",
                        "revenue_invoice": false,
                        "prices_are_incl_tax": false,
                        "origin": null,
                        "paid_at": null,
                        "tax_number": null,
                        "total_price_excl_tax": "300.0",
                        "total_price_excl_tax_base": "300.0",
                        "total_price_incl_tax": "363.0",
                        "total_price_incl_tax_base": "363.0",
                        "created_at": "2026-11-02T12:18:24.167Z",
                        "updated_at": "2026-11-02T12:18:24.170Z",
                        "version": 1793621904,
                        "details": [
                          {
                            "id": "502689308289795117",
                            "administration_id": 123,
                            "tax_rate_id": "502689108908311693",
                            "ledger_account_id": "502689108787725433",
                            "project_id": null,
                            "product_id": null,
                            "amount": null,
                            "amount_decimal": "1.0",
                            "description": "Delivery Apple iPad",
                            "price": "300.0",
                            "period": null,
                            "row_order": 0,
                            "total_price_excl_tax_with_discount": "300.0",
                            "total_price_excl_tax_with_discount_base": "300.0",
                            "tax_report_reference": [
                              "NL/5b"
                            ],
                            "mandatory_tax_text": null,
                            "created_at": "2026-11-02T12:18:24.169Z",
                            "updated_at": "2026-11-02T12:18:24.169Z"
                          }
                        ],
                        "fiscal_allocations": [],
                        "payments": [],
                        "notes": [],
                        "attachments": [],
                        "events": [
                          {
                            "administration_id": 123,
                            "user_id": "502689108256097381",
                            "action": "document_saved",
                            "link_entity_id": null,
                            "link_entity_type": null,
                            "data": {},
                            "created_at": "2026-11-02T12:18:24.172Z",
                            "updated_at": "2026-11-02T12:18:24.172Z"
                          }
                        ]
                      }
                    ]
                  }
                }
              }
            }
          },
          "400": {
            "description": "Bad request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/symbolic_error"
                },
                "examples": {
                  "ReturnsAnErrorWhenTooManyPurchaseInvoicesAreRequested": {
                    "summary": "Returns an error when too many purchase invoices are requested",
                    "value": {
                      "error": "Per Page is too big",
                      "symbolic": {
                        "per_page": "max"
                      }
                    }
                  }
                }
              }
            }
          }
        },
        "operationId": "get_administration_id_documents_purchase_invoices"
      },
      "post": {
        "summary": "Create a new purchase invoice",
        "description": "Creates a new purchase invoice.\n\n### Required scope(s)\n `documents`",
        "tags": [
          "Documents: Purchase invoices"
        ],
        "security": [
          {
            "bearerAuth": [
              "documents"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/administration_id"
          },
          {
            "$ref": "#/components/parameters/format"
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/*": {
              "schema": {
                "unevaluatedProperties": false,
                "type": "object",
                "properties": {
                  "purchase_invoice": {
                    "type": "object",
                    "unevaluatedProperties": false,
                    "properties": {
                      "contact_id": {
                        "$ref": "#/components/schemas/identifier",
                        "description": "Should be a valid contact id."
                      },
                      "reference": {
                        "type": "string",
                        "description": "The supplier's invoice number or reference."
                      },
                      "date": {
                        "type": "string",
                        "description": "The date on the supplier's invoice.",
                        "format": "date"
                      },
                      "due_date": {
                        "type": "string",
                        "description": "The date by which the invoice should be paid.",
                        "format": "date"
                      },
                      "currency": {
                        "type": "string",
                        "description": "ISO three-character currency code, e.g. EUR or USD."
                      },
                      "prices_are_incl_tax": {
                        "type": [
                          "boolean",
                          "string"
                        ],
                        "description": "Whether the prices on the purchase invoice are inclusive of tax. Defaults to the administration setting."
                      },
                      "revenue_invoice": {
                        "type": [
                          "boolean",
                          "string"
                        ],
                        "description": "When `true`, this purchase invoice is treated as a revenue invoice (e.g. a credit note from a supplier). Revenue invoices are booked as income instead of expenses."
                      },
                      "details_attributes": {
                        "$ref": "#/components/schemas/details_attributes"
                      },
                      "fiscal_allocations_attributes": {
                        "$ref": "#/components/schemas/fiscal_allocations_attributes"
                      }
                    },
                    "required": []
                  }
                },
                "required": []
              },
              "examples": {
                "CreatesThePurchaseInvoice": {
                  "summary": "Creates the purchase invoice",
                  "value": {
                    "purchase_invoice": {
                      "reference": "foobar",
                      "contact_id": 502689305771115840,
                      "details_attributes": {
                        "0": {
                          "description": "Lunch",
                          "price": 20,
                          "tax_rate_id": 502689108908311700,
                          "ledger_account_id": 502689108787725440
                        }
                      }
                    }
                  }
                },
                "CreatesADocumentWithFiscalAllocations": {
                  "summary": "Creates a document with fiscal allocations",
                  "value": {
                    "purchase_invoice": {
                      "reference": "with fiscal allocations",
                      "contact_id": 502689311916820400,
                      "details_attributes": [
                        {
                          "description": "Test detail",
                          "price": 100,
                          "tax_rate_id": 502689108908311700,
                          "ledger_account_id": 502689108787725440
                        }
                      ],
                      "fiscal_allocations_attributes": [
                        {
                          "ledger_account_id": 502689108787725440,
                          "private_ledger_account_id": 502689311990220740,
                          "percentage": "30"
                        }
                      ]
                    }
                  }
                }
              }
            }
          }
        },
        "responses": {
          "201": {
            "description": "Purchase invoice created",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/purchase_invoice_response"
                },
                "examples": {
                  "CreatesThePurchaseInvoice": {
                    "summary": "Creates the purchase invoice",
                    "value": {
                      "id": "502689305866536254",
                      "administration_id": 123,
                      "contact_id": "502689305771115812",
                      "contact": {
                        "id": "502689305771115812",
                        "administration_id": 123,
                        "company_name": "Foobar Holding B.V.",
                        "firstname": null,
                        "lastname": null,
                        "address1": "Hoofdstraat 12",
                        "address2": null,
                        "zipcode": "1234AB",
                        "city": "Amsterdam",
                        "country": "NL",
                        "phone": null,
                        "delivery_method": "Email",
                        "customer_id": "customer-1",
                        "tax_number": null,
                        "chamber_of_commerce": null,
                        "bank_account": null,
                        "is_trusted": false,
                        "max_transfer_amount": null,
                        "attention": null,
                        "email": "info@example.com",
                        "email_ubl": true,
                        "send_invoices_to_attention": null,
                        "send_invoices_to_email": "info@example.com",
                        "send_estimates_to_attention": null,
                        "send_estimates_to_email": "info@example.com",
                        "direct_debit": false,
                        "sepa_active": false,
                        "sepa_iban": null,
                        "sepa_iban_account_name": null,
                        "sepa_bic": null,
                        "sepa_mandate_id": null,
                        "sepa_mandate_date": null,
                        "sepa_sequence_type": "RCUR",
                        "credit_card_number": null,
                        "credit_card_reference": null,
                        "credit_card_type": null,
                        "tax_number_validated_at": null,
                        "tax_number_valid": null,
                        "invoice_workflow_id": null,
                        "estimate_workflow_id": null,
                        "si_identifier": null,
                        "si_identifier_type": null,
                        "moneybird_payments_mandate": false,
                        "created_at": "2026-11-02T12:18:21.766Z",
                        "updated_at": "2026-11-02T12:18:21.766Z",
                        "version": 1793621901,
                        "sales_invoices_url": "https://moneybird.dev/123/sales_invoices/0000000000000000000000000000000000000000000000000000000000000001/all",
                        "notes": [],
                        "custom_fields": [],
                        "contact_people": [],
                        "archived": false
                      },
                      "reference": "foobar",
                      "date": "2026-11-02",
                      "due_date": null,
                      "entry_number": 3,
                      "state": "open",
                      "currency": "EUR",
                      "exchange_rate": "1.0",
                      "revenue_invoice": false,
                      "prices_are_incl_tax": false,
                      "origin": "api",
                      "paid_at": null,
                      "tax_number": null,
                      "total_price_excl_tax": "20.0",
                      "total_price_excl_tax_base": "20.0",
                      "total_price_incl_tax": "24.2",
                      "total_price_incl_tax_base": "24.2",
                      "created_at": "2026-11-02T12:18:21.858Z",
                      "updated_at": "2026-11-02T12:18:21.861Z",
                      "version": 1793621901,
                      "details": [
                        {
                          "id": "502689305868633407",
                          "administration_id": 123,
                          "tax_rate_id": "502689108908311693",
                          "ledger_account_id": "502689108787725433",
                          "project_id": null,
                          "product_id": null,
                          "amount": null,
                          "amount_decimal": "1.0",
                          "description": "Lunch",
                          "price": "20.0",
                          "period": null,
                          "row_order": 0,
                          "total_price_excl_tax_with_discount": "20.0",
                          "total_price_excl_tax_with_discount_base": "20.0",
                          "tax_report_reference": [
                            "NL/5b"
                          ],
                          "mandatory_tax_text": null,
                          "created_at": "2026-11-02T12:18:21.860Z",
                          "updated_at": "2026-11-02T12:18:21.860Z"
                        }
                      ],
                      "fiscal_allocations": [],
                      "payments": [],
                      "notes": [],
                      "attachments": [],
                      "events": [
                        {
                          "administration_id": 123,
                          "user_id": "502689108256097381",
                          "action": "document_saved",
                          "link_entity_id": null,
                          "link_entity_type": null,
                          "data": {},
                          "created_at": "2026-11-02T12:18:21.863Z",
                          "updated_at": "2026-11-02T12:18:21.863Z"
                        }
                      ]
                    }
                  },
                  "CreatesADocumentWithFiscalAllocations": {
                    "summary": "Creates a document with fiscal allocations",
                    "value": {
                      "id": "502689312016435142",
                      "administration_id": 123,
                      "contact_id": "502689311916820395",
                      "contact": {
                        "id": "502689311916820395",
                        "administration_id": 123,
                        "company_name": "Foobar Holding B.V.",
                        "firstname": null,
                        "lastname": null,
                        "address1": "Hoofdstraat 12",
                        "address2": null,
                        "zipcode": "1234AB",
                        "city": "Amsterdam",
                        "country": "NL",
                        "phone": null,
                        "delivery_method": "Email",
                        "customer_id": "customer-1",
                        "tax_number": null,
                        "chamber_of_commerce": null,
                        "bank_account": null,
                        "is_trusted": false,
                        "max_transfer_amount": null,
                        "attention": null,
                        "email": "info@example.com",
                        "email_ubl": true,
                        "send_invoices_to_attention": null,
                        "send_invoices_to_email": "info@example.com",
                        "send_estimates_to_attention": null,
                        "send_estimates_to_email": "info@example.com",
                        "direct_debit": false,
                        "sepa_active": false,
                        "sepa_iban": null,
                        "sepa_iban_account_name": null,
                        "sepa_bic": null,
                        "sepa_mandate_id": null,
                        "sepa_mandate_date": null,
                        "sepa_sequence_type": "RCUR",
                        "credit_card_number": null,
                        "credit_card_reference": null,
                        "credit_card_type": null,
                        "tax_number_validated_at": null,
                        "tax_number_valid": null,
                        "invoice_workflow_id": null,
                        "estimate_workflow_id": null,
                        "si_identifier": null,
                        "si_identifier_type": null,
                        "moneybird_payments_mandate": false,
                        "created_at": "2026-11-02T12:18:27.628Z",
                        "updated_at": "2026-11-02T12:18:27.628Z",
                        "version": 1793621907,
                        "sales_invoices_url": "https://moneybird.dev/123/sales_invoices/0000000000000000000000000000000000000000000000000000000000000001/all",
                        "notes": [],
                        "custom_fields": [],
                        "contact_people": [],
                        "archived": false
                      },
                      "reference": "with fiscal allocations",
                      "date": "2026-11-02",
                      "due_date": null,
                      "entry_number": 3,
                      "state": "open",
                      "currency": "EUR",
                      "exchange_rate": "1.0",
                      "revenue_invoice": false,
                      "prices_are_incl_tax": false,
                      "origin": "api",
                      "paid_at": null,
                      "tax_number": null,
                      "total_price_excl_tax": "106.3",
                      "total_price_excl_tax_base": "106.3",
                      "total_price_incl_tax": "121.0",
                      "total_price_incl_tax_base": "121.0",
                      "created_at": "2026-11-02T12:18:27.722Z",
                      "updated_at": "2026-11-02T12:18:27.726Z",
                      "version": 1793621907,
                      "details": [
                        {
                          "id": "502689312018532296",
                          "administration_id": 123,
                          "tax_rate_id": "502689108908311693",
                          "ledger_account_id": "502689108787725433",
                          "project_id": null,
                          "product_id": null,
                          "amount": null,
                          "amount_decimal": "1.0",
                          "description": "Test detail",
                          "price": "100.0",
                          "period": null,
                          "row_order": 0,
                          "total_price_excl_tax_with_discount": "70.0",
                          "total_price_excl_tax_with_discount_base": "70.0",
                          "tax_report_reference": [
                            "NL/5b"
                          ],
                          "mandatory_tax_text": null,
                          "created_at": "2026-11-02T12:18:27.725Z",
                          "updated_at": "2026-11-02T12:18:27.725Z"
                        }
                      ],
                      "fiscal_allocations": [
                        {
                          "id": "502689312017483719",
                          "administration_id": 123,
                          "ledger_account_id": "502689108787725433",
                          "private_ledger_account_id": "502689311990220741",
                          "percentage": "30.0",
                          "price": "36.3",
                          "price_base": "36.3",
                          "created_at": "2026-11-02T12:18:27.724Z",
                          "updated_at": "2026-11-02T12:18:27.724Z"
                        }
                      ],
                      "payments": [],
                      "notes": [],
                      "attachments": [],
                      "events": [
                        {
                          "administration_id": 123,
                          "user_id": "502689108256097381",
                          "action": "document_saved",
                          "link_entity_id": null,
                          "link_entity_type": null,
                          "data": {},
                          "created_at": "2026-11-02T12:18:27.728Z",
                          "updated_at": "2026-11-02T12:18:27.728Z"
                        }
                      ]
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "Bad request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/symbolic_error"
                },
                "examples": {
                  "RequiresAllInput": {
                    "summary": "Requires all input",
                    "value": {
                      "error": "Purchase Invoice is required",
                      "symbolic": {
                        "purchase_invoice": "required"
                      }
                    }
                  }
                }
              }
            }
          },
          "402": {
            "$ref": "#/components/responses/402_payment_required"
          },
          "422": {
            "$ref": "#/components/responses/422_unprocessable_entity"
          }
        },
        "operationId": "post_administration_id_documents_purchase_invoices"
      }
    },
    "/{administration_id}/documents/receipts/synchronization{format}": {
      "get": {
        "summary": "List ids and versions of receipts",
        "description": "Returns all documents in the administration. The list contains the document id and the version of the document.\nCheck if the version of the document is newer than the version you have stored locally, use the `POST`\nvariant for fetching documents with the given ids.\n\n### Required scope(s)\n `documents`",
        "tags": [
          "Documents: Receipts"
        ],
        "security": [
          {
            "bearerAuth": [
              "documents"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/administration_id"
          },
          {
            "$ref": "#/components/parameters/format"
          },
          {
            "name": "filter",
            "in": "query",
            "required": false,
            "description": "Comma-separated `key:value` filter terms. Same syntax as `GET /documents/receipts` — see that operation's description for the available keys.",
            "schema": {
              "type": "string"
            },
            "examples": {
              "RetrievesAllIdsForSynchronizationUsingAFilter": {
                "summary": "Retrieves all ids for synchronization using a filter",
                "value": "period:this_month"
              }
            }
          }
        ],
        "responses": {
          "200": {
            "description": "IDs and versions of records",
            "content": {
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "type": "object",
                    "unevaluatedProperties": false,
                    "properties": {
                      "id": {
                        "type": [
                          "integer",
                          "string"
                        ]
                      },
                      "version": {
                        "type": [
                          "integer",
                          "string"
                        ]
                      }
                    }
                  }
                },
                "examples": {
                  "RetrievesAllIdsForSynchronization": {
                    "summary": "Retrieves all ids for synchronization",
                    "value": [
                      {
                        "id": "502689176467015124",
                        "version": 1793621778
                      },
                      {
                        "id": "502689176535172588",
                        "version": 1793621778
                      },
                      {
                        "id": "502689176562435576",
                        "version": 1793621778
                      }
                    ]
                  },
                  "RetrievesAllIdsForSynchronizationUsingAFilter": {
                    "summary": "Retrieves all ids for synchronization using a filter",
                    "value": [
                      {
                        "id": "502689176615912967",
                        "version": 1793621778
                      },
                      {
                        "id": "502689176673584671",
                        "version": 1793621778
                      },
                      {
                        "id": "502689176700847659",
                        "version": 1793621778
                      }
                    ]
                  }
                }
              }
            }
          }
        },
        "operationId": "get_administration_id_documents_receipts_synchronization"
      },
      "post": {
        "summary": "Fetch receipts with given ids",
        "x-query": true,
        "description": "Given a list of document ids, returns the document information belonging to the documents.\nReturns a maximum of 100 documents, even if more ids are provided.\n\n### Required scope(s)\n `documents`",
        "tags": [
          "Documents: Receipts"
        ],
        "security": [
          {
            "bearerAuth": [
              "documents"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/administration_id"
          },
          {
            "$ref": "#/components/parameters/format"
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/*": {
              "schema": {
                "unevaluatedProperties": false,
                "type": "object",
                "properties": {
                  "ids": {
                    "type": "array",
                    "items": {
                      "type": [
                        "integer",
                        "string"
                      ]
                    }
                  }
                },
                "required": [
                  "ids"
                ]
              },
              "examples": {
                "RetrievesDocumentsForGivenIds": {
                  "summary": "Retrieves documents for given ids",
                  "value": {
                    "ids": [
                      502689176365303230,
                      502689176395711940
                    ]
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "A list of receipts",
            "content": {
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "$ref": "#/components/schemas/receipt_response"
                  }
                },
                "examples": {
                  "RetrievesDocumentsForGivenIds": {
                    "summary": "Retrieves documents for given ids",
                    "value": [
                      {
                        "id": "502689176365303225",
                        "administration_id": 123,
                        "contact_id": "502689176266737055",
                        "contact": {
                          "id": "502689176266737055",
                          "administration_id": 123,
                          "company_name": "Foobar Holding B.V.",
                          "firstname": null,
                          "lastname": null,
                          "address1": "Hoofdstraat 12",
                          "address2": null,
                          "zipcode": "1234AB",
                          "city": "Amsterdam",
                          "country": "NL",
                          "phone": null,
                          "delivery_method": "Email",
                          "customer_id": "customer-1",
                          "tax_number": null,
                          "chamber_of_commerce": null,
                          "bank_account": null,
                          "is_trusted": false,
                          "max_transfer_amount": null,
                          "attention": null,
                          "email": "info@example.com",
                          "email_ubl": true,
                          "send_invoices_to_attention": null,
                          "send_invoices_to_email": "info@example.com",
                          "send_estimates_to_attention": null,
                          "send_estimates_to_email": "info@example.com",
                          "direct_debit": false,
                          "sepa_active": false,
                          "sepa_iban": null,
                          "sepa_iban_account_name": null,
                          "sepa_bic": null,
                          "sepa_mandate_id": null,
                          "sepa_mandate_date": null,
                          "sepa_sequence_type": "RCUR",
                          "credit_card_number": null,
                          "credit_card_reference": null,
                          "credit_card_type": null,
                          "tax_number_validated_at": null,
                          "tax_number_valid": null,
                          "invoice_workflow_id": null,
                          "estimate_workflow_id": null,
                          "si_identifier": null,
                          "si_identifier_type": null,
                          "moneybird_payments_mandate": false,
                          "created_at": "2026-11-02T12:16:18.261Z",
                          "updated_at": "2026-11-02T12:16:18.261Z",
                          "version": 1793621778,
                          "sales_invoices_url": "https://moneybird.dev/123/sales_invoices/0000000000000000000000000000000000000000000000000000000000000001/all",
                          "notes": [],
                          "custom_fields": [],
                          "contact_people": [],
                          "archived": false
                        },
                        "reference": "Lunch supermarket",
                        "date": "2026-11-02",
                        "due_date": null,
                        "entry_number": 3,
                        "state": "open",
                        "currency": "EUR",
                        "exchange_rate": "1.0",
                        "revenue_invoice": false,
                        "prices_are_incl_tax": true,
                        "origin": null,
                        "paid_at": null,
                        "tax_number": null,
                        "total_price_excl_tax": "247.93",
                        "total_price_excl_tax_base": "247.93",
                        "total_price_incl_tax": "300.0",
                        "total_price_incl_tax_base": "300.0",
                        "created_at": "2026-11-02T12:16:18.355Z",
                        "updated_at": "2026-11-02T12:16:18.359Z",
                        "version": 1793621778,
                        "details": [
                          {
                            "id": "502689176367400378",
                            "administration_id": 123,
                            "tax_rate_id": "502689108908311693",
                            "ledger_account_id": "502689108787725433",
                            "project_id": null,
                            "product_id": null,
                            "amount": null,
                            "amount_decimal": "1.0",
                            "description": "Delivery Apple iPad",
                            "price": "300.0",
                            "period": null,
                            "row_order": 0,
                            "total_price_excl_tax_with_discount": "247.93",
                            "total_price_excl_tax_with_discount_base": "247.93",
                            "tax_report_reference": [
                              "NL/5b"
                            ],
                            "mandatory_tax_text": null,
                            "created_at": "2026-11-02T12:16:18.358Z",
                            "updated_at": "2026-11-02T12:16:18.358Z"
                          }
                        ],
                        "fiscal_allocations": [],
                        "payments": [],
                        "notes": [],
                        "attachments": [],
                        "events": [
                          {
                            "administration_id": 123,
                            "user_id": "502689108256097381",
                            "action": "document_saved",
                            "link_entity_id": null,
                            "link_entity_type": null,
                            "data": {},
                            "created_at": "2026-11-02T12:16:18.362Z",
                            "updated_at": "2026-11-02T12:16:18.362Z"
                          }
                        ]
                      },
                      {
                        "id": "502689176395711941",
                        "administration_id": 123,
                        "contact_id": "502689176266737055",
                        "contact": {
                          "id": "502689176266737055",
                          "administration_id": 123,
                          "company_name": "Foobar Holding B.V.",
                          "firstname": null,
                          "lastname": null,
                          "address1": "Hoofdstraat 12",
                          "address2": null,
                          "zipcode": "1234AB",
                          "city": "Amsterdam",
                          "country": "NL",
                          "phone": null,
                          "delivery_method": "Email",
                          "customer_id": "customer-1",
                          "tax_number": null,
                          "chamber_of_commerce": null,
                          "bank_account": null,
                          "is_trusted": false,
                          "max_transfer_amount": null,
                          "attention": null,
                          "email": "info@example.com",
                          "email_ubl": true,
                          "send_invoices_to_attention": null,
                          "send_invoices_to_email": "info@example.com",
                          "send_estimates_to_attention": null,
                          "send_estimates_to_email": "info@example.com",
                          "direct_debit": false,
                          "sepa_active": false,
                          "sepa_iban": null,
                          "sepa_iban_account_name": null,
                          "sepa_bic": null,
                          "sepa_mandate_id": null,
                          "sepa_mandate_date": null,
                          "sepa_sequence_type": "RCUR",
                          "credit_card_number": null,
                          "credit_card_reference": null,
                          "credit_card_type": null,
                          "tax_number_validated_at": null,
                          "tax_number_valid": null,
                          "invoice_workflow_id": null,
                          "estimate_workflow_id": null,
                          "si_identifier": null,
                          "si_identifier_type": null,
                          "moneybird_payments_mandate": false,
                          "created_at": "2026-11-02T12:16:18.261Z",
                          "updated_at": "2026-11-02T12:16:18.261Z",
                          "version": 1793621778,
                          "sales_invoices_url": "https://moneybird.dev/123/sales_invoices/0000000000000000000000000000000000000000000000000000000000000001/all",
                          "notes": [],
                          "custom_fields": [],
                          "contact_people": [],
                          "archived": false
                        },
                        "reference": "Lunch supermarket",
                        "date": "2026-11-02",
                        "due_date": null,
                        "entry_number": 4,
                        "state": "open",
                        "currency": "EUR",
                        "exchange_rate": "1.0",
                        "revenue_invoice": false,
                        "prices_are_incl_tax": true,
                        "origin": null,
                        "paid_at": null,
                        "tax_number": null,
                        "total_price_excl_tax": "247.93",
                        "total_price_excl_tax_base": "247.93",
                        "total_price_incl_tax": "300.0",
                        "total_price_incl_tax_base": "300.0",
                        "created_at": "2026-11-02T12:16:18.385Z",
                        "updated_at": "2026-11-02T12:16:18.387Z",
                        "version": 1793621778,
                        "details": [
                          {
                            "id": "502689176397809094",
                            "administration_id": 123,
                            "tax_rate_id": "502689108908311693",
                            "ledger_account_id": "502689108787725433",
                            "project_id": null,
                            "product_id": null,
                            "amount": null,
                            "amount_decimal": "1.0",
                            "description": "Delivery Apple iPad",
                            "price": "300.0",
                            "period": null,
                            "row_order": 0,
                            "total_price_excl_tax_with_discount": "247.93",
                            "total_price_excl_tax_with_discount_base": "247.93",
                            "tax_report_reference": [
                              "NL/5b"
                            ],
                            "mandatory_tax_text": null,
                            "created_at": "2026-11-02T12:16:18.386Z",
                            "updated_at": "2026-11-02T12:16:18.386Z"
                          }
                        ],
                        "fiscal_allocations": [],
                        "payments": [],
                        "notes": [],
                        "attachments": [],
                        "events": [
                          {
                            "administration_id": 123,
                            "user_id": "502689108256097381",
                            "action": "document_saved",
                            "link_entity_id": null,
                            "link_entity_type": null,
                            "data": {},
                            "created_at": "2026-11-02T12:16:18.389Z",
                            "updated_at": "2026-11-02T12:16:18.389Z"
                          }
                        ]
                      }
                    ]
                  }
                }
              }
            }
          }
        },
        "operationId": "post_administration_id_documents_receipts_synchronization"
      }
    },
    "/{administration_id}/documents/receipts/{id}/attachments/{attachment_id}/download{format}": {
      "get": {
        "summary": "Download attachment",
        "description": "Download the attachment. The response will be a redirect to a temporarily available URL\nwhere the attachment can be downloaded. Use the `Location` header in the response\nto download the attachment.\n\n### Required scope(s)\n `documents`",
        "tags": [
          "Documents: Receipts"
        ],
        "security": [
          {
            "bearerAuth": [
              "documents"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/administration_id"
          },
          {
            "name": "id",
            "in": "path",
            "required": true,
            "schema": {
              "$ref": "#/components/schemas/identifier"
            }
          },
          {
            "name": "attachment_id",
            "in": "path",
            "required": true,
            "schema": {
              "$ref": "#/components/schemas/identifier"
            }
          },
          {
            "$ref": "#/components/parameters/format"
          }
        ],
        "responses": {
          "302": {
            "description": "Found",
            "content": {
              "text/plain": {
                "schema": {
                  "type": "string"
                },
                "examples": {
                  "DownloadsTheAttachment": {
                    "summary": "Downloads the attachment",
                    "value": "{\"message\":\"Use the Location header to download the attachment\"}"
                  }
                }
              }
            }
          },
          "404": {
            "$ref": "#/components/responses/404_not_found"
          }
        },
        "operationId": "get_administration_id_documents_receipts_id_attachments_attachment_id_download"
      }
    },
    "/{administration_id}/documents/receipts/{id}/attachments/{attachment_id}{format}": {
      "delete": {
        "summary": "Delete an attachment",
        "description": "Deletes an attachment of an attachable.\n\n### Required scope(s)\n `documents`",
        "tags": [
          "Documents: Receipts"
        ],
        "security": [
          {
            "bearerAuth": [
              "documents"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/administration_id"
          },
          {
            "name": "id",
            "in": "path",
            "required": true,
            "schema": {
              "$ref": "#/components/schemas/identifier"
            }
          },
          {
            "name": "attachment_id",
            "in": "path",
            "required": true,
            "schema": {
              "$ref": "#/components/schemas/identifier"
            }
          },
          {
            "$ref": "#/components/parameters/format"
          }
        ],
        "responses": {
          "204": {
            "description": "Attachment deleted"
          },
          "404": {
            "$ref": "#/components/responses/404_not_found"
          }
        },
        "operationId": "delete_administration_id_documents_receipts_id_attachments_attachment_id"
      }
    },
    "/{administration_id}/documents/receipts/{id}/attachments{format}": {
      "post": {
        "summary": "Add attachment to receipt",
        "description": "Add an attachment to a receipt.\n\n### Required scope(s)\n `documents`",
        "tags": [
          "Documents: Receipts"
        ],
        "security": [
          {
            "bearerAuth": [
              "documents"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/administration_id"
          },
          {
            "name": "id",
            "in": "path",
            "required": true,
            "schema": {
              "$ref": "#/components/schemas/identifier"
            }
          },
          {
            "$ref": "#/components/parameters/format"
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "multipart/form-data": {
              "schema": {
                "type": "object",
                "properties": {
                  "file": {
                    "type": "string",
                    "format": "binary"
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Status code",
            "content": {
              "application/json": {
                "schema": {
                  "type": "integer"
                },
                "examples": {
                  "UploadsAnAttachment": {
                    "summary": "Uploads an attachment",
                    "value": 200
                  }
                }
              }
            }
          },
          "400": {
            "$ref": "#/components/responses/400_bad_request"
          },
          "404": {
            "$ref": "#/components/responses/404_not_found"
          },
          "422": {
            "$ref": "#/components/responses/422_unprocessable_entity"
          }
        },
        "operationId": "post_administration_id_documents_receipts_id_attachments"
      }
    },
    "/{administration_id}/documents/receipts/{id}/payments/{payment_id}{format}": {
      "delete": {
        "summary": "Delete a payment",
        "description": "Deletes a payment from a receipt.\n\nWhen the payment is linked to a financial mutation, the token also needs the `bank` scope. Such a payment is\nunlinked from the mutation instead and stays on the receipt, unless it was created by linking it to that\nmutation. When the receipt itself was created from that mutation and is still new, the whole receipt is\ndeleted.\n\n### Required scope(s)\n `documents`",
        "tags": [
          "Documents: Receipts"
        ],
        "security": [
          {
            "bearerAuth": [
              "documents"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/administration_id"
          },
          {
            "name": "id",
            "in": "path",
            "required": true,
            "schema": {
              "$ref": "#/components/schemas/identifier"
            }
          },
          {
            "name": "payment_id",
            "in": "path",
            "required": true,
            "schema": {
              "$ref": "#/components/schemas/identifier"
            }
          },
          {
            "$ref": "#/components/parameters/format"
          }
        ],
        "responses": {
          "204": {
            "description": "Payment deleted"
          },
          "404": {
            "$ref": "#/components/responses/404_not_found"
          },
          "422": {
            "$ref": "#/components/responses/422_unprocessable_entity"
          }
        },
        "operationId": "delete_administration_id_documents_receipts_id_payments_payment_id"
      }
    },
    "/{administration_id}/documents/receipts/{id}/payments{format}": {
      "post": {
        "summary": "Create a payment",
        "description": "Registers a payment for a receipt.\n\nA `cash_payment` with `financial_account_id` and without `financial_mutation_id` also needs the `bank` scope.\n\n### Required scope(s)\n `documents`",
        "tags": [
          "Documents: Receipts"
        ],
        "security": [
          {
            "bearerAuth": [
              "documents"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/administration_id"
          },
          {
            "name": "id",
            "in": "path",
            "required": true,
            "schema": {
              "$ref": "#/components/schemas/identifier"
            }
          },
          {
            "$ref": "#/components/parameters/format"
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/*": {
              "schema": {
                "unevaluatedProperties": false,
                "type": "object",
                "properties": {
                  "payment": {
                    "type": "object",
                    "unevaluatedProperties": false,
                    "properties": {
                      "payment_date": {
                        "type": "string",
                        "description": "The date on which the payment was made."
                      },
                      "price": {
                        "$ref": "#/components/schemas/money",
                        "description": "The amount paid in the document's currency."
                      },
                      "price_base": {
                        "$ref": "#/components/schemas/money",
                        "description": "Amount paid expressed in the base currency of the administration. Required when the document uses a different currency than the administration's base currency."
                      },
                      "financial_account_id": {
                        "$ref": "#/components/schemas/identifier",
                        "description": "The ID of the financial account (bank account or cash register) associated with this payment. Required for `private_payment` and `cash_payment` actions. Should be a valid financial account id."
                      },
                      "financial_mutation_id": {
                        "$ref": "#/components/schemas/identifier",
                        "description": "The ID of the bank transaction to link this payment to. Required for `bank_transfer` actions. Should be a valid financial mutation id."
                      },
                      "transaction_identifier": {
                        "type": "string",
                        "description": "An external transaction reference, e.g. a bank transaction ID or PSP reference. Used to match the payment with financial mutations."
                      },
                      "manual_payment_action": {
                        "type": "string",
                        "description": "Can be `private_payment` (needs financial_account_id), `payment_without_proof`, `cash_payment` (needs financial_account_id), `rounding_error`, `bank_transfer` (needs financial_mutation_id), `balance_settlement` (needs ledger_account_id) or `invoices_settlement` (needs invoice_id). `payment_without_proof` is only accepted when the administration allows payments without proof."
                      },
                      "ledger_account_id": {
                        "$ref": "#/components/schemas/identifier",
                        "description": "The ID of the ledger account to book this payment to. Required for `balance_settlement` actions. Should be a valid ledger account id."
                      },
                      "invoice_id": {
                        "$ref": "#/components/schemas/identifier",
                        "description": "The ID of the document to settle this payment against. Required for `invoices_settlement` actions. Should be a valid document id (sales invoice, purchase invoice, receipt, etc.)."
                      }
                    },
                    "required": [
                      "payment_date",
                      "price"
                    ]
                  }
                },
                "required": []
              },
              "examples": {
                "CreateAPayment": {
                  "summary": "Create a payment",
                  "value": {
                    "payment": {
                      "payment_date": "2026-11-02T12:16:20.751Z",
                      "price": "300.0"
                    }
                  }
                }
              }
            }
          }
        },
        "responses": {
          "201": {
            "description": "Payment created",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/payment_response"
                },
                "examples": {
                  "CreateAPayment": {
                    "summary": "Create a payment",
                    "value": {
                      "id": "502689178892371103",
                      "administration_id": 123,
                      "invoice_type": "Document",
                      "invoice_id": "502689178826310791",
                      "financial_account_id": null,
                      "user_id": "502689108256097381",
                      "payment_transaction_id": null,
                      "transaction_identifier": null,
                      "price": "300.0",
                      "price_base": "300.0",
                      "payment_date": "2026-11-02",
                      "credit_invoice_id": null,
                      "financial_mutation_id": null,
                      "ledger_account_id": "502689108803454082",
                      "linked_payment_id": null,
                      "manual_payment_action": null,
                      "created_at": "2026-11-02T12:16:20.766Z",
                      "updated_at": "2026-11-02T12:16:20.766Z"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "$ref": "#/components/responses/400_bad_request"
          },
          "404": {
            "$ref": "#/components/responses/404_not_found"
          },
          "422": {
            "$ref": "#/components/responses/422_unprocessable_entity"
          }
        },
        "operationId": "post_administration_id_documents_receipts_id_payments"
      }
    },
    "/{administration_id}/documents/receipts/{id}/register_payment{format}": {
      "patch": {
        "summary": "Register a payment for a receipt",
        "description": "This endpoint is deprecated and should no longer be used. It has been replaced by `Create a payment`.\n\n### Required scope(s)\n `documents`",
        "deprecated": true,
        "x-sunset": "2026-12-31",
        "tags": [
          "Documents: Receipts"
        ],
        "security": [
          {
            "bearerAuth": [
              "documents"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/administration_id"
          },
          {
            "name": "id",
            "in": "path",
            "required": true,
            "schema": {
              "$ref": "#/components/schemas/identifier"
            }
          },
          {
            "$ref": "#/components/parameters/format"
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/*": {
              "schema": {
                "unevaluatedProperties": false,
                "type": "object",
                "properties": {
                  "payment": {
                    "type": "object",
                    "unevaluatedProperties": false,
                    "properties": {
                      "payment_date": {
                        "type": "string"
                      },
                      "price": {
                        "$ref": "#/components/schemas/money"
                      },
                      "price_base": {
                        "$ref": "#/components/schemas/money",
                        "description": "Amount paid expressed in the base currency. Required for foreign currencies."
                      },
                      "financial_account_id": {
                        "$ref": "#/components/schemas/identifier",
                        "description": "Should be a valid financial account id."
                      },
                      "financial_mutation_id": {
                        "$ref": "#/components/schemas/identifier",
                        "description": "Should be a valid financial mutation id."
                      },
                      "transaction_identifier": {
                        "type": "string"
                      },
                      "manual_payment_action": {
                        "type": "string",
                        "description": "Can be `private_payment`, `payment_without_proof`, `cash_payment`, `rounding_error`, `bank_transfer`, `balance_settlement` or `invoices_settlement`."
                      },
                      "ledger_account_id": {
                        "$ref": "#/components/schemas/identifier",
                        "description": "Should be a valid ledger account id."
                      },
                      "invoice_id": {
                        "$ref": "#/components/schemas/identifier"
                      }
                    },
                    "required": [
                      "payment_date",
                      "price"
                    ]
                  }
                },
                "required": []
              },
              "examples": {
                "RegistersPayments": {
                  "summary": "Registers payments",
                  "value": {
                    "payment": {
                      "payment_date": "2026-11-02T12:16:25.499Z",
                      "price": "300.0"
                    }
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Status code",
            "content": {
              "application/json": {
                "schema": {
                  "type": "integer"
                },
                "examples": {
                  "RegistersPayments": {
                    "summary": "Registers payments",
                    "value": 200
                  }
                }
              }
            }
          },
          "400": {
            "$ref": "#/components/responses/400_bad_request"
          },
          "404": {
            "$ref": "#/components/responses/404_not_found"
          }
        },
        "operationId": "patch_administration_id_documents_receipts_id_register_payment"
      }
    },
    "/{administration_id}/documents/receipts/{id}{format}": {
      "get": {
        "summary": "Get a receipt",
        "description": "Returns a receipt by id.\n\n### Required scope(s)\n `documents`",
        "tags": [
          "Documents: Receipts"
        ],
        "security": [
          {
            "bearerAuth": [
              "documents"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/administration_id"
          },
          {
            "name": "id",
            "in": "path",
            "required": true,
            "schema": {
              "$ref": "#/components/schemas/identifier"
            }
          },
          {
            "$ref": "#/components/parameters/format"
          }
        ],
        "responses": {
          "200": {
            "description": "A receipt",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/receipt_response"
                },
                "examples": {
                  "ReturnsTheWantedReceipt": {
                    "summary": "Returns the wanted receipt",
                    "value": {
                      "id": "502689182380984202",
                      "administration_id": 123,
                      "contact_id": "502689182353721224",
                      "contact": {
                        "id": "502689182353721224",
                        "administration_id": 123,
                        "company_name": "Foobar Holding B.V.",
                        "firstname": null,
                        "lastname": null,
                        "address1": "Hoofdstraat 12",
                        "address2": null,
                        "zipcode": "1234AB",
                        "city": "Amsterdam",
                        "country": "NL",
                        "phone": null,
                        "delivery_method": "Email",
                        "customer_id": "customer-1",
                        "tax_number": null,
                        "chamber_of_commerce": null,
                        "bank_account": null,
                        "is_trusted": false,
                        "max_transfer_amount": null,
                        "attention": null,
                        "email": "info@example.com",
                        "email_ubl": true,
                        "send_invoices_to_attention": null,
                        "send_invoices_to_email": "info@example.com",
                        "send_estimates_to_attention": null,
                        "send_estimates_to_email": "info@example.com",
                        "direct_debit": false,
                        "sepa_active": false,
                        "sepa_iban": null,
                        "sepa_iban_account_name": null,
                        "sepa_bic": null,
                        "sepa_mandate_id": null,
                        "sepa_mandate_date": null,
                        "sepa_sequence_type": "RCUR",
                        "credit_card_number": null,
                        "credit_card_reference": null,
                        "credit_card_type": null,
                        "tax_number_validated_at": null,
                        "tax_number_valid": null,
                        "invoice_workflow_id": null,
                        "estimate_workflow_id": null,
                        "si_identifier": null,
                        "si_identifier_type": null,
                        "moneybird_payments_mandate": false,
                        "created_at": "2026-11-02T12:16:24.065Z",
                        "updated_at": "2026-11-02T12:16:24.065Z",
                        "version": 1793621784,
                        "sales_invoices_url": "https://moneybird.dev/123/sales_invoices/0000000000000000000000000000000000000000000000000000000000000001/all",
                        "notes": [],
                        "custom_fields": [],
                        "contact_people": [],
                        "archived": false
                      },
                      "reference": "Lunch supermarket",
                      "date": "2026-11-02",
                      "due_date": null,
                      "entry_number": 1,
                      "state": "open",
                      "currency": "EUR",
                      "exchange_rate": "1.0",
                      "revenue_invoice": false,
                      "prices_are_incl_tax": true,
                      "origin": null,
                      "paid_at": null,
                      "tax_number": null,
                      "total_price_excl_tax": "247.93",
                      "total_price_excl_tax_base": "247.93",
                      "total_price_incl_tax": "300.0",
                      "total_price_incl_tax_base": "300.0",
                      "created_at": "2026-11-02T12:16:24.092Z",
                      "updated_at": "2026-11-02T12:16:24.096Z",
                      "version": 1793621784,
                      "details": [
                        {
                          "id": "502689182383081355",
                          "administration_id": 123,
                          "tax_rate_id": "502689108908311693",
                          "ledger_account_id": "502689108787725433",
                          "project_id": null,
                          "product_id": null,
                          "amount": null,
                          "amount_decimal": "1.0",
                          "description": "Delivery Apple iPad",
                          "price": "300.0",
                          "period": null,
                          "row_order": 0,
                          "total_price_excl_tax_with_discount": "247.93",
                          "total_price_excl_tax_with_discount_base": "247.93",
                          "tax_report_reference": [
                            "NL/5b"
                          ],
                          "mandatory_tax_text": null,
                          "created_at": "2026-11-02T12:16:24.094Z",
                          "updated_at": "2026-11-02T12:16:24.094Z"
                        }
                      ],
                      "fiscal_allocations": [],
                      "payments": [],
                      "notes": [],
                      "attachments": [],
                      "events": [
                        {
                          "administration_id": 123,
                          "user_id": "502689108256097381",
                          "action": "document_saved",
                          "link_entity_id": null,
                          "link_entity_type": null,
                          "data": {},
                          "created_at": "2026-11-02T12:16:24.099Z",
                          "updated_at": "2026-11-02T12:16:24.099Z"
                        }
                      ]
                    }
                  },
                  "IncludesFiscalAllocations": {
                    "summary": "Includes fiscal allocations",
                    "value": {
                      "id": "502689182805656581",
                      "administration_id": 123,
                      "contact_id": "502689182717577195",
                      "contact": {
                        "id": "502689182717577195",
                        "administration_id": 123,
                        "company_name": "Foobar Holding B.V.",
                        "firstname": null,
                        "lastname": null,
                        "address1": "Hoofdstraat 12",
                        "address2": null,
                        "zipcode": "1234AB",
                        "city": "Amsterdam",
                        "country": "NL",
                        "phone": null,
                        "delivery_method": "Email",
                        "customer_id": "customer-1",
                        "tax_number": null,
                        "chamber_of_commerce": null,
                        "bank_account": null,
                        "is_trusted": false,
                        "max_transfer_amount": null,
                        "attention": null,
                        "email": "info@example.com",
                        "email_ubl": true,
                        "send_invoices_to_attention": null,
                        "send_invoices_to_email": "info@example.com",
                        "send_estimates_to_attention": null,
                        "send_estimates_to_email": "info@example.com",
                        "direct_debit": false,
                        "sepa_active": false,
                        "sepa_iban": null,
                        "sepa_iban_account_name": null,
                        "sepa_bic": null,
                        "sepa_mandate_id": null,
                        "sepa_mandate_date": null,
                        "sepa_sequence_type": "RCUR",
                        "credit_card_number": null,
                        "credit_card_reference": null,
                        "credit_card_type": null,
                        "tax_number_validated_at": null,
                        "tax_number_valid": null,
                        "invoice_workflow_id": null,
                        "estimate_workflow_id": null,
                        "si_identifier": null,
                        "si_identifier_type": null,
                        "moneybird_payments_mandate": false,
                        "created_at": "2026-11-02T12:16:24.413Z",
                        "updated_at": "2026-11-02T12:16:24.413Z",
                        "version": 1793621784,
                        "sales_invoices_url": "https://moneybird.dev/123/sales_invoices/0000000000000000000000000000000000000000000000000000000000000001/all",
                        "notes": [],
                        "custom_fields": [],
                        "contact_people": [],
                        "archived": false
                      },
                      "reference": "Lunch supermarket",
                      "date": "2026-11-02",
                      "due_date": null,
                      "entry_number": 3,
                      "state": "open",
                      "currency": "EUR",
                      "exchange_rate": "1.0",
                      "revenue_invoice": false,
                      "prices_are_incl_tax": true,
                      "origin": null,
                      "paid_at": null,
                      "tax_number": null,
                      "total_price_excl_tax": "247.93",
                      "total_price_excl_tax_base": "247.93",
                      "total_price_incl_tax": "300.0",
                      "total_price_incl_tax_base": "300.0",
                      "created_at": "2026-11-02T12:16:24.497Z",
                      "updated_at": "2026-11-02T12:16:24.500Z",
                      "version": 1793621784,
                      "details": [
                        {
                          "id": "502689182806705158",
                          "administration_id": 123,
                          "tax_rate_id": "502689108908311693",
                          "ledger_account_id": "502689108787725433",
                          "project_id": null,
                          "product_id": null,
                          "amount": null,
                          "amount_decimal": "1.0",
                          "description": "Delivery Apple iPad",
                          "price": "300.0",
                          "period": null,
                          "row_order": 0,
                          "total_price_excl_tax_with_discount": "247.93",
                          "total_price_excl_tax_with_discount_base": "247.93",
                          "tax_report_reference": [
                            "NL/5b"
                          ],
                          "mandatory_tax_text": null,
                          "created_at": "2026-11-02T12:16:24.499Z",
                          "updated_at": "2026-11-02T12:16:24.499Z"
                        }
                      ],
                      "fiscal_allocations": [
                        {
                          "id": "502689182823482386",
                          "administration_id": 123,
                          "ledger_account_id": "502689108787725433",
                          "private_ledger_account_id": "502689182821385233",
                          "percentage": "25.0",
                          "price": "75.0",
                          "price_base": "75.0",
                          "created_at": "2026-11-02T12:16:24.515Z",
                          "updated_at": "2026-11-02T12:16:24.515Z"
                        }
                      ],
                      "payments": [],
                      "notes": [],
                      "attachments": [],
                      "events": [
                        {
                          "administration_id": 123,
                          "user_id": "502689108256097381",
                          "action": "document_saved",
                          "link_entity_id": null,
                          "link_entity_type": null,
                          "data": {},
                          "created_at": "2026-11-02T12:16:24.501Z",
                          "updated_at": "2026-11-02T12:16:24.501Z"
                        }
                      ]
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Not found",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/symbolic_error"
                },
                "examples": {
                  "OnlyReturnsReceipts": {
                    "summary": "Only returns receipts",
                    "value": {
                      "error": "Record not found for model name: Receipt"
                    }
                  }
                }
              }
            }
          }
        },
        "operationId": "get_administration_id_documents_receipts_id"
      },
      "delete": {
        "summary": "Delete a receipts",
        "description": "Deletes a receipt.\n\n### Required scope(s)\n `documents`",
        "tags": [
          "Documents: Receipts"
        ],
        "security": [
          {
            "bearerAuth": [
              "documents"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/administration_id"
          },
          {
            "name": "id",
            "in": "path",
            "required": true,
            "schema": {
              "$ref": "#/components/schemas/identifier"
            }
          },
          {
            "$ref": "#/components/parameters/format"
          }
        ],
        "responses": {
          "200": {
            "description": "Status code",
            "content": {
              "application/json": {
                "schema": {
                  "type": "integer"
                },
                "examples": {
                  "DeletesTheReceipt": {
                    "summary": "Deletes the receipt",
                    "value": 200
                  }
                }
              }
            }
          },
          "404": {
            "$ref": "#/components/responses/404_not_found"
          },
          "422": {
            "$ref": "#/components/responses/422_unprocessable_entity"
          }
        },
        "operationId": "delete_administration_id_documents_receipts_id"
      },
      "patch": {
        "summary": "Update a receipt",
        "description": "Updates a receipt.\n\n### Required scope(s)\n `documents`",
        "tags": [
          "Documents: Receipts"
        ],
        "security": [
          {
            "bearerAuth": [
              "documents"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/administration_id"
          },
          {
            "name": "id",
            "in": "path",
            "required": true,
            "schema": {
              "$ref": "#/components/schemas/identifier"
            }
          },
          {
            "$ref": "#/components/parameters/format"
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/*": {
              "schema": {
                "unevaluatedProperties": false,
                "type": "object",
                "properties": {
                  "receipt": {
                    "type": "object",
                    "unevaluatedProperties": false,
                    "properties": {
                      "contact_id": {
                        "$ref": "#/components/schemas/identifier",
                        "description": "Should be a valid contact id."
                      },
                      "reference": {
                        "type": "string",
                        "description": "A reference for this receipt, e.g. a receipt number or supplier name."
                      },
                      "date": {
                        "type": "string",
                        "description": "The date of the receipt.",
                        "format": "date"
                      },
                      "currency": {
                        "type": "string",
                        "description": "ISO three-character currency code, e.g. EUR or USD."
                      },
                      "prices_are_incl_tax": {
                        "type": [
                          "boolean",
                          "string"
                        ],
                        "description": "Whether the prices on the receipt are inclusive of tax."
                      },
                      "details_attributes": {
                        "$ref": "#/components/schemas/details_attributes"
                      },
                      "fiscal_allocations_attributes": {
                        "$ref": "#/components/schemas/fiscal_allocations_attributes"
                      }
                    },
                    "required": []
                  },
                  "payment": {
                    "type": "object",
                    "unevaluatedProperties": false,
                    "properties": {
                      "financial_account_id": {
                        "$ref": "#/components/schemas/identifier",
                        "description": "Should be a valid financial account id."
                      }
                    },
                    "required": []
                  }
                },
                "required": []
              },
              "examples": {
                "UpdatesTheReceiptDetails": {
                  "summary": "Updates the receipt details",
                  "value": {
                    "receipt": {
                      "details_attributes": {
                        "0": {
                          "id": 502689181149955650,
                          "description": "updated description",
                          "price": 20
                        }
                      }
                    }
                  }
                },
                "UpdatesTheReceipt": {
                  "summary": "Updates the receipt",
                  "value": {
                    "receipt": {
                      "reference": "updated reference"
                    }
                  }
                },
                "RemovesAFiscalAllocationWithDestroy": {
                  "summary": "Removes a fiscal allocation with  destroy",
                  "value": {
                    "receipt": {
                      "fiscal_allocations_attributes": {
                        "0": {
                          "id": 502689182974477400,
                          "_destroy": true
                        }
                      }
                    }
                  }
                },
                "AddsFiscalAllocationsToAnExistingDocument": {
                  "summary": "Adds fiscal allocations to an existing document",
                  "value": {
                    "receipt": {
                      "fiscal_allocations_attributes": [
                        {
                          "ledger_account_id": 502689108787725440,
                          "private_ledger_account_id": 502689183127569540,
                          "percentage": "40"
                        }
                      ]
                    }
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Receipt updated",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/receipt_response"
                },
                "examples": {
                  "UpdatesTheReceiptDetails": {
                    "summary": "Updates the receipt details",
                    "value": {
                      "id": "502689181148907078",
                      "administration_id": 123,
                      "contact_id": "502689181132129860",
                      "contact": {
                        "id": "502689181132129860",
                        "administration_id": 123,
                        "company_name": "Foobar Holding B.V.",
                        "firstname": null,
                        "lastname": null,
                        "address1": "Hoofdstraat 12",
                        "address2": null,
                        "zipcode": "1234AB",
                        "city": "Amsterdam",
                        "country": "NL",
                        "phone": null,
                        "delivery_method": "Email",
                        "customer_id": "customer-1",
                        "tax_number": null,
                        "chamber_of_commerce": null,
                        "bank_account": null,
                        "is_trusted": false,
                        "max_transfer_amount": null,
                        "attention": null,
                        "email": "info@example.com",
                        "email_ubl": true,
                        "send_invoices_to_attention": null,
                        "send_invoices_to_email": "info@example.com",
                        "send_estimates_to_attention": null,
                        "send_estimates_to_email": "info@example.com",
                        "direct_debit": false,
                        "sepa_active": false,
                        "sepa_iban": null,
                        "sepa_iban_account_name": null,
                        "sepa_bic": null,
                        "sepa_mandate_id": null,
                        "sepa_mandate_date": null,
                        "sepa_sequence_type": "RCUR",
                        "credit_card_number": null,
                        "credit_card_reference": null,
                        "credit_card_type": null,
                        "tax_number_validated_at": null,
                        "tax_number_valid": null,
                        "invoice_workflow_id": null,
                        "estimate_workflow_id": null,
                        "si_identifier": null,
                        "si_identifier_type": null,
                        "moneybird_payments_mandate": false,
                        "created_at": "2026-11-02T12:16:22.901Z",
                        "updated_at": "2026-11-02T12:16:22.901Z",
                        "version": 1793621782,
                        "sales_invoices_url": "https://moneybird.dev/123/sales_invoices/0000000000000000000000000000000000000000000000000000000000000001/all",
                        "notes": [],
                        "custom_fields": [],
                        "contact_people": [],
                        "archived": false
                      },
                      "reference": "Lunch supermarket",
                      "date": "2026-11-02",
                      "due_date": null,
                      "entry_number": 1,
                      "state": "open",
                      "currency": "EUR",
                      "exchange_rate": "1.0",
                      "revenue_invoice": false,
                      "prices_are_incl_tax": true,
                      "origin": null,
                      "paid_at": null,
                      "tax_number": null,
                      "total_price_excl_tax": "16.53",
                      "total_price_excl_tax_base": "16.53",
                      "total_price_incl_tax": "20.0",
                      "total_price_incl_tax_base": "20.0",
                      "created_at": "2026-11-02T12:16:22.917Z",
                      "updated_at": "2026-11-02T12:16:23.103Z",
                      "version": 1793621783,
                      "details": [
                        {
                          "id": "502689181149955655",
                          "administration_id": 123,
                          "tax_rate_id": "502689108908311693",
                          "ledger_account_id": "502689108787725433",
                          "project_id": null,
                          "product_id": null,
                          "amount": null,
                          "amount_decimal": "1.0",
                          "description": "updated description",
                          "price": "20.0",
                          "period": null,
                          "row_order": 0,
                          "total_price_excl_tax_with_discount": "16.53",
                          "total_price_excl_tax_with_discount_base": "16.53",
                          "tax_report_reference": [
                            "NL/5b"
                          ],
                          "mandatory_tax_text": null,
                          "created_at": "2026-11-02T12:16:22.919Z",
                          "updated_at": "2026-11-02T12:16:23.100Z"
                        }
                      ],
                      "fiscal_allocations": [],
                      "payments": [],
                      "notes": [],
                      "attachments": [],
                      "events": [
                        {
                          "administration_id": 123,
                          "user_id": "502689108256097381",
                          "action": "document_saved",
                          "link_entity_id": null,
                          "link_entity_type": null,
                          "data": {},
                          "created_at": "2026-11-02T12:16:22.922Z",
                          "updated_at": "2026-11-02T12:16:22.922Z"
                        },
                        {
                          "administration_id": 123,
                          "user_id": "502689108256097381",
                          "action": "document_updated",
                          "link_entity_id": null,
                          "link_entity_type": null,
                          "data": {
                            "changes": {
                              "total_price_excl_tax": [
                                "247.93",
                                "16.53"
                              ],
                              "total_price_excl_tax_base": [
                                "247.93",
                                "16.53"
                              ],
                              "total_price_incl_tax": [
                                "300.0",
                                "20.0"
                              ],
                              "total_price_incl_tax_base": [
                                "300.0",
                                "20.0"
                              ],
                              "cached_taxes": [
                                [
                                  {
                                    "tax_rate_id": "502689108908311693",
                                    "report_reference": "NL/5b",
                                    "payable": false,
                                    "debit": "52.07",
                                    "credit": 0
                                  }
                                ],
                                [
                                  {
                                    "tax_rate_id": "502689108908311693",
                                    "report_reference": "NL/5b",
                                    "payable": false,
                                    "debit": "3.47",
                                    "credit": 0
                                  }
                                ]
                              ],
                              "updated_at": [
                                "2026-11-02T13:16:22.920+01:00",
                                "2026-11-02T13:16:23.098+01:00"
                              ]
                            },
                            "detail_changes": [
                              {
                                "id": "502689181149955655",
                                "change": "updated",
                                "description": [
                                  "Delivery Apple iPad",
                                  "updated description"
                                ],
                                "price": [
                                  "300.0",
                                  "20.0"
                                ]
                              }
                            ]
                          },
                          "created_at": "2026-11-02T12:16:23.105Z",
                          "updated_at": "2026-11-02T12:16:23.105Z"
                        }
                      ]
                    }
                  },
                  "UpdatesTheReceipt": {
                    "summary": "Updates the receipt",
                    "value": {
                      "id": "502689181644883626",
                      "administration_id": 123,
                      "contact_id": "502689181618669224",
                      "contact": {
                        "id": "502689181618669224",
                        "administration_id": 123,
                        "company_name": "Foobar Holding B.V.",
                        "firstname": null,
                        "lastname": null,
                        "address1": "Hoofdstraat 12",
                        "address2": null,
                        "zipcode": "1234AB",
                        "city": "Amsterdam",
                        "country": "NL",
                        "phone": null,
                        "delivery_method": "Email",
                        "customer_id": "customer-1",
                        "tax_number": null,
                        "chamber_of_commerce": null,
                        "bank_account": null,
                        "is_trusted": false,
                        "max_transfer_amount": null,
                        "attention": null,
                        "email": "info@example.com",
                        "email_ubl": true,
                        "send_invoices_to_attention": null,
                        "send_invoices_to_email": "info@example.com",
                        "send_estimates_to_attention": null,
                        "send_estimates_to_email": "info@example.com",
                        "direct_debit": false,
                        "sepa_active": false,
                        "sepa_iban": null,
                        "sepa_iban_account_name": null,
                        "sepa_bic": null,
                        "sepa_mandate_id": null,
                        "sepa_mandate_date": null,
                        "sepa_sequence_type": "RCUR",
                        "credit_card_number": null,
                        "credit_card_reference": null,
                        "credit_card_type": null,
                        "tax_number_validated_at": null,
                        "tax_number_valid": null,
                        "invoice_workflow_id": null,
                        "estimate_workflow_id": null,
                        "si_identifier": null,
                        "si_identifier_type": null,
                        "moneybird_payments_mandate": false,
                        "created_at": "2026-11-02T12:16:23.365Z",
                        "updated_at": "2026-11-02T12:16:23.365Z",
                        "version": 1793621783,
                        "sales_invoices_url": "https://moneybird.dev/123/sales_invoices/0000000000000000000000000000000000000000000000000000000000000001/all",
                        "notes": [],
                        "custom_fields": [],
                        "contact_people": [],
                        "archived": false
                      },
                      "reference": "updated reference",
                      "date": "2026-11-02",
                      "due_date": null,
                      "entry_number": 1,
                      "state": "open",
                      "currency": "EUR",
                      "exchange_rate": "1.0",
                      "revenue_invoice": false,
                      "prices_are_incl_tax": true,
                      "origin": null,
                      "paid_at": null,
                      "tax_number": null,
                      "total_price_excl_tax": "247.93",
                      "total_price_excl_tax_base": "247.93",
                      "total_price_incl_tax": "300.0",
                      "total_price_incl_tax_base": "300.0",
                      "created_at": "2026-11-02T12:16:23.390Z",
                      "updated_at": "2026-11-02T12:16:23.460Z",
                      "version": 1793621783,
                      "details": [
                        {
                          "id": "502689181645932203",
                          "administration_id": 123,
                          "tax_rate_id": "502689108908311693",
                          "ledger_account_id": "502689108787725433",
                          "project_id": null,
                          "product_id": null,
                          "amount": null,
                          "amount_decimal": "1.0",
                          "description": "Delivery Apple iPad",
                          "price": "300.0",
                          "period": null,
                          "row_order": 0,
                          "total_price_excl_tax_with_discount": "247.93",
                          "total_price_excl_tax_with_discount_base": "247.93",
                          "tax_report_reference": [
                            "NL/5b"
                          ],
                          "mandatory_tax_text": null,
                          "created_at": "2026-11-02T12:16:23.392Z",
                          "updated_at": "2026-11-02T12:16:23.392Z"
                        }
                      ],
                      "fiscal_allocations": [],
                      "payments": [],
                      "notes": [],
                      "attachments": [],
                      "events": [
                        {
                          "administration_id": 123,
                          "user_id": "502689108256097381",
                          "action": "document_saved",
                          "link_entity_id": null,
                          "link_entity_type": null,
                          "data": {},
                          "created_at": "2026-11-02T12:16:23.398Z",
                          "updated_at": "2026-11-02T12:16:23.398Z"
                        },
                        {
                          "administration_id": 123,
                          "user_id": "502689108256097381",
                          "action": "document_updated",
                          "link_entity_id": null,
                          "link_entity_type": null,
                          "data": {
                            "changes": {
                              "reference": [
                                "Lunch supermarket",
                                "updated reference"
                              ],
                              "updated_at": [
                                "2026-11-02T13:16:23.393+01:00",
                                "2026-11-02T13:16:23.460+01:00"
                              ]
                            }
                          },
                          "created_at": "2026-11-02T12:16:23.463Z",
                          "updated_at": "2026-11-02T12:16:23.463Z"
                        }
                      ]
                    }
                  },
                  "RemovesAFiscalAllocationWithDestroy": {
                    "summary": "Removes a fiscal allocation with  destroy",
                    "value": {
                      "id": "502689182952457262",
                      "administration_id": 123,
                      "contact_id": "502689182864376852",
                      "contact": {
                        "id": "502689182864376852",
                        "administration_id": 123,
                        "company_name": "Foobar Holding B.V.",
                        "firstname": null,
                        "lastname": null,
                        "address1": "Hoofdstraat 12",
                        "address2": null,
                        "zipcode": "1234AB",
                        "city": "Amsterdam",
                        "country": "NL",
                        "phone": null,
                        "delivery_method": "Email",
                        "customer_id": "customer-1",
                        "tax_number": null,
                        "chamber_of_commerce": null,
                        "bank_account": null,
                        "is_trusted": false,
                        "max_transfer_amount": null,
                        "attention": null,
                        "email": "info@example.com",
                        "email_ubl": true,
                        "send_invoices_to_attention": null,
                        "send_invoices_to_email": "info@example.com",
                        "send_estimates_to_attention": null,
                        "send_estimates_to_email": "info@example.com",
                        "direct_debit": false,
                        "sepa_active": false,
                        "sepa_iban": null,
                        "sepa_iban_account_name": null,
                        "sepa_bic": null,
                        "sepa_mandate_id": null,
                        "sepa_mandate_date": null,
                        "sepa_sequence_type": "RCUR",
                        "credit_card_number": null,
                        "credit_card_reference": null,
                        "credit_card_type": null,
                        "tax_number_validated_at": null,
                        "tax_number_valid": null,
                        "invoice_workflow_id": null,
                        "estimate_workflow_id": null,
                        "si_identifier": null,
                        "si_identifier_type": null,
                        "moneybird_payments_mandate": false,
                        "created_at": "2026-11-02T12:16:24.553Z",
                        "updated_at": "2026-11-02T12:16:24.553Z",
                        "version": 1793621784,
                        "sales_invoices_url": "https://moneybird.dev/123/sales_invoices/0000000000000000000000000000000000000000000000000000000000000001/all",
                        "notes": [],
                        "custom_fields": [],
                        "contact_people": [],
                        "archived": false
                      },
                      "reference": "Lunch supermarket",
                      "date": "2026-11-02",
                      "due_date": null,
                      "entry_number": 3,
                      "state": "open",
                      "currency": "EUR",
                      "exchange_rate": "1.0",
                      "revenue_invoice": false,
                      "prices_are_incl_tax": true,
                      "origin": null,
                      "paid_at": null,
                      "tax_number": null,
                      "total_price_excl_tax": "247.93",
                      "total_price_excl_tax_base": "247.93",
                      "total_price_incl_tax": "300.0",
                      "total_price_incl_tax_base": "300.0",
                      "created_at": "2026-11-02T12:16:24.637Z",
                      "updated_at": "2026-11-02T12:16:24.640Z",
                      "version": 1793621784,
                      "details": [
                        {
                          "id": "502689182954554415",
                          "administration_id": 123,
                          "tax_rate_id": "502689108908311693",
                          "ledger_account_id": "502689108787725433",
                          "project_id": null,
                          "product_id": null,
                          "amount": null,
                          "amount_decimal": "1.0",
                          "description": "Delivery Apple iPad",
                          "price": "300.0",
                          "period": null,
                          "row_order": 0,
                          "total_price_excl_tax_with_discount": "247.93",
                          "total_price_excl_tax_with_discount_base": "247.93",
                          "tax_report_reference": [
                            "NL/5b"
                          ],
                          "mandatory_tax_text": null,
                          "created_at": "2026-11-02T12:16:24.639Z",
                          "updated_at": "2026-11-02T12:16:24.639Z"
                        }
                      ],
                      "fiscal_allocations": [],
                      "payments": [],
                      "notes": [],
                      "attachments": [],
                      "events": [
                        {
                          "administration_id": 123,
                          "user_id": "502689108256097381",
                          "action": "document_saved",
                          "link_entity_id": null,
                          "link_entity_type": null,
                          "data": {},
                          "created_at": "2026-11-02T12:16:24.642Z",
                          "updated_at": "2026-11-02T12:16:24.642Z"
                        },
                        {
                          "administration_id": 123,
                          "user_id": "502689108256097381",
                          "action": "document_updated",
                          "link_entity_id": null,
                          "link_entity_type": null,
                          "data": {
                            "changes": {}
                          },
                          "created_at": "2026-11-02T12:16:24.682Z",
                          "updated_at": "2026-11-02T12:16:24.682Z"
                        }
                      ]
                    }
                  },
                  "AddsFiscalAllocationsToAnExistingDocument": {
                    "summary": "Adds fiscal allocations to an existing document",
                    "value": {
                      "id": "502689183110792298",
                      "administration_id": 123,
                      "contact_id": "502689183039489104",
                      "contact": {
                        "id": "502689183039489104",
                        "administration_id": 123,
                        "company_name": "Foobar Holding B.V.",
                        "firstname": null,
                        "lastname": null,
                        "address1": "Hoofdstraat 12",
                        "address2": null,
                        "zipcode": "1234AB",
                        "city": "Amsterdam",
                        "country": "NL",
                        "phone": null,
                        "delivery_method": "Email",
                        "customer_id": "customer-1",
                        "tax_number": null,
                        "chamber_of_commerce": null,
                        "bank_account": null,
                        "is_trusted": false,
                        "max_transfer_amount": null,
                        "attention": null,
                        "email": "info@example.com",
                        "email_ubl": true,
                        "send_invoices_to_attention": null,
                        "send_invoices_to_email": "info@example.com",
                        "send_estimates_to_attention": null,
                        "send_estimates_to_email": "info@example.com",
                        "direct_debit": false,
                        "sepa_active": false,
                        "sepa_iban": null,
                        "sepa_iban_account_name": null,
                        "sepa_bic": null,
                        "sepa_mandate_id": null,
                        "sepa_mandate_date": null,
                        "sepa_sequence_type": "RCUR",
                        "credit_card_number": null,
                        "credit_card_reference": null,
                        "credit_card_type": null,
                        "tax_number_validated_at": null,
                        "tax_number_valid": null,
                        "invoice_workflow_id": null,
                        "estimate_workflow_id": null,
                        "si_identifier": null,
                        "si_identifier_type": null,
                        "moneybird_payments_mandate": false,
                        "created_at": "2026-11-02T12:16:24.720Z",
                        "updated_at": "2026-11-02T12:16:24.720Z",
                        "version": 1793621784,
                        "sales_invoices_url": "https://moneybird.dev/123/sales_invoices/0000000000000000000000000000000000000000000000000000000000000001/all",
                        "notes": [],
                        "custom_fields": [],
                        "contact_people": [],
                        "archived": false
                      },
                      "reference": "Lunch supermarket",
                      "date": "2026-11-02",
                      "due_date": null,
                      "entry_number": 3,
                      "state": "open",
                      "currency": "EUR",
                      "exchange_rate": "1.0",
                      "revenue_invoice": false,
                      "prices_are_incl_tax": true,
                      "origin": null,
                      "paid_at": null,
                      "tax_number": null,
                      "total_price_excl_tax": "268.76",
                      "total_price_excl_tax_base": "268.76",
                      "total_price_incl_tax": "300.0",
                      "total_price_incl_tax_base": "300.0",
                      "created_at": "2026-11-02T12:16:24.789Z",
                      "updated_at": "2026-11-02T12:16:24.824Z",
                      "version": 1793621784,
                      "details": [
                        {
                          "id": "502689183112889451",
                          "administration_id": 123,
                          "tax_rate_id": "502689108908311693",
                          "ledger_account_id": "502689108787725433",
                          "project_id": null,
                          "product_id": null,
                          "amount": null,
                          "amount_decimal": "1.0",
                          "description": "Delivery Apple iPad",
                          "price": "300.0",
                          "period": null,
                          "row_order": 0,
                          "total_price_excl_tax_with_discount": "148.76",
                          "total_price_excl_tax_with_discount_base": "148.76",
                          "tax_report_reference": [
                            "NL/5b"
                          ],
                          "mandatory_tax_text": null,
                          "created_at": "2026-11-02T12:16:24.790Z",
                          "updated_at": "2026-11-02T12:16:24.823Z"
                        }
                      ],
                      "fiscal_allocations": [
                        {
                          "id": "502689183146443895",
                          "administration_id": 123,
                          "ledger_account_id": "502689108787725433",
                          "private_ledger_account_id": "502689183127569526",
                          "percentage": "40.0",
                          "price": "120.0",
                          "price_base": "120.0",
                          "created_at": "2026-11-02T12:16:24.823Z",
                          "updated_at": "2026-11-02T12:16:24.823Z"
                        }
                      ],
                      "payments": [],
                      "notes": [],
                      "attachments": [],
                      "events": [
                        {
                          "administration_id": 123,
                          "user_id": "502689108256097381",
                          "action": "document_saved",
                          "link_entity_id": null,
                          "link_entity_type": null,
                          "data": {},
                          "created_at": "2026-11-02T12:16:24.793Z",
                          "updated_at": "2026-11-02T12:16:24.793Z"
                        },
                        {
                          "administration_id": 123,
                          "user_id": "502689108256097381",
                          "action": "document_updated",
                          "link_entity_id": null,
                          "link_entity_type": null,
                          "data": {
                            "changes": {
                              "total_price_excl_tax": [
                                "247.93",
                                "268.76"
                              ],
                              "total_price_excl_tax_base": [
                                "247.93",
                                "268.76"
                              ],
                              "cached_taxes": [
                                [
                                  {
                                    "tax_rate_id": "502689108908311693",
                                    "report_reference": "NL/5b",
                                    "payable": false,
                                    "debit": "52.07",
                                    "credit": 0
                                  }
                                ],
                                [
                                  {
                                    "tax_rate_id": "502689108908311693",
                                    "report_reference": "NL/5b",
                                    "payable": false,
                                    "debit": "31.24",
                                    "credit": 0
                                  }
                                ]
                              ],
                              "updated_at": [
                                "2026-11-02T13:16:24.791+01:00",
                                "2026-11-02T13:16:24.821+01:00"
                              ]
                            }
                          },
                          "created_at": "2026-11-02T12:16:24.826Z",
                          "updated_at": "2026-11-02T12:16:24.826Z"
                        }
                      ]
                    }
                  }
                }
              }
            }
          },
          "400": {
            "$ref": "#/components/responses/400_bad_request"
          },
          "404": {
            "$ref": "#/components/responses/404_not_found"
          },
          "422": {
            "$ref": "#/components/responses/422_unprocessable_entity"
          }
        },
        "operationId": "patch_administration_id_documents_receipts_id"
      }
    },
    "/{administration_id}/documents/receipts/{receipt_id}/notes/{id}{format}": {
      "delete": {
        "summary": "Destroys note from entity",
        "description": "Deletes a note from the receipt.\n\n### Required scope(s)\n `documents`",
        "tags": [
          "Documents: Receipts"
        ],
        "security": [
          {
            "bearerAuth": [
              "documents"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/administration_id"
          },
          {
            "name": "receipt_id",
            "in": "path",
            "required": true,
            "schema": {
              "$ref": "#/components/schemas/identifier"
            }
          },
          {
            "name": "id",
            "in": "path",
            "required": true,
            "schema": {
              "$ref": "#/components/schemas/identifier"
            }
          },
          {
            "$ref": "#/components/parameters/format"
          }
        ],
        "responses": {
          "204": {
            "description": "Note deleted"
          },
          "400": {
            "$ref": "#/components/responses/400_bad_request"
          }
        },
        "operationId": "delete_administration_id_documents_receipts_receipt_id_notes_id"
      }
    },
    "/{administration_id}/documents/receipts/{receipt_id}/notes{format}": {
      "post": {
        "summary": "Adds note to entity",
        "description": "Adds a note to the receipt.\n\n### Required scope(s)\n `documents`",
        "tags": [
          "Documents: Receipts"
        ],
        "security": [
          {
            "bearerAuth": [
              "documents"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/administration_id"
          },
          {
            "name": "receipt_id",
            "in": "path",
            "required": true,
            "schema": {
              "$ref": "#/components/schemas/identifier"
            }
          },
          {
            "$ref": "#/components/parameters/format"
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/*": {
              "schema": {
                "unevaluatedProperties": false,
                "type": "object",
                "properties": {
                  "note": {
                    "type": "object",
                    "unevaluatedProperties": false,
                    "properties": {
                      "note": {
                        "type": "string",
                        "description": "**Required**. Text for the note or to-do."
                      },
                      "todo": {
                        "type": [
                          "boolean",
                          "string"
                        ],
                        "description": "If `true` the note is a to-do."
                      },
                      "assignee_id": {
                        "$ref": "#/components/schemas/identifier",
                        "description": "Assign to-do to user. Should be a valid user id. If assignee_id is provided the note will be a to-do."
                      }
                    },
                    "required": []
                  }
                },
                "required": []
              },
              "examples": {
                "CreateANote": {
                  "summary": "Create a note",
                  "value": {
                    "note": {
                      "note": "Text of the note",
                      "assignee_id": 502689177244010200,
                      "todo": true
                    }
                  }
                }
              }
            }
          }
        },
        "responses": {
          "201": {
            "description": "Note created",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/note_response"
                },
                "examples": {
                  "CreateANote": {
                    "summary": "Create a note",
                    "value": {
                      "id": "502689177260787404",
                      "administration_id": 123,
                      "entity_id": "502689177188435634",
                      "entity_type": "Document",
                      "user_id": "502689108256097381",
                      "assignee_id": "502689177244010186",
                      "todo": true,
                      "note": "Text of the note",
                      "completed_at": null,
                      "completed_by_id": null,
                      "todo_type": null,
                      "data": {},
                      "created_at": "2026-11-02T12:16:19.210Z",
                      "updated_at": "2026-11-02T12:16:19.210Z"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "$ref": "#/components/responses/400_bad_request"
          },
          "422": {
            "$ref": "#/components/responses/422_unprocessable_entity"
          }
        },
        "operationId": "post_administration_id_documents_receipts_receipt_id_notes"
      }
    },
    "/{administration_id}/documents/receipts{format}": {
      "get": {
        "summary": "List receipts",
        "description": "Returns a paginated list of documents of this type in the administration.\n\n### Required scope(s)\n `documents`",
        "tags": [
          "Documents: Receipts"
        ],
        "security": [
          {
            "bearerAuth": [
              "documents"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/administration_id"
          },
          {
            "$ref": "#/components/parameters/format"
          },
          {
            "name": "filter",
            "in": "query",
            "required": false,
            "description": "Filters are `key:value` terms separated by commas (e.g. `period:this_year,state:open`). Any filter you pass replaces the defaults below entirely, so include every key you need. Available filters:\n\n| **Filter** | **Type** | **Default** | **Description** |\n| - | - | - | - |\n| period | `String` | `this_year` | Matches on the document date. A named period (`this_week`, `prev_week`, `next_week`, `this_month`, `prev_month`, `next_month`, `this_quarter`, `prev_quarter`, `next_quarter`, `this_year`, `prev_year`, `next_year`) or a custom range (`201301..201302`, `20130101..20130131`). A custom period must have a start and an end date. It must not be longer than 10 years and must be between `20000101` and `21000101`. For one month, use `202401..202401`, not `202401`. Without `period`, the filter does not limit the dates. The default `this_year` applies only when you send no `filter`. |\n| state | `String` | `all` | `all`, `new`, `saved`, `open`, `paid`, `late` or `pending_payment`. `paid`, `late` and `pending_payment` only apply to documents with a payment lifecycle (purchase invoices and receipts) |\n| recurring | `String` | `all` | `all`, `enabled` or `disabled` |\n| attachment | `String` | `all` | `all`, `with` or `without` |\n| automatic_saving | `String` | `all` | `all`, `automatic` or `manual`. `automatic` matches documents Moneybird saved by itself after analysing them; `manual` matches everything else, including documents nobody has saved yet |\n| reference | `String` | | Documents with the given reference value |\n| contact_id | `Integer` | | Documents belonging to the given contact |\n| ledger_account_id | `Integer` | | Documents booking against the given ledger account |\n| updated_after | `String` | | ISO 8601 timestamp in UTC; documents updated strictly after this time |\n\nThe `period` filter matches on the document date. It does not look at the `period` of the individual details, which says which months the expenses belong to. Read `details[].period` in the response when you need those months, or use the reports endpoints, which already spread the amounts over that period. A detail's period can fall outside the filtered range, however wide you make it, so this filter cannot tell you which periods amounts fall in. Use the reports endpoints for that.\n\nMultiple values for `state`, `recurring` and `attachment` can be combined with a pipe, e.g. `state:open|paid`.",
            "schema": {
              "type": "string",
              "default": "period:this_year"
            },
            "examples": {
              "ReturnsTheOldestReceiptFirstWhenSortedByDateAscending": {
                "summary": "Returns the oldest receipt first when sorted by date ascending",
                "value": "period:20251102..20261102"
              },
              "FiltersOnAutomaticSaving": {
                "summary": "Filters on automatic saving",
                "value": "automatic_saving:automatic"
              }
            }
          },
          {
            "name": "new_filter",
            "in": "query",
            "required": false,
            "schema": {
              "type": "string",
              "description": "String terms, example: `key1:value1,key2:value2`."
            }
          },
          {
            "$ref": "#/components/parameters/page"
          },
          {
            "$ref": "#/components/parameters/sort"
          },
          {
            "$ref": "#/components/parameters/per_page"
          }
        ],
        "responses": {
          "200": {
            "description": "A list of receipts",
            "content": {
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "$ref": "#/components/schemas/receipt_response"
                  }
                },
                "examples": {
                  "ReturnsAListOfReceipts": {
                    "summary": "Returns a list of receipts",
                    "value": [
                      {
                        "id": "502689177612060471",
                        "administration_id": 123,
                        "contact_id": "502689177466308357",
                        "contact": {
                          "id": "502689177466308357",
                          "administration_id": 123,
                          "company_name": "Foobar Holding B.V.",
                          "firstname": null,
                          "lastname": null,
                          "address1": "Hoofdstraat 12",
                          "address2": null,
                          "zipcode": "1234AB",
                          "city": "Amsterdam",
                          "country": "NL",
                          "phone": null,
                          "delivery_method": "Email",
                          "customer_id": "customer-1",
                          "tax_number": null,
                          "chamber_of_commerce": null,
                          "bank_account": null,
                          "is_trusted": false,
                          "max_transfer_amount": null,
                          "attention": null,
                          "email": "info@example.com",
                          "email_ubl": true,
                          "send_invoices_to_attention": null,
                          "send_invoices_to_email": "info@example.com",
                          "send_estimates_to_attention": null,
                          "send_estimates_to_email": "info@example.com",
                          "direct_debit": false,
                          "sepa_active": false,
                          "sepa_iban": null,
                          "sepa_iban_account_name": null,
                          "sepa_bic": null,
                          "sepa_mandate_id": null,
                          "sepa_mandate_date": null,
                          "sepa_sequence_type": "RCUR",
                          "credit_card_number": null,
                          "credit_card_reference": null,
                          "credit_card_type": null,
                          "tax_number_validated_at": null,
                          "tax_number_valid": null,
                          "invoice_workflow_id": null,
                          "estimate_workflow_id": null,
                          "si_identifier": null,
                          "si_identifier_type": null,
                          "moneybird_payments_mandate": false,
                          "created_at": "2026-11-02T12:16:19.405Z",
                          "updated_at": "2026-11-02T12:16:19.405Z",
                          "version": 1793621779,
                          "sales_invoices_url": "https://moneybird.dev/123/sales_invoices/0000000000000000000000000000000000000000000000000000000000000001/all",
                          "notes": [],
                          "custom_fields": [],
                          "contact_people": [],
                          "archived": false
                        },
                        "reference": "Lunch supermarket",
                        "date": "2026-11-02",
                        "due_date": null,
                        "entry_number": 5,
                        "state": "open",
                        "currency": "EUR",
                        "exchange_rate": "1.0",
                        "revenue_invoice": false,
                        "prices_are_incl_tax": true,
                        "origin": null,
                        "paid_at": null,
                        "tax_number": null,
                        "total_price_excl_tax": "247.93",
                        "total_price_excl_tax_base": "247.93",
                        "total_price_incl_tax": "300.0",
                        "total_price_incl_tax_base": "300.0",
                        "created_at": "2026-11-02T12:16:19.544Z",
                        "updated_at": "2026-11-02T12:16:19.547Z",
                        "version": 1793621779,
                        "details": [
                          {
                            "id": "502689177613109048",
                            "administration_id": 123,
                            "tax_rate_id": "502689108908311693",
                            "ledger_account_id": "502689108787725433",
                            "project_id": null,
                            "product_id": null,
                            "amount": null,
                            "amount_decimal": "1.0",
                            "description": "Delivery Apple iPad",
                            "price": "300.0",
                            "period": null,
                            "row_order": 0,
                            "total_price_excl_tax_with_discount": "247.93",
                            "total_price_excl_tax_with_discount_base": "247.93",
                            "tax_report_reference": [
                              "NL/5b"
                            ],
                            "mandatory_tax_text": null,
                            "created_at": "2026-11-02T12:16:19.546Z",
                            "updated_at": "2026-11-02T12:16:19.546Z"
                          }
                        ],
                        "fiscal_allocations": [],
                        "payments": [],
                        "notes": [],
                        "attachments": [],
                        "events": [
                          {
                            "administration_id": 123,
                            "user_id": "502689108256097381",
                            "action": "document_saved",
                            "link_entity_id": null,
                            "link_entity_type": null,
                            "data": {},
                            "created_at": "2026-11-02T12:16:19.550Z",
                            "updated_at": "2026-11-02T12:16:19.550Z"
                          }
                        ]
                      },
                      {
                        "id": "502689177582700331",
                        "administration_id": 123,
                        "contact_id": "502689177466308357",
                        "contact": {
                          "id": "502689177466308357",
                          "administration_id": 123,
                          "company_name": "Foobar Holding B.V.",
                          "firstname": null,
                          "lastname": null,
                          "address1": "Hoofdstraat 12",
                          "address2": null,
                          "zipcode": "1234AB",
                          "city": "Amsterdam",
                          "country": "NL",
                          "phone": null,
                          "delivery_method": "Email",
                          "customer_id": "customer-1",
                          "tax_number": null,
                          "chamber_of_commerce": null,
                          "bank_account": null,
                          "is_trusted": false,
                          "max_transfer_amount": null,
                          "attention": null,
                          "email": "info@example.com",
                          "email_ubl": true,
                          "send_invoices_to_attention": null,
                          "send_invoices_to_email": "info@example.com",
                          "send_estimates_to_attention": null,
                          "send_estimates_to_email": "info@example.com",
                          "direct_debit": false,
                          "sepa_active": false,
                          "sepa_iban": null,
                          "sepa_iban_account_name": null,
                          "sepa_bic": null,
                          "sepa_mandate_id": null,
                          "sepa_mandate_date": null,
                          "sepa_sequence_type": "RCUR",
                          "credit_card_number": null,
                          "credit_card_reference": null,
                          "credit_card_type": null,
                          "tax_number_validated_at": null,
                          "tax_number_valid": null,
                          "invoice_workflow_id": null,
                          "estimate_workflow_id": null,
                          "si_identifier": null,
                          "si_identifier_type": null,
                          "moneybird_payments_mandate": false,
                          "created_at": "2026-11-02T12:16:19.405Z",
                          "updated_at": "2026-11-02T12:16:19.405Z",
                          "version": 1793621779,
                          "sales_invoices_url": "https://moneybird.dev/123/sales_invoices/0000000000000000000000000000000000000000000000000000000000000001/all",
                          "notes": [],
                          "custom_fields": [],
                          "contact_people": [],
                          "archived": false
                        },
                        "reference": "Lunch supermarket",
                        "date": "2026-11-02",
                        "due_date": null,
                        "entry_number": 4,
                        "state": "open",
                        "currency": "EUR",
                        "exchange_rate": "1.0",
                        "revenue_invoice": false,
                        "prices_are_incl_tax": true,
                        "origin": null,
                        "paid_at": null,
                        "tax_number": null,
                        "total_price_excl_tax": "247.93",
                        "total_price_excl_tax_base": "247.93",
                        "total_price_incl_tax": "300.0",
                        "total_price_incl_tax_base": "300.0",
                        "created_at": "2026-11-02T12:16:19.516Z",
                        "updated_at": "2026-11-02T12:16:19.519Z",
                        "version": 1793621779,
                        "details": [
                          {
                            "id": "502689177583748908",
                            "administration_id": 123,
                            "tax_rate_id": "502689108908311693",
                            "ledger_account_id": "502689108787725433",
                            "project_id": null,
                            "product_id": null,
                            "amount": null,
                            "amount_decimal": "1.0",
                            "description": "Delivery Apple iPad",
                            "price": "300.0",
                            "period": null,
                            "row_order": 0,
                            "total_price_excl_tax_with_discount": "247.93",
                            "total_price_excl_tax_with_discount_base": "247.93",
                            "tax_report_reference": [
                              "NL/5b"
                            ],
                            "mandatory_tax_text": null,
                            "created_at": "2026-11-02T12:16:19.518Z",
                            "updated_at": "2026-11-02T12:16:19.518Z"
                          }
                        ],
                        "fiscal_allocations": [],
                        "payments": [],
                        "notes": [],
                        "attachments": [],
                        "events": [
                          {
                            "administration_id": 123,
                            "user_id": "502689108256097381",
                            "action": "document_saved",
                            "link_entity_id": null,
                            "link_entity_type": null,
                            "data": {},
                            "created_at": "2026-11-02T12:16:19.521Z",
                            "updated_at": "2026-11-02T12:16:19.521Z"
                          }
                        ]
                      },
                      {
                        "id": "502689177549145887",
                        "administration_id": 123,
                        "contact_id": "502689177466308357",
                        "contact": {
                          "id": "502689177466308357",
                          "administration_id": 123,
                          "company_name": "Foobar Holding B.V.",
                          "firstname": null,
                          "lastname": null,
                          "address1": "Hoofdstraat 12",
                          "address2": null,
                          "zipcode": "1234AB",
                          "city": "Amsterdam",
                          "country": "NL",
                          "phone": null,
                          "delivery_method": "Email",
                          "customer_id": "customer-1",
                          "tax_number": null,
                          "chamber_of_commerce": null,
                          "bank_account": null,
                          "is_trusted": false,
                          "max_transfer_amount": null,
                          "attention": null,
                          "email": "info@example.com",
                          "email_ubl": true,
                          "send_invoices_to_attention": null,
                          "send_invoices_to_email": "info@example.com",
                          "send_estimates_to_attention": null,
                          "send_estimates_to_email": "info@example.com",
                          "direct_debit": false,
                          "sepa_active": false,
                          "sepa_iban": null,
                          "sepa_iban_account_name": null,
                          "sepa_bic": null,
                          "sepa_mandate_id": null,
                          "sepa_mandate_date": null,
                          "sepa_sequence_type": "RCUR",
                          "credit_card_number": null,
                          "credit_card_reference": null,
                          "credit_card_type": null,
                          "tax_number_validated_at": null,
                          "tax_number_valid": null,
                          "invoice_workflow_id": null,
                          "estimate_workflow_id": null,
                          "si_identifier": null,
                          "si_identifier_type": null,
                          "moneybird_payments_mandate": false,
                          "created_at": "2026-11-02T12:16:19.405Z",
                          "updated_at": "2026-11-02T12:16:19.405Z",
                          "version": 1793621779,
                          "sales_invoices_url": "https://moneybird.dev/123/sales_invoices/0000000000000000000000000000000000000000000000000000000000000001/all",
                          "notes": [],
                          "custom_fields": [],
                          "contact_people": [],
                          "archived": false
                        },
                        "reference": "Lunch supermarket",
                        "date": "2026-11-02",
                        "due_date": null,
                        "entry_number": 3,
                        "state": "open",
                        "currency": "EUR",
                        "exchange_rate": "1.0",
                        "revenue_invoice": false,
                        "prices_are_incl_tax": true,
                        "origin": null,
                        "paid_at": null,
                        "tax_number": null,
                        "total_price_excl_tax": "247.93",
                        "total_price_excl_tax_base": "247.93",
                        "total_price_incl_tax": "300.0",
                        "total_price_incl_tax_base": "300.0",
                        "created_at": "2026-11-02T12:16:19.484Z",
                        "updated_at": "2026-11-02T12:16:19.487Z",
                        "version": 1793621779,
                        "details": [
                          {
                            "id": "502689177550194464",
                            "administration_id": 123,
                            "tax_rate_id": "502689108908311693",
                            "ledger_account_id": "502689108787725433",
                            "project_id": null,
                            "product_id": null,
                            "amount": null,
                            "amount_decimal": "1.0",
                            "description": "Delivery Apple iPad",
                            "price": "300.0",
                            "period": null,
                            "row_order": 0,
                            "total_price_excl_tax_with_discount": "247.93",
                            "total_price_excl_tax_with_discount_base": "247.93",
                            "tax_report_reference": [
                              "NL/5b"
                            ],
                            "mandatory_tax_text": null,
                            "created_at": "2026-11-02T12:16:19.486Z",
                            "updated_at": "2026-11-02T12:16:19.486Z"
                          }
                        ],
                        "fiscal_allocations": [],
                        "payments": [],
                        "notes": [],
                        "attachments": [],
                        "events": [
                          {
                            "administration_id": 123,
                            "user_id": "502689108256097381",
                            "action": "document_saved",
                            "link_entity_id": null,
                            "link_entity_type": null,
                            "data": {},
                            "created_at": "2026-11-02T12:16:19.490Z",
                            "updated_at": "2026-11-02T12:16:19.490Z"
                          }
                        ]
                      },
                      {
                        "id": "502689177484134151",
                        "administration_id": 123,
                        "contact_id": "502689177466308357",
                        "contact": {
                          "id": "502689177466308357",
                          "administration_id": 123,
                          "company_name": "Foobar Holding B.V.",
                          "firstname": null,
                          "lastname": null,
                          "address1": "Hoofdstraat 12",
                          "address2": null,
                          "zipcode": "1234AB",
                          "city": "Amsterdam",
                          "country": "NL",
                          "phone": null,
                          "delivery_method": "Email",
                          "customer_id": "customer-1",
                          "tax_number": null,
                          "chamber_of_commerce": null,
                          "bank_account": null,
                          "is_trusted": false,
                          "max_transfer_amount": null,
                          "attention": null,
                          "email": "info@example.com",
                          "email_ubl": true,
                          "send_invoices_to_attention": null,
                          "send_invoices_to_email": "info@example.com",
                          "send_estimates_to_attention": null,
                          "send_estimates_to_email": "info@example.com",
                          "direct_debit": false,
                          "sepa_active": false,
                          "sepa_iban": null,
                          "sepa_iban_account_name": null,
                          "sepa_bic": null,
                          "sepa_mandate_id": null,
                          "sepa_mandate_date": null,
                          "sepa_sequence_type": "RCUR",
                          "credit_card_number": null,
                          "credit_card_reference": null,
                          "credit_card_type": null,
                          "tax_number_validated_at": null,
                          "tax_number_valid": null,
                          "invoice_workflow_id": null,
                          "estimate_workflow_id": null,
                          "si_identifier": null,
                          "si_identifier_type": null,
                          "moneybird_payments_mandate": false,
                          "created_at": "2026-11-02T12:16:19.405Z",
                          "updated_at": "2026-11-02T12:16:19.405Z",
                          "version": 1793621779,
                          "sales_invoices_url": "https://moneybird.dev/123/sales_invoices/0000000000000000000000000000000000000000000000000000000000000001/all",
                          "notes": [],
                          "custom_fields": [],
                          "contact_people": [],
                          "archived": false
                        },
                        "reference": "Lunch supermarket",
                        "date": "2026-11-02",
                        "due_date": null,
                        "entry_number": 1,
                        "state": "open",
                        "currency": "EUR",
                        "exchange_rate": "1.0",
                        "revenue_invoice": false,
                        "prices_are_incl_tax": true,
                        "origin": null,
                        "paid_at": null,
                        "tax_number": null,
                        "total_price_excl_tax": "247.93",
                        "total_price_excl_tax_base": "247.93",
                        "total_price_incl_tax": "300.0",
                        "total_price_incl_tax_base": "300.0",
                        "created_at": "2026-11-02T12:16:19.423Z",
                        "updated_at": "2026-11-02T12:16:19.426Z",
                        "version": 1793621779,
                        "details": [
                          {
                            "id": "502689177486231304",
                            "administration_id": 123,
                            "tax_rate_id": "502689108908311693",
                            "ledger_account_id": "502689108787725433",
                            "project_id": null,
                            "product_id": null,
                            "amount": null,
                            "amount_decimal": "1.0",
                            "description": "Delivery Apple iPad",
                            "price": "300.0",
                            "period": null,
                            "row_order": 0,
                            "total_price_excl_tax_with_discount": "247.93",
                            "total_price_excl_tax_with_discount_base": "247.93",
                            "tax_report_reference": [
                              "NL/5b"
                            ],
                            "mandatory_tax_text": null,
                            "created_at": "2026-11-02T12:16:19.424Z",
                            "updated_at": "2026-11-02T12:16:19.424Z"
                          }
                        ],
                        "fiscal_allocations": [],
                        "payments": [],
                        "notes": [],
                        "attachments": [],
                        "events": [
                          {
                            "administration_id": 123,
                            "user_id": "502689108256097381",
                            "action": "document_saved",
                            "link_entity_id": null,
                            "link_entity_type": null,
                            "data": {},
                            "created_at": "2026-11-02T12:16:19.427Z",
                            "updated_at": "2026-11-02T12:16:19.427Z"
                          }
                        ]
                      }
                    ]
                  },
                  "ReturnsTheOldestReceiptFirstWhenSortedByDateAscending": {
                    "summary": "Returns the oldest receipt first when sorted by date ascending",
                    "value": [
                      {
                        "id": "502689177982207876",
                        "administration_id": 123,
                        "contact_id": "502689177975916419",
                        "contact": {
                          "id": "502689177975916419",
                          "administration_id": 123,
                          "company_name": "Relation 1",
                          "firstname": null,
                          "lastname": null,
                          "address1": null,
                          "address2": null,
                          "zipcode": null,
                          "city": null,
                          "country": "NL",
                          "phone": null,
                          "delivery_method": "Email",
                          "customer_id": "customer-2",
                          "tax_number": null,
                          "chamber_of_commerce": null,
                          "bank_account": null,
                          "is_trusted": false,
                          "max_transfer_amount": null,
                          "attention": null,
                          "email": "contact1@example.com",
                          "email_ubl": false,
                          "send_invoices_to_attention": null,
                          "send_invoices_to_email": "contact1@example.com",
                          "send_estimates_to_attention": null,
                          "send_estimates_to_email": null,
                          "direct_debit": false,
                          "sepa_active": false,
                          "sepa_iban": null,
                          "sepa_iban_account_name": null,
                          "sepa_bic": null,
                          "sepa_mandate_id": null,
                          "sepa_mandate_date": null,
                          "sepa_sequence_type": "RCUR",
                          "credit_card_number": null,
                          "credit_card_reference": null,
                          "credit_card_type": null,
                          "tax_number_validated_at": null,
                          "tax_number_valid": null,
                          "invoice_workflow_id": null,
                          "estimate_workflow_id": null,
                          "si_identifier": null,
                          "si_identifier_type": null,
                          "moneybird_payments_mandate": false,
                          "created_at": "2026-11-02T12:16:19.891Z",
                          "updated_at": "2026-11-02T12:16:19.891Z",
                          "version": 1793621779,
                          "sales_invoices_url": "https://moneybird.dev/123/sales_invoices/0000000000000000000000000000000000000000000000000000000000000002/all",
                          "notes": [],
                          "custom_fields": [],
                          "contact_people": [],
                          "archived": false
                        },
                        "reference": "2026-0002",
                        "date": "2025-11-02",
                        "due_date": null,
                        "entry_number": null,
                        "state": "open",
                        "currency": "EUR",
                        "exchange_rate": "1.0",
                        "revenue_invoice": false,
                        "prices_are_incl_tax": false,
                        "origin": null,
                        "paid_at": null,
                        "tax_number": null,
                        "total_price_excl_tax": "100.0",
                        "total_price_excl_tax_base": "100.0",
                        "total_price_incl_tax": "121.0",
                        "total_price_incl_tax_base": "121.0",
                        "created_at": "2026-11-02T12:16:19.897Z",
                        "updated_at": "2026-11-02T12:16:19.903Z",
                        "version": 1793621779,
                        "details": [
                          {
                            "id": "502689177985353605",
                            "administration_id": 123,
                            "tax_rate_id": "502689108908311693",
                            "ledger_account_id": "502689108787725433",
                            "project_id": null,
                            "product_id": null,
                            "amount": "1 x",
                            "amount_decimal": "1.0",
                            "description": "Invoice detail description",
                            "price": "100.0",
                            "period": null,
                            "row_order": 0,
                            "total_price_excl_tax_with_discount": "100.0",
                            "total_price_excl_tax_with_discount_base": "100.0",
                            "tax_report_reference": [],
                            "mandatory_tax_text": null,
                            "created_at": "2026-11-02T12:16:19.900Z",
                            "updated_at": "2026-11-02T12:16:19.900Z"
                          }
                        ],
                        "fiscal_allocations": [],
                        "payments": [],
                        "notes": [],
                        "attachments": [],
                        "events": []
                      }
                    ]
                  },
                  "FiltersOnAutomaticSaving": {
                    "summary": "Filters on automatic saving",
                    "value": [
                      {
                        "id": "502689178234914760",
                        "administration_id": 123,
                        "contact_id": "502689178218137542",
                        "contact": {
                          "id": "502689178218137542",
                          "administration_id": 123,
                          "company_name": "Foobar Holding B.V.",
                          "firstname": null,
                          "lastname": null,
                          "address1": "Hoofdstraat 12",
                          "address2": null,
                          "zipcode": "1234AB",
                          "city": "Amsterdam",
                          "country": "NL",
                          "phone": null,
                          "delivery_method": "Email",
                          "customer_id": "customer-1",
                          "tax_number": null,
                          "chamber_of_commerce": null,
                          "bank_account": null,
                          "is_trusted": false,
                          "max_transfer_amount": null,
                          "attention": null,
                          "email": "info@example.com",
                          "email_ubl": true,
                          "send_invoices_to_attention": null,
                          "send_invoices_to_email": "info@example.com",
                          "send_estimates_to_attention": null,
                          "send_estimates_to_email": "info@example.com",
                          "direct_debit": false,
                          "sepa_active": false,
                          "sepa_iban": null,
                          "sepa_iban_account_name": null,
                          "sepa_bic": null,
                          "sepa_mandate_id": null,
                          "sepa_mandate_date": null,
                          "sepa_sequence_type": "RCUR",
                          "credit_card_number": null,
                          "credit_card_reference": null,
                          "credit_card_type": null,
                          "tax_number_validated_at": null,
                          "tax_number_valid": null,
                          "invoice_workflow_id": null,
                          "estimate_workflow_id": null,
                          "si_identifier": null,
                          "si_identifier_type": null,
                          "moneybird_payments_mandate": false,
                          "created_at": "2026-11-02T12:16:20.123Z",
                          "updated_at": "2026-11-02T12:16:20.123Z",
                          "version": 1793621780,
                          "sales_invoices_url": "https://moneybird.dev/123/sales_invoices/0000000000000000000000000000000000000000000000000000000000000001/all",
                          "notes": [],
                          "custom_fields": [],
                          "contact_people": [],
                          "archived": false
                        },
                        "reference": "Lunch supermarket",
                        "date": "2026-11-02",
                        "due_date": null,
                        "entry_number": 1,
                        "state": "open",
                        "currency": "EUR",
                        "exchange_rate": "1.0",
                        "revenue_invoice": false,
                        "prices_are_incl_tax": true,
                        "origin": null,
                        "paid_at": null,
                        "tax_number": null,
                        "total_price_excl_tax": "247.93",
                        "total_price_excl_tax_base": "247.93",
                        "total_price_incl_tax": "300.0",
                        "total_price_incl_tax_base": "300.0",
                        "created_at": "2026-11-02T12:16:20.138Z",
                        "updated_at": "2026-11-02T12:16:20.141Z",
                        "version": 1793621780,
                        "details": [
                          {
                            "id": "502689178235963337",
                            "administration_id": 123,
                            "tax_rate_id": "502689108908311693",
                            "ledger_account_id": "502689108787725433",
                            "project_id": null,
                            "product_id": null,
                            "amount": null,
                            "amount_decimal": "1.0",
                            "description": "Delivery Apple iPad",
                            "price": "300.0",
                            "period": null,
                            "row_order": 0,
                            "total_price_excl_tax_with_discount": "247.93",
                            "total_price_excl_tax_with_discount_base": "247.93",
                            "tax_report_reference": [
                              "NL/5b"
                            ],
                            "mandatory_tax_text": null,
                            "created_at": "2026-11-02T12:16:20.139Z",
                            "updated_at": "2026-11-02T12:16:20.139Z"
                          }
                        ],
                        "fiscal_allocations": [],
                        "payments": [],
                        "notes": [],
                        "attachments": [],
                        "events": [
                          {
                            "administration_id": 123,
                            "user_id": "502689108256097381",
                            "action": "document_saved",
                            "link_entity_id": null,
                            "link_entity_type": null,
                            "data": {},
                            "created_at": "2026-11-02T12:16:20.143Z",
                            "updated_at": "2026-11-02T12:16:20.143Z"
                          },
                          {
                            "administration_id": 123,
                            "user_id": 1,
                            "action": "document_automatically_saved",
                            "link_entity_id": null,
                            "link_entity_type": null,
                            "data": {},
                            "created_at": "2026-11-02T12:16:20.261Z",
                            "updated_at": "2026-11-02T12:16:20.261Z"
                          }
                        ]
                      }
                    ]
                  },
                  "ReturnsPaginatedReceiptsOnPage1": {
                    "summary": "Returns paginated receipts on page 1",
                    "value": [
                      {
                        "id": "502689178530612281",
                        "administration_id": 123,
                        "contact_id": "502689178405831687",
                        "contact": {
                          "id": "502689178405831687",
                          "administration_id": 123,
                          "company_name": "Foobar Holding B.V.",
                          "firstname": null,
                          "lastname": null,
                          "address1": "Hoofdstraat 12",
                          "address2": null,
                          "zipcode": "1234AB",
                          "city": "Amsterdam",
                          "country": "NL",
                          "phone": null,
                          "delivery_method": "Email",
                          "customer_id": "customer-1",
                          "tax_number": null,
                          "chamber_of_commerce": null,
                          "bank_account": null,
                          "is_trusted": false,
                          "max_transfer_amount": null,
                          "attention": null,
                          "email": "info@example.com",
                          "email_ubl": true,
                          "send_invoices_to_attention": null,
                          "send_invoices_to_email": "info@example.com",
                          "send_estimates_to_attention": null,
                          "send_estimates_to_email": "info@example.com",
                          "direct_debit": false,
                          "sepa_active": false,
                          "sepa_iban": null,
                          "sepa_iban_account_name": null,
                          "sepa_bic": null,
                          "sepa_mandate_id": null,
                          "sepa_mandate_date": null,
                          "sepa_sequence_type": "RCUR",
                          "credit_card_number": null,
                          "credit_card_reference": null,
                          "credit_card_type": null,
                          "tax_number_validated_at": null,
                          "tax_number_valid": null,
                          "invoice_workflow_id": null,
                          "estimate_workflow_id": null,
                          "si_identifier": null,
                          "si_identifier_type": null,
                          "moneybird_payments_mandate": false,
                          "created_at": "2026-11-02T12:16:20.301Z",
                          "updated_at": "2026-11-02T12:16:20.301Z",
                          "version": 1793621780,
                          "sales_invoices_url": "https://moneybird.dev/123/sales_invoices/0000000000000000000000000000000000000000000000000000000000000001/all",
                          "notes": [],
                          "custom_fields": [],
                          "contact_people": [],
                          "archived": false
                        },
                        "reference": "Lunch supermarket",
                        "date": "2026-11-02",
                        "due_date": null,
                        "entry_number": 5,
                        "state": "open",
                        "currency": "EUR",
                        "exchange_rate": "1.0",
                        "revenue_invoice": false,
                        "prices_are_incl_tax": true,
                        "origin": null,
                        "paid_at": null,
                        "tax_number": null,
                        "total_price_excl_tax": "247.93",
                        "total_price_excl_tax_base": "247.93",
                        "total_price_incl_tax": "300.0",
                        "total_price_incl_tax_base": "300.0",
                        "created_at": "2026-11-02T12:16:20.421Z",
                        "updated_at": "2026-11-02T12:16:20.423Z",
                        "version": 1793621780,
                        "details": [
                          {
                            "id": "502689178531660858",
                            "administration_id": 123,
                            "tax_rate_id": "502689108908311693",
                            "ledger_account_id": "502689108787725433",
                            "project_id": null,
                            "product_id": null,
                            "amount": null,
                            "amount_decimal": "1.0",
                            "description": "Delivery Apple iPad",
                            "price": "300.0",
                            "period": null,
                            "row_order": 0,
                            "total_price_excl_tax_with_discount": "247.93",
                            "total_price_excl_tax_with_discount_base": "247.93",
                            "tax_report_reference": [
                              "NL/5b"
                            ],
                            "mandatory_tax_text": null,
                            "created_at": "2026-11-02T12:16:20.422Z",
                            "updated_at": "2026-11-02T12:16:20.422Z"
                          }
                        ],
                        "fiscal_allocations": [],
                        "payments": [],
                        "notes": [],
                        "attachments": [],
                        "events": [
                          {
                            "administration_id": 123,
                            "user_id": "502689108256097381",
                            "action": "document_saved",
                            "link_entity_id": null,
                            "link_entity_type": null,
                            "data": {},
                            "created_at": "2026-11-02T12:16:20.425Z",
                            "updated_at": "2026-11-02T12:16:20.425Z"
                          }
                        ]
                      }
                    ]
                  },
                  "ReturnsPaginatedReceiptsOnPage2": {
                    "summary": "Returns paginated receipts on page 2",
                    "value": [
                      {
                        "id": "502689178712015980",
                        "administration_id": 123,
                        "contact_id": "502689178595624006",
                        "contact": {
                          "id": "502689178595624006",
                          "administration_id": 123,
                          "company_name": "Foobar Holding B.V.",
                          "firstname": null,
                          "lastname": null,
                          "address1": "Hoofdstraat 12",
                          "address2": null,
                          "zipcode": "1234AB",
                          "city": "Amsterdam",
                          "country": "NL",
                          "phone": null,
                          "delivery_method": "Email",
                          "customer_id": "customer-1",
                          "tax_number": null,
                          "chamber_of_commerce": null,
                          "bank_account": null,
                          "is_trusted": false,
                          "max_transfer_amount": null,
                          "attention": null,
                          "email": "info@example.com",
                          "email_ubl": true,
                          "send_invoices_to_attention": null,
                          "send_invoices_to_email": "info@example.com",
                          "send_estimates_to_attention": null,
                          "send_estimates_to_email": "info@example.com",
                          "direct_debit": false,
                          "sepa_active": false,
                          "sepa_iban": null,
                          "sepa_iban_account_name": null,
                          "sepa_bic": null,
                          "sepa_mandate_id": null,
                          "sepa_mandate_date": null,
                          "sepa_sequence_type": "RCUR",
                          "credit_card_number": null,
                          "credit_card_reference": null,
                          "credit_card_type": null,
                          "tax_number_validated_at": null,
                          "tax_number_valid": null,
                          "invoice_workflow_id": null,
                          "estimate_workflow_id": null,
                          "si_identifier": null,
                          "si_identifier_type": null,
                          "moneybird_payments_mandate": false,
                          "created_at": "2026-11-02T12:16:20.482Z",
                          "updated_at": "2026-11-02T12:16:20.482Z",
                          "version": 1793621780,
                          "sales_invoices_url": "https://moneybird.dev/123/sales_invoices/0000000000000000000000000000000000000000000000000000000000000001/all",
                          "notes": [],
                          "custom_fields": [],
                          "contact_people": [],
                          "archived": false
                        },
                        "reference": "Lunch supermarket",
                        "date": "2026-11-02",
                        "due_date": null,
                        "entry_number": 4,
                        "state": "open",
                        "currency": "EUR",
                        "exchange_rate": "1.0",
                        "revenue_invoice": false,
                        "prices_are_incl_tax": true,
                        "origin": null,
                        "paid_at": null,
                        "tax_number": null,
                        "total_price_excl_tax": "247.93",
                        "total_price_excl_tax_base": "247.93",
                        "total_price_incl_tax": "300.0",
                        "total_price_incl_tax_base": "300.0",
                        "created_at": "2026-11-02T12:16:20.593Z",
                        "updated_at": "2026-11-02T12:16:20.597Z",
                        "version": 1793621780,
                        "details": [
                          {
                            "id": "502689178714113133",
                            "administration_id": 123,
                            "tax_rate_id": "502689108908311693",
                            "ledger_account_id": "502689108787725433",
                            "project_id": null,
                            "product_id": null,
                            "amount": null,
                            "amount_decimal": "1.0",
                            "description": "Delivery Apple iPad",
                            "price": "300.0",
                            "period": null,
                            "row_order": 0,
                            "total_price_excl_tax_with_discount": "247.93",
                            "total_price_excl_tax_with_discount_base": "247.93",
                            "tax_report_reference": [
                              "NL/5b"
                            ],
                            "mandatory_tax_text": null,
                            "created_at": "2026-11-02T12:16:20.595Z",
                            "updated_at": "2026-11-02T12:16:20.595Z"
                          }
                        ],
                        "fiscal_allocations": [],
                        "payments": [],
                        "notes": [],
                        "attachments": [],
                        "events": [
                          {
                            "administration_id": 123,
                            "user_id": "502689108256097381",
                            "action": "document_saved",
                            "link_entity_id": null,
                            "link_entity_type": null,
                            "data": {},
                            "created_at": "2026-11-02T12:16:20.599Z",
                            "updated_at": "2026-11-02T12:16:20.599Z"
                          }
                        ]
                      }
                    ]
                  }
                }
              }
            }
          },
          "400": {
            "description": "Bad request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/symbolic_error"
                },
                "examples": {
                  "ReturnsAnErrorWhenTooManyReceiptsAreRequested": {
                    "summary": "Returns an error when too many receipts are requested",
                    "value": {
                      "error": "Per Page is too big",
                      "symbolic": {
                        "per_page": "max"
                      }
                    }
                  }
                }
              }
            }
          }
        },
        "operationId": "get_administration_id_documents_receipts"
      },
      "post": {
        "summary": "Create a new receipt",
        "description": "Creates a new receipt.\n\n### Required scope(s)\n `documents`",
        "tags": [
          "Documents: Receipts"
        ],
        "security": [
          {
            "bearerAuth": [
              "documents"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/administration_id"
          },
          {
            "$ref": "#/components/parameters/format"
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/*": {
              "schema": {
                "unevaluatedProperties": false,
                "type": "object",
                "properties": {
                  "receipt": {
                    "type": "object",
                    "unevaluatedProperties": false,
                    "properties": {
                      "contact_id": {
                        "$ref": "#/components/schemas/identifier",
                        "description": "Should be a valid contact id."
                      },
                      "reference": {
                        "type": "string",
                        "description": "A reference for this receipt, e.g. a receipt number or supplier name."
                      },
                      "date": {
                        "type": "string",
                        "description": "The date of the receipt.",
                        "format": "date"
                      },
                      "currency": {
                        "type": "string",
                        "description": "ISO three-character currency code, e.g. EUR or USD."
                      },
                      "prices_are_incl_tax": {
                        "type": [
                          "boolean",
                          "string"
                        ],
                        "description": "Whether the prices on the receipt are inclusive of tax. Defaults to the administration setting."
                      },
                      "details_attributes": {
                        "$ref": "#/components/schemas/details_attributes"
                      },
                      "fiscal_allocations_attributes": {
                        "$ref": "#/components/schemas/fiscal_allocations_attributes"
                      }
                    },
                    "required": []
                  },
                  "payment": {
                    "type": "object",
                    "unevaluatedProperties": false,
                    "properties": {
                      "financial_account_id": {
                        "$ref": "#/components/schemas/identifier",
                        "description": "Should be a valid financial account id."
                      }
                    },
                    "required": []
                  }
                },
                "required": []
              },
              "examples": {
                "CreatesTheReceipt": {
                  "summary": "Creates the receipt",
                  "value": {
                    "receipt": {
                      "reference": "foobar",
                      "contact_id": 502689176939923100,
                      "details_attributes": {
                        "0": {
                          "description": "Lunch",
                          "price": 20,
                          "tax_rate_id": 502689108908311700,
                          "ledger_account_id": 502689108787725440
                        }
                      }
                    }
                  }
                },
                "CreatesADocumentWithFiscalAllocations": {
                  "summary": "Creates a document with fiscal allocations",
                  "value": {
                    "receipt": {
                      "reference": "with fiscal allocations",
                      "contact_id": 502689182581262300,
                      "details_attributes": [
                        {
                          "description": "Test detail",
                          "price": 100,
                          "tax_rate_id": 502689108908311700,
                          "ledger_account_id": 502689108787725440
                        }
                      ],
                      "fiscal_allocations_attributes": [
                        {
                          "ledger_account_id": 502689108787725440,
                          "private_ledger_account_id": 502689182647322560,
                          "percentage": "30"
                        }
                      ]
                    }
                  }
                }
              }
            }
          }
        },
        "responses": {
          "201": {
            "description": "Receipt created",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/receipt_response"
                },
                "examples": {
                  "CreatesTheReceipt": {
                    "summary": "Creates the receipt",
                    "value": {
                      "id": "502689177022760584",
                      "administration_id": 123,
                      "contact_id": "502689176939923054",
                      "contact": {
                        "id": "502689176939923054",
                        "administration_id": 123,
                        "company_name": "Foobar Holding B.V.",
                        "firstname": null,
                        "lastname": null,
                        "address1": "Hoofdstraat 12",
                        "address2": null,
                        "zipcode": "1234AB",
                        "city": "Amsterdam",
                        "country": "NL",
                        "phone": null,
                        "delivery_method": "Email",
                        "customer_id": "customer-1",
                        "tax_number": null,
                        "chamber_of_commerce": null,
                        "bank_account": null,
                        "is_trusted": false,
                        "max_transfer_amount": null,
                        "attention": null,
                        "email": "info@example.com",
                        "email_ubl": true,
                        "send_invoices_to_attention": null,
                        "send_invoices_to_email": "info@example.com",
                        "send_estimates_to_attention": null,
                        "send_estimates_to_email": "info@example.com",
                        "direct_debit": false,
                        "sepa_active": false,
                        "sepa_iban": null,
                        "sepa_iban_account_name": null,
                        "sepa_bic": null,
                        "sepa_mandate_id": null,
                        "sepa_mandate_date": null,
                        "sepa_sequence_type": "RCUR",
                        "credit_card_number": null,
                        "credit_card_reference": null,
                        "credit_card_type": null,
                        "tax_number_validated_at": null,
                        "tax_number_valid": null,
                        "invoice_workflow_id": null,
                        "estimate_workflow_id": null,
                        "si_identifier": null,
                        "si_identifier_type": null,
                        "moneybird_payments_mandate": false,
                        "created_at": "2026-11-02T12:16:18.904Z",
                        "updated_at": "2026-11-02T12:16:18.904Z",
                        "version": 1793621778,
                        "sales_invoices_url": "https://moneybird.dev/123/sales_invoices/0000000000000000000000000000000000000000000000000000000000000001/all",
                        "notes": [],
                        "custom_fields": [],
                        "contact_people": [],
                        "archived": false
                      },
                      "reference": "foobar",
                      "date": "2026-11-02",
                      "due_date": null,
                      "entry_number": 3,
                      "state": "open",
                      "currency": "EUR",
                      "exchange_rate": "1.0",
                      "revenue_invoice": false,
                      "prices_are_incl_tax": true,
                      "origin": null,
                      "paid_at": null,
                      "tax_number": null,
                      "total_price_excl_tax": "16.53",
                      "total_price_excl_tax_base": "16.53",
                      "total_price_incl_tax": "20.0",
                      "total_price_incl_tax_base": "20.0",
                      "created_at": "2026-11-02T12:16:18.982Z",
                      "updated_at": "2026-11-02T12:16:18.985Z",
                      "version": 1793621778,
                      "details": [
                        {
                          "id": "502689177023809161",
                          "administration_id": 123,
                          "tax_rate_id": "502689108908311693",
                          "ledger_account_id": "502689108787725433",
                          "project_id": null,
                          "product_id": null,
                          "amount": null,
                          "amount_decimal": "1.0",
                          "description": "Lunch",
                          "price": "20.0",
                          "period": null,
                          "row_order": 0,
                          "total_price_excl_tax_with_discount": "16.53",
                          "total_price_excl_tax_with_discount_base": "16.53",
                          "tax_report_reference": [
                            "NL/5b"
                          ],
                          "mandatory_tax_text": null,
                          "created_at": "2026-11-02T12:16:18.984Z",
                          "updated_at": "2026-11-02T12:16:18.984Z"
                        }
                      ],
                      "fiscal_allocations": [],
                      "payments": [],
                      "notes": [],
                      "attachments": [],
                      "events": [
                        {
                          "administration_id": 123,
                          "user_id": "502689108256097381",
                          "action": "document_saved",
                          "link_entity_id": null,
                          "link_entity_type": null,
                          "data": {},
                          "created_at": "2026-11-02T12:16:18.986Z",
                          "updated_at": "2026-11-02T12:16:18.986Z"
                        }
                      ]
                    }
                  },
                  "CreatesADocumentWithFiscalAllocations": {
                    "summary": "Creates a document with fiscal allocations",
                    "value": {
                      "id": "502689182667245530",
                      "administration_id": 123,
                      "contact_id": "502689182581262271",
                      "contact": {
                        "id": "502689182581262271",
                        "administration_id": 123,
                        "company_name": "Foobar Holding B.V.",
                        "firstname": null,
                        "lastname": null,
                        "address1": "Hoofdstraat 12",
                        "address2": null,
                        "zipcode": "1234AB",
                        "city": "Amsterdam",
                        "country": "NL",
                        "phone": null,
                        "delivery_method": "Email",
                        "customer_id": "customer-1",
                        "tax_number": null,
                        "chamber_of_commerce": null,
                        "bank_account": null,
                        "is_trusted": false,
                        "max_transfer_amount": null,
                        "attention": null,
                        "email": "info@example.com",
                        "email_ubl": true,
                        "send_invoices_to_attention": null,
                        "send_invoices_to_email": "info@example.com",
                        "send_estimates_to_attention": null,
                        "send_estimates_to_email": "info@example.com",
                        "direct_debit": false,
                        "sepa_active": false,
                        "sepa_iban": null,
                        "sepa_iban_account_name": null,
                        "sepa_bic": null,
                        "sepa_mandate_id": null,
                        "sepa_mandate_date": null,
                        "sepa_sequence_type": "RCUR",
                        "credit_card_number": null,
                        "credit_card_reference": null,
                        "credit_card_type": null,
                        "tax_number_validated_at": null,
                        "tax_number_valid": null,
                        "invoice_workflow_id": null,
                        "estimate_workflow_id": null,
                        "si_identifier": null,
                        "si_identifier_type": null,
                        "moneybird_payments_mandate": false,
                        "created_at": "2026-11-02T12:16:24.284Z",
                        "updated_at": "2026-11-02T12:16:24.284Z",
                        "version": 1793621784,
                        "sales_invoices_url": "https://moneybird.dev/123/sales_invoices/0000000000000000000000000000000000000000000000000000000000000001/all",
                        "notes": [],
                        "custom_fields": [],
                        "contact_people": [],
                        "archived": false
                      },
                      "reference": "with fiscal allocations",
                      "date": "2026-11-02",
                      "due_date": null,
                      "entry_number": 3,
                      "state": "open",
                      "currency": "EUR",
                      "exchange_rate": "1.0",
                      "revenue_invoice": false,
                      "prices_are_incl_tax": true,
                      "origin": null,
                      "paid_at": null,
                      "tax_number": null,
                      "total_price_excl_tax": "87.85",
                      "total_price_excl_tax_base": "87.85",
                      "total_price_incl_tax": "100.0",
                      "total_price_incl_tax_base": "100.0",
                      "created_at": "2026-11-02T12:16:24.365Z",
                      "updated_at": "2026-11-02T12:16:24.370Z",
                      "version": 1793621784,
                      "details": [
                        {
                          "id": "502689182670391260",
                          "administration_id": 123,
                          "tax_rate_id": "502689108908311693",
                          "ledger_account_id": "502689108787725433",
                          "project_id": null,
                          "product_id": null,
                          "amount": null,
                          "amount_decimal": "1.0",
                          "description": "Test detail",
                          "price": "100.0",
                          "period": null,
                          "row_order": 0,
                          "total_price_excl_tax_with_discount": "57.85",
                          "total_price_excl_tax_with_discount_base": "57.85",
                          "tax_report_reference": [
                            "NL/5b"
                          ],
                          "mandatory_tax_text": null,
                          "created_at": "2026-11-02T12:16:24.369Z",
                          "updated_at": "2026-11-02T12:16:24.369Z"
                        }
                      ],
                      "fiscal_allocations": [
                        {
                          "id": "502689182668294107",
                          "administration_id": 123,
                          "ledger_account_id": "502689108787725433",
                          "private_ledger_account_id": "502689182647322585",
                          "percentage": "30.0",
                          "price": "30.0",
                          "price_base": "30.0",
                          "created_at": "2026-11-02T12:16:24.367Z",
                          "updated_at": "2026-11-02T12:16:24.367Z"
                        }
                      ],
                      "payments": [],
                      "notes": [],
                      "attachments": [],
                      "events": [
                        {
                          "administration_id": 123,
                          "user_id": "502689108256097381",
                          "action": "document_saved",
                          "link_entity_id": null,
                          "link_entity_type": null,
                          "data": {},
                          "created_at": "2026-11-02T12:16:24.372Z",
                          "updated_at": "2026-11-02T12:16:24.372Z"
                        }
                      ]
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "Bad request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/symbolic_error"
                },
                "examples": {
                  "RequiresAllInput": {
                    "summary": "Requires all input",
                    "value": {
                      "error": "Receipt is required",
                      "symbolic": {
                        "receipt": "required"
                      }
                    }
                  }
                }
              }
            }
          },
          "402": {
            "$ref": "#/components/responses/402_payment_required"
          },
          "422": {
            "$ref": "#/components/responses/422_unprocessable_entity"
          }
        },
        "operationId": "post_administration_id_documents_receipts"
      }
    },
    "/{administration_id}/documents/typeless_documents/synchronization{format}": {
      "get": {
        "summary": "List ids and versions of typeless documents",
        "description": "Returns all documents in the administration. The list contains the document id and the version of the document.\nCheck if the version of the document is newer than the version you have stored locally, use the `POST`\nvariant for fetching documents with the given ids.\n\n### Required scope(s)\n `documents`",
        "tags": [
          "Documents: Typeless documents"
        ],
        "security": [
          {
            "bearerAuth": [
              "documents"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/administration_id"
          },
          {
            "$ref": "#/components/parameters/format"
          },
          {
            "name": "filter",
            "in": "query",
            "required": false,
            "description": "Comma-separated `key:value` filter terms. Same syntax as `GET /documents/typeless_documents` — see that operation's description for the available keys.",
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "IDs and versions of records",
            "content": {
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "type": "object",
                    "unevaluatedProperties": false,
                    "properties": {
                      "id": {
                        "type": [
                          "integer",
                          "string"
                        ]
                      },
                      "version": {
                        "type": [
                          "integer",
                          "string"
                        ]
                      }
                    }
                  }
                },
                "examples": {
                  "RetrievesAllIdsForSynchronization": {
                    "summary": "Retrieves all ids for synchronization",
                    "value": [
                      {
                        "id": "502689201003693575",
                        "version": 1793621801
                      },
                      {
                        "id": "502689201016276489",
                        "version": 1793621801
                      },
                      {
                        "id": "502689201026762251",
                        "version": 1793621801
                      }
                    ]
                  }
                }
              }
            }
          }
        },
        "operationId": "get_administration_id_documents_typeless_documents_synchronization"
      },
      "post": {
        "summary": "Fetch typeless documents with given ids",
        "x-query": true,
        "description": "Given a list of document ids, returns the document information belonging to the documents.\nReturns a maximum of 100 documents, even if more ids are provided.\n\n### Required scope(s)\n `documents`",
        "tags": [
          "Documents: Typeless documents"
        ],
        "security": [
          {
            "bearerAuth": [
              "documents"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/administration_id"
          },
          {
            "$ref": "#/components/parameters/format"
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/*": {
              "schema": {
                "unevaluatedProperties": false,
                "type": "object",
                "properties": {
                  "ids": {
                    "type": "array",
                    "items": {
                      "type": [
                        "integer",
                        "string"
                      ]
                    }
                  }
                },
                "required": [
                  "ids"
                ]
              },
              "examples": {
                "RetrievesDocumentsForGivenIds": {
                  "summary": "Retrieves documents for given ids",
                  "value": {
                    "ids": [
                      502689200896738800,
                      502689200910370300
                    ]
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "A list of typeless documents",
            "content": {
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "$ref": "#/components/schemas/typeless_document_response"
                  }
                },
                "examples": {
                  "RetrievesDocumentsForGivenIds": {
                    "summary": "Retrieves documents for given ids",
                    "value": [
                      {
                        "id": "502689200896738804",
                        "administration_id": 123,
                        "contact_id": null,
                        "contact": null,
                        "reference": "20130456",
                        "date": "2026-11-02",
                        "state": "new",
                        "origin": null,
                        "created_at": "2026-11-02T12:16:41.750Z",
                        "updated_at": "2026-11-02T12:16:41.750Z",
                        "version": 1793621801,
                        "attachments": [],
                        "events": [
                          {
                            "administration_id": 123,
                            "user_id": "502689108256097381",
                            "action": "document_saved",
                            "link_entity_id": null,
                            "link_entity_type": null,
                            "data": {},
                            "created_at": "2026-11-02T12:16:41.753Z",
                            "updated_at": "2026-11-02T12:16:41.753Z"
                          }
                        ]
                      },
                      {
                        "id": "502689200910370294",
                        "administration_id": 123,
                        "contact_id": null,
                        "contact": null,
                        "reference": "20130456",
                        "date": "2026-11-02",
                        "state": "new",
                        "origin": null,
                        "created_at": "2026-11-02T12:16:41.763Z",
                        "updated_at": "2026-11-02T12:16:41.763Z",
                        "version": 1793621801,
                        "attachments": [],
                        "events": [
                          {
                            "administration_id": 123,
                            "user_id": "502689108256097381",
                            "action": "document_saved",
                            "link_entity_id": null,
                            "link_entity_type": null,
                            "data": {},
                            "created_at": "2026-11-02T12:16:41.766Z",
                            "updated_at": "2026-11-02T12:16:41.766Z"
                          }
                        ]
                      }
                    ]
                  }
                }
              }
            }
          }
        },
        "operationId": "post_administration_id_documents_typeless_documents_synchronization"
      }
    },
    "/{administration_id}/documents/typeless_documents/{id}/attachments/{attachment_id}/download{format}": {
      "get": {
        "summary": "Download attachment",
        "description": "Download the attachment. The response will be a redirect to a temporarily available URL\nwhere the attachment can be downloaded. Use the `Location` header in the response\nto download the attachment.\n\n### Required scope(s)\n `documents`",
        "tags": [
          "Documents: Typeless documents"
        ],
        "security": [
          {
            "bearerAuth": [
              "documents"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/administration_id"
          },
          {
            "name": "id",
            "in": "path",
            "required": true,
            "schema": {
              "$ref": "#/components/schemas/identifier"
            }
          },
          {
            "name": "attachment_id",
            "in": "path",
            "required": true,
            "schema": {
              "$ref": "#/components/schemas/identifier"
            }
          },
          {
            "$ref": "#/components/parameters/format"
          }
        ],
        "responses": {
          "302": {
            "description": "Found",
            "content": {
              "text/plain": {
                "schema": {
                  "type": "string"
                },
                "examples": {
                  "DownloadsTheAttachment": {
                    "summary": "Downloads the attachment",
                    "value": "{\"message\":\"Use the Location header to download the attachment\"}"
                  }
                }
              }
            }
          },
          "404": {
            "$ref": "#/components/responses/404_not_found"
          }
        },
        "operationId": "get_administration_id_documents_typeless_documents_id_attachments_attachment_id_download"
      }
    },
    "/{administration_id}/documents/typeless_documents/{id}/attachments/{attachment_id}{format}": {
      "delete": {
        "summary": "Delete an attachment",
        "description": "Deletes an attachment of an attachable.\n\n### Required scope(s)\n `documents`",
        "tags": [
          "Documents: Typeless documents"
        ],
        "security": [
          {
            "bearerAuth": [
              "documents"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/administration_id"
          },
          {
            "name": "id",
            "in": "path",
            "required": true,
            "schema": {
              "$ref": "#/components/schemas/identifier"
            }
          },
          {
            "name": "attachment_id",
            "in": "path",
            "required": true,
            "schema": {
              "$ref": "#/components/schemas/identifier"
            }
          },
          {
            "$ref": "#/components/parameters/format"
          }
        ],
        "responses": {
          "204": {
            "description": "Attachment deleted"
          },
          "404": {
            "$ref": "#/components/responses/404_not_found"
          }
        },
        "operationId": "delete_administration_id_documents_typeless_documents_id_attachments_attachment_id"
      }
    },
    "/{administration_id}/documents/typeless_documents/{id}/attachments{format}": {
      "post": {
        "summary": "Add attachment to typeless document",
        "description": "Add an attachment to a typeless document.\n\n### Required scope(s)\n `documents`",
        "tags": [
          "Documents: Typeless documents"
        ],
        "security": [
          {
            "bearerAuth": [
              "documents"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/administration_id"
          },
          {
            "name": "id",
            "in": "path",
            "required": true,
            "schema": {
              "$ref": "#/components/schemas/identifier"
            }
          },
          {
            "$ref": "#/components/parameters/format"
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "multipart/form-data": {
              "schema": {
                "type": "object",
                "properties": {
                  "file": {
                    "type": "string",
                    "format": "binary"
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Status code",
            "content": {
              "application/json": {
                "schema": {
                  "type": "integer"
                },
                "examples": {
                  "UploadsAnAttachment": {
                    "summary": "Uploads an attachment",
                    "value": 200
                  }
                }
              }
            }
          },
          "400": {
            "$ref": "#/components/responses/400_bad_request"
          },
          "404": {
            "$ref": "#/components/responses/404_not_found"
          },
          "422": {
            "$ref": "#/components/responses/422_unprocessable_entity"
          }
        },
        "operationId": "post_administration_id_documents_typeless_documents_id_attachments"
      }
    },
    "/{administration_id}/documents/typeless_documents/{id}{format}": {
      "get": {
        "summary": "Get a typeless document",
        "description": "Returns a typeless document by id.\n\n### Required scope(s)\n `documents`",
        "tags": [
          "Documents: Typeless documents"
        ],
        "security": [
          {
            "bearerAuth": [
              "documents"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/administration_id"
          },
          {
            "name": "id",
            "in": "path",
            "required": true,
            "schema": {
              "$ref": "#/components/schemas/identifier"
            }
          },
          {
            "$ref": "#/components/parameters/format"
          }
        ],
        "responses": {
          "200": {
            "description": "A typeless document",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/typeless_document_response"
                },
                "examples": {
                  "ReturnsTheWantedTypelessDocument": {
                    "summary": "Returns the wanted typeless document",
                    "value": {
                      "id": "502689200829629921",
                      "administration_id": 123,
                      "contact_id": null,
                      "contact": null,
                      "reference": "20130456",
                      "date": "2026-11-02",
                      "state": "new",
                      "origin": null,
                      "created_at": "2026-11-02T12:16:41.687Z",
                      "updated_at": "2026-11-02T12:16:41.687Z",
                      "version": 1793621801,
                      "attachments": [],
                      "events": [
                        {
                          "administration_id": 123,
                          "user_id": "502689108256097381",
                          "action": "document_saved",
                          "link_entity_id": null,
                          "link_entity_type": null,
                          "data": {},
                          "created_at": "2026-11-02T12:16:41.688Z",
                          "updated_at": "2026-11-02T12:16:41.688Z"
                        }
                      ]
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Not found",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/symbolic_error"
                },
                "examples": {
                  "OnlyReturnsTypelessDocuments": {
                    "summary": "Only returns typeless documents",
                    "value": {
                      "error": "Record not found for model name: Document"
                    }
                  }
                }
              }
            }
          }
        },
        "operationId": "get_administration_id_documents_typeless_documents_id"
      },
      "delete": {
        "summary": "Delete a typeless document",
        "description": "Deletes a typeless document.\n\n### Required scope(s)\n `documents`",
        "tags": [
          "Documents: Typeless documents"
        ],
        "security": [
          {
            "bearerAuth": [
              "documents"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/administration_id"
          },
          {
            "name": "id",
            "in": "path",
            "required": true,
            "schema": {
              "$ref": "#/components/schemas/identifier"
            }
          },
          {
            "$ref": "#/components/parameters/format"
          }
        ],
        "responses": {
          "200": {
            "description": "Status code",
            "content": {
              "application/json": {
                "schema": {
                  "type": "integer"
                },
                "examples": {
                  "DeletesTheTypelessDocument": {
                    "summary": "Deletes the typeless document",
                    "value": 200
                  }
                }
              }
            }
          },
          "404": {
            "$ref": "#/components/responses/404_not_found"
          },
          "422": {
            "$ref": "#/components/responses/422_unprocessable_entity"
          }
        },
        "operationId": "delete_administration_id_documents_typeless_documents_id"
      }
    },
    "/{administration_id}/documents/typeless_documents{format}": {
      "get": {
        "summary": "Get typeless documents",
        "description": "Returns a paginated list of documents of this type in the administration.\n\n### Required scope(s)\n `documents`",
        "tags": [
          "Documents: Typeless documents"
        ],
        "security": [
          {
            "bearerAuth": [
              "documents"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/administration_id"
          },
          {
            "$ref": "#/components/parameters/format"
          },
          {
            "name": "filter",
            "in": "query",
            "required": false,
            "description": "Filters are `key:value` terms separated by commas (e.g. `period:this_year,state:open`). Any filter you pass replaces the defaults below entirely, so include every key you need. Available filters:\n\n| **Filter** | **Type** | **Default** | **Description** |\n| - | - | - | - |\n| period | `String` | `this_year` | A named period (`this_week`, `prev_week`, `next_week`, `this_month`, `prev_month`, `next_month`, `this_quarter`, `prev_quarter`, `next_quarter`, `this_year`, `prev_year`, `next_year`) or a custom range (`201301..201302`, `20130101..20130131`). A custom period must have a start and an end date. It must not be longer than 10 years and must be between `20000101` and `21000101`. For one month, use `202401..202401`, not `202401`. Without `period`, the filter does not limit the dates. The default `this_year` applies only when you send no `filter`. |\n| state | `String` | `all` | `all`, `new`, `saved`, `open`, `paid`, `late` or `pending_payment`. `paid`, `late` and `pending_payment` only apply to documents with a payment lifecycle (purchase invoices and receipts) |\n| recurring | `String` | `all` | `all`, `enabled` or `disabled` |\n| attachment | `String` | `all` | `all`, `with` or `without` |\n| reference | `String` | | Documents with the given reference value |\n| contact_id | `Integer` | | Documents belonging to the given contact |\n| ledger_account_id | `Integer` | | Documents booking against the given ledger account |\n| updated_after | `String` | | ISO 8601 timestamp in UTC; documents updated strictly after this time |\n\nMultiple values for `state`, `recurring` and `attachment` can be combined with a pipe, e.g. `state:open|paid`.",
            "schema": {
              "type": "string",
              "default": "period:this_year"
            },
            "examples": {
              "ReturnsTheOldestTypelessDocumentFirstWhenSortedByDateAscending": {
                "summary": "Returns the oldest typeless document first when sorted by date ascending",
                "value": "period:20251102..20261102"
              }
            }
          },
          {
            "name": "new_filter",
            "in": "query",
            "required": false,
            "schema": {
              "type": "string",
              "description": "String terms, example: `key1:value1,key2:value2`."
            }
          },
          {
            "$ref": "#/components/parameters/page"
          },
          {
            "$ref": "#/components/parameters/sort"
          },
          {
            "$ref": "#/components/parameters/per_page"
          }
        ],
        "responses": {
          "200": {
            "description": "A list of typeless documents",
            "content": {
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "$ref": "#/components/schemas/typeless_document_response"
                  }
                },
                "examples": {
                  "ReturnsAListOfTypelessDocuments": {
                    "summary": "Returns a list of typeless documents",
                    "value": [
                      {
                        "id": "502689200200484165",
                        "administration_id": 123,
                        "contact_id": null,
                        "contact": null,
                        "reference": "20130456",
                        "date": "2026-11-02",
                        "state": "new",
                        "origin": null,
                        "created_at": "2026-11-02T12:16:41.087Z",
                        "updated_at": "2026-11-02T12:16:41.087Z",
                        "version": 1793621801,
                        "attachments": [],
                        "events": [
                          {
                            "administration_id": 123,
                            "user_id": "502689108256097381",
                            "action": "document_saved",
                            "link_entity_id": null,
                            "link_entity_type": null,
                            "data": {},
                            "created_at": "2026-11-02T12:16:41.089Z",
                            "updated_at": "2026-11-02T12:16:41.089Z"
                          }
                        ]
                      },
                      {
                        "id": "502689200194192707",
                        "administration_id": 123,
                        "contact_id": null,
                        "contact": null,
                        "reference": "20130456",
                        "date": "2026-11-02",
                        "state": "new",
                        "origin": null,
                        "created_at": "2026-11-02T12:16:41.080Z",
                        "updated_at": "2026-11-02T12:16:41.080Z",
                        "version": 1793621801,
                        "attachments": [],
                        "events": [
                          {
                            "administration_id": 123,
                            "user_id": "502689108256097381",
                            "action": "document_saved",
                            "link_entity_id": null,
                            "link_entity_type": null,
                            "data": {},
                            "created_at": "2026-11-02T12:16:41.082Z",
                            "updated_at": "2026-11-02T12:16:41.082Z"
                          }
                        ]
                      },
                      {
                        "id": "502689200185804097",
                        "administration_id": 123,
                        "contact_id": null,
                        "contact": null,
                        "reference": "20130456",
                        "date": "2026-11-02",
                        "state": "new",
                        "origin": null,
                        "created_at": "2026-11-02T12:16:41.073Z",
                        "updated_at": "2026-11-02T12:16:41.073Z",
                        "version": 1793621801,
                        "attachments": [],
                        "events": [
                          {
                            "administration_id": 123,
                            "user_id": "502689108256097381",
                            "action": "document_saved",
                            "link_entity_id": null,
                            "link_entity_type": null,
                            "data": {},
                            "created_at": "2026-11-02T12:16:41.075Z",
                            "updated_at": "2026-11-02T12:16:41.075Z"
                          }
                        ]
                      },
                      {
                        "id": "502689200178464063",
                        "administration_id": 123,
                        "contact_id": null,
                        "contact": null,
                        "reference": "20130456",
                        "date": "2026-11-02",
                        "state": "new",
                        "origin": null,
                        "created_at": "2026-11-02T12:16:41.065Z",
                        "updated_at": "2026-11-02T12:16:41.065Z",
                        "version": 1793621801,
                        "attachments": [],
                        "events": [
                          {
                            "administration_id": 123,
                            "user_id": "502689108256097381",
                            "action": "document_saved",
                            "link_entity_id": null,
                            "link_entity_type": null,
                            "data": {},
                            "created_at": "2026-11-02T12:16:41.068Z",
                            "updated_at": "2026-11-02T12:16:41.068Z"
                          }
                        ]
                      }
                    ]
                  },
                  "ReturnsPaginatedTypelessDocumentsOnPage1": {
                    "summary": "Returns paginated typeless documents on page 1",
                    "value": [
                      {
                        "id": "502689200295904604",
                        "administration_id": 123,
                        "contact_id": null,
                        "contact": null,
                        "reference": "20130456",
                        "date": "2026-11-02",
                        "state": "new",
                        "origin": null,
                        "created_at": "2026-11-02T12:16:41.178Z",
                        "updated_at": "2026-11-02T12:16:41.178Z",
                        "version": 1793621801,
                        "attachments": [],
                        "events": [
                          {
                            "administration_id": 123,
                            "user_id": "502689108256097381",
                            "action": "document_saved",
                            "link_entity_id": null,
                            "link_entity_type": null,
                            "data": {},
                            "created_at": "2026-11-02T12:16:41.180Z",
                            "updated_at": "2026-11-02T12:16:41.180Z"
                          }
                        ]
                      }
                    ]
                  },
                  "ReturnsTheOldestTypelessDocumentFirstWhenSortedByDateAscending": {
                    "summary": "Returns the oldest typeless document first when sorted by date ascending",
                    "value": [
                      {
                        "id": "502689200404956533",
                        "administration_id": 123,
                        "contact_id": null,
                        "contact": null,
                        "reference": "image-scan",
                        "date": "2025-11-02",
                        "state": "new",
                        "origin": null,
                        "created_at": "2026-11-02T12:16:41.281Z",
                        "updated_at": "2026-11-02T12:16:41.281Z",
                        "version": 1793621801,
                        "attachments": [],
                        "events": []
                      }
                    ]
                  },
                  "ReturnsPaginatedTypelessDocumentsOnPage2": {
                    "summary": "Returns paginated typeless documents on page 2",
                    "value": [
                      {
                        "id": "502689200489891209",
                        "administration_id": 123,
                        "contact_id": null,
                        "contact": null,
                        "reference": "20130456",
                        "date": "2026-11-02",
                        "state": "new",
                        "origin": null,
                        "created_at": "2026-11-02T12:16:41.363Z",
                        "updated_at": "2026-11-02T12:16:41.363Z",
                        "version": 1793621801,
                        "attachments": [],
                        "events": [
                          {
                            "administration_id": 123,
                            "user_id": "502689108256097381",
                            "action": "document_saved",
                            "link_entity_id": null,
                            "link_entity_type": null,
                            "data": {},
                            "created_at": "2026-11-02T12:16:41.365Z",
                            "updated_at": "2026-11-02T12:16:41.365Z"
                          }
                        ]
                      }
                    ]
                  }
                }
              }
            }
          },
          "400": {
            "description": "Bad request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/symbolic_error"
                },
                "examples": {
                  "ReturnsAnErrorWhenTooManyTypelessDocumentsAreRequested": {
                    "summary": "Returns an error when too many typeless documents are requested",
                    "value": {
                      "error": "Per Page is too big",
                      "symbolic": {
                        "per_page": "max"
                      }
                    }
                  }
                }
              }
            }
          }
        },
        "operationId": "get_administration_id_documents_typeless_documents"
      },
      "post": {
        "summary": "Create a new typeless document",
        "description": "Creates a new typeless document.\n\n### Required scope(s)\n `documents`",
        "tags": [
          "Documents: Typeless documents"
        ],
        "security": [
          {
            "bearerAuth": [
              "documents"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/administration_id"
          },
          {
            "$ref": "#/components/parameters/format"
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/*": {
              "schema": {
                "unevaluatedProperties": false,
                "type": "object",
                "properties": {
                  "typeless_document": {
                    "type": "object",
                    "unevaluatedProperties": false,
                    "properties": {
                      "reference": {
                        "type": "string"
                      },
                      "date": {
                        "type": "string",
                        "format": "date",
                        "description": "Date of the document. Defaults to today."
                      },
                      "contact_id": {
                        "$ref": "#/components/schemas/identifier",
                        "description": "Should be a valid contact id."
                      }
                    },
                    "required": []
                  }
                },
                "required": []
              },
              "examples": {
                "CreatesTheTypelessDocument": {
                  "summary": "Creates the typeless document",
                  "value": {
                    "typeless_document": {
                      "reference": "foobar",
                      "contact_id": 502689199711847600
                    }
                  }
                }
              }
            }
          }
        },
        "responses": {
          "201": {
            "description": "Typeless document created",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/typeless_document_response"
                },
                "examples": {
                  "CreatesTheTypelessDocument": {
                    "summary": "Creates the typeless document",
                    "value": {
                      "id": "502689199794685156",
                      "administration_id": 123,
                      "contact_id": "502689199711847636",
                      "contact": {
                        "id": "502689199711847636",
                        "administration_id": 123,
                        "company_name": "Foobar Holding B.V.",
                        "firstname": null,
                        "lastname": null,
                        "address1": "Hoofdstraat 12",
                        "address2": null,
                        "zipcode": "1234AB",
                        "city": "Amsterdam",
                        "country": "NL",
                        "phone": null,
                        "delivery_method": "Email",
                        "customer_id": "customer-1",
                        "tax_number": null,
                        "chamber_of_commerce": null,
                        "bank_account": null,
                        "is_trusted": false,
                        "max_transfer_amount": null,
                        "attention": null,
                        "email": "info@example.com",
                        "email_ubl": true,
                        "send_invoices_to_attention": null,
                        "send_invoices_to_email": "info@example.com",
                        "send_estimates_to_attention": null,
                        "send_estimates_to_email": "info@example.com",
                        "direct_debit": false,
                        "sepa_active": false,
                        "sepa_iban": null,
                        "sepa_iban_account_name": null,
                        "sepa_bic": null,
                        "sepa_mandate_id": null,
                        "sepa_mandate_date": null,
                        "sepa_sequence_type": "RCUR",
                        "credit_card_number": null,
                        "credit_card_reference": null,
                        "credit_card_type": null,
                        "tax_number_validated_at": null,
                        "tax_number_valid": null,
                        "invoice_workflow_id": null,
                        "estimate_workflow_id": null,
                        "si_identifier": null,
                        "si_identifier_type": null,
                        "moneybird_payments_mandate": false,
                        "created_at": "2026-11-02T12:16:40.620Z",
                        "updated_at": "2026-11-02T12:16:40.620Z",
                        "version": 1793621800,
                        "sales_invoices_url": "https://moneybird.dev/123/sales_invoices/0000000000000000000000000000000000000000000000000000000000000001/all",
                        "notes": [],
                        "custom_fields": [],
                        "contact_people": [],
                        "archived": false
                      },
                      "reference": "foobar",
                      "date": "2026-11-02",
                      "state": "new",
                      "origin": "api",
                      "created_at": "2026-11-02T12:16:40.699Z",
                      "updated_at": "2026-11-02T12:16:40.699Z",
                      "version": 1793621800,
                      "attachments": [],
                      "events": [
                        {
                          "administration_id": 123,
                          "user_id": "502689108256097381",
                          "action": "document_saved",
                          "link_entity_id": null,
                          "link_entity_type": null,
                          "data": {},
                          "created_at": "2026-11-02T12:16:40.703Z",
                          "updated_at": "2026-11-02T12:16:40.703Z"
                        }
                      ]
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "Bad request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/symbolic_error"
                },
                "examples": {
                  "RequiresAllInput": {
                    "summary": "Requires all input",
                    "value": {
                      "error": "Typeless Document is required",
                      "symbolic": {
                        "typeless_document": "required"
                      }
                    }
                  }
                }
              }
            }
          },
          "402": {
            "$ref": "#/components/responses/402_payment_required"
          },
          "422": {
            "$ref": "#/components/responses/422_unprocessable_entity"
          }
        },
        "operationId": "post_administration_id_documents_typeless_documents"
      }
    },
    "/{administration_id}/downloads/{id}/download{format}": {
      "post": {
        "summary": "Download a file",
        "description": "Returns a redirect to the actual file download URL.\nThe required permission scope depends on the download's type (for example `export_documents` requires `documents`, `export_sales_invoices` requires `sales_invoices`, `export_contacts` requires `contacts`, and report exports require the same permissions as the corresponding report). The token must have the permission matching the download type.\nThe response is a 302 redirect. The client should follow the `Location` header to download the actual file. The link is valid for 30 seconds.",
        "tags": [
          "Downloads"
        ],
        "security": [
          {
            "bearerAuth": []
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/administration_id"
          },
          {
            "$ref": "#/components/parameters/format"
          },
          {
            "name": "id",
            "in": "path",
            "required": true,
            "schema": {
              "$ref": "#/components/schemas/identifier"
            },
            "description": "The download ID"
          }
        ],
        "responses": {
          "302": {
            "description": "Found",
            "content": {
              "text/plain": {
                "schema": {
                  "type": "string"
                },
                "examples": {
                  "RedirectsToTheDownloadLink": {
                    "summary": "Redirects to the download link",
                    "value": "{\"message\":\"Use the Location header to download the file\"}"
                  }
                }
              }
            }
          },
          "401": {
            "description": "Unauthorized",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/symbolic_error"
                },
                "examples": {
                  "Returns401WhenUserLacksPermission": {
                    "summary": "Returns 401 when user lacks permission",
                    "value": {
                      "error": "No access to sales_invoices"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Not found",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/symbolic_error"
                },
                "examples": {
                  "Returns404WhenDownloadDoesNotExist": {
                    "summary": "Returns 404 when download does not exist",
                    "value": {
                      "error": "Record not found for model name: Download"
                    }
                  }
                }
              }
            }
          }
        },
        "operationId": "post_administration_id_downloads_id_download"
      }
    },
    "/{administration_id}/downloads{format}": {
      "get": {
        "summary": "List all downloads",
        "description": "Returns a paginated list of all downloads in the administration.\n\nOnly downloads that the authenticated user has permission to access will be returned,\nbased on the download type and the user's permissions within the administration.",
        "tags": [
          "Downloads"
        ],
        "security": [
          {
            "bearerAuth": []
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/administration_id"
          },
          {
            "$ref": "#/components/parameters/format"
          },
          {
            "$ref": "#/components/parameters/per_page"
          },
          {
            "$ref": "#/components/parameters/page"
          },
          {
            "name": "download_type",
            "in": "query",
            "required": false,
            "schema": {
              "type": "string"
            },
            "description": "Filter downloads by type. Common download types include:\n- `auditfile`\n- `brugstaat`\n- `export_ledger_account_report`\n\nCheck the `download_type` field in the response to see all available types.\n",
            "examples": {
              "ReturnsDownloadsByDownloadType": {
                "summary": "Returns downloads by download type",
                "value": "export_contacts"
              }
            }
          },
          {
            "name": "downloaded",
            "in": "query",
            "required": false,
            "schema": {
              "type": [
                "boolean",
                "string"
              ]
            },
            "examples": {
              "ReturnsDownloadsByDownloadedStatus": {
                "summary": "Returns downloads by downloaded status",
                "value": "true"
              }
            }
          },
          {
            "name": "failed",
            "in": "query",
            "required": false,
            "schema": {
              "type": [
                "boolean",
                "string"
              ]
            },
            "examples": {
              "ReturnsDownloadsByFailedStatus": {
                "summary": "Returns downloads by failed status",
                "value": "true"
              }
            }
          }
        ],
        "responses": {
          "200": {
            "description": "A list of downloads",
            "headers": {
              "Link": {
                "$ref": "#/components/headers/link"
              },
              "X-Total-Count": {
                "$ref": "#/components/headers/x-total-count"
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "$ref": "#/components/schemas/download_response"
                  }
                },
                "examples": {
                  "ReturnsAllDownloadsOfAnAdministration": {
                    "summary": "Returns all downloads of an administration",
                    "value": [
                      {
                        "id": "502689136622175743",
                        "user_id": null,
                        "download_type": "export_documents",
                        "filename": "Unknown",
                        "content_type": "application/octet-stream",
                        "failed": true,
                        "downloaded": false,
                        "created_at": "2026-11-02T12:15:40.454Z",
                        "updated_at": "2026-11-02T12:15:40.454Z"
                      },
                      {
                        "id": "502689136620078590",
                        "user_id": null,
                        "download_type": "export_sales_invoices",
                        "filename": "Unknown",
                        "content_type": "application/octet-stream",
                        "failed": false,
                        "downloaded": true,
                        "created_at": "2026-11-02T12:15:40.452Z",
                        "updated_at": "2026-11-02T12:15:40.452Z"
                      },
                      {
                        "id": "502689136615884285",
                        "user_id": null,
                        "download_type": "export_contacts",
                        "filename": "Unknown",
                        "content_type": "application/octet-stream",
                        "failed": false,
                        "downloaded": false,
                        "created_at": "2026-11-02T12:15:40.447Z",
                        "updated_at": "2026-11-02T12:15:40.447Z"
                      }
                    ]
                  },
                  "ReturnsDownloadsByDownloadType": {
                    "summary": "Returns downloads by download type",
                    "value": [
                      {
                        "id": "502689136741713411",
                        "user_id": null,
                        "download_type": "export_contacts",
                        "filename": "Unknown",
                        "content_type": "application/octet-stream",
                        "failed": false,
                        "downloaded": false,
                        "created_at": "2026-11-02T12:15:40.567Z",
                        "updated_at": "2026-11-02T12:15:40.567Z"
                      }
                    ]
                  },
                  "ReturnsDownloadsByDownloadedStatus": {
                    "summary": "Returns downloads by downloaded status",
                    "value": [
                      {
                        "id": "502689136797287943",
                        "user_id": null,
                        "download_type": "export_sales_invoices",
                        "filename": "Unknown",
                        "content_type": "application/octet-stream",
                        "failed": false,
                        "downloaded": true,
                        "created_at": "2026-11-02T12:15:40.620Z",
                        "updated_at": "2026-11-02T12:15:40.620Z"
                      }
                    ]
                  },
                  "ReturnsDownloadsByFailedStatus": {
                    "summary": "Returns downloads by failed status",
                    "value": [
                      {
                        "id": "502689136852862475",
                        "user_id": null,
                        "download_type": "export_documents",
                        "filename": "Unknown",
                        "content_type": "application/octet-stream",
                        "failed": true,
                        "downloaded": false,
                        "created_at": "2026-11-02T12:15:40.673Z",
                        "updated_at": "2026-11-02T12:15:40.673Z"
                      }
                    ]
                  },
                  "ReturnsPaginatedDownloads": {
                    "summary": "Returns paginated downloads",
                    "value": [
                      {
                        "id": "502689136918922765",
                        "user_id": null,
                        "download_type": "export_sales_invoices",
                        "filename": "Unknown",
                        "content_type": "application/octet-stream",
                        "failed": false,
                        "downloaded": true,
                        "created_at": "2026-11-02T12:15:40.736Z",
                        "updated_at": "2026-11-02T12:15:40.736Z"
                      }
                    ]
                  }
                }
              }
            }
          },
          "400": {
            "description": "Bad request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/symbolic_error"
                },
                "examples": {
                  "ReturnsAnErrorWhenDownloadTypeIsInvalid": {
                    "summary": "Returns an error when download type is invalid",
                    "value": {
                      "error": "download_type does not have a valid value"
                    }
                  },
                  "ReturnsAnErrorWhenPerPageExceedsLimit": {
                    "summary": "Returns an error when per page exceeds limit",
                    "value": {
                      "error": "per_page does not have a valid value"
                    }
                  }
                }
              }
            }
          }
        },
        "operationId": "get_administration_id_downloads"
      }
    },
    "/{administration_id}/estimates/find_by_estimate_id/{estimate_id}{format}": {
      "get": {
        "summary": "Get an estimate by estimate_id",
        "description": "Returns all information about an estimate with the given estimate id\n\n### Required scope(s)\n `estimates`",
        "tags": [
          "Estimates"
        ],
        "security": [
          {
            "bearerAuth": [
              "estimates"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/administration_id"
          },
          {
            "name": "estimate_id",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string",
              "description": "Unique record identifier",
              "example": "2025-0001"
            }
          },
          {
            "$ref": "#/components/parameters/format"
          }
        ],
        "responses": {
          "200": {
            "description": "An estimate",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/estimate_response"
                },
                "examples": {
                  "ReturnsEstimateByGivenEstimateId": {
                    "summary": "Returns estimate by given estimate",
                    "value": {
                      "id": "502689233459218087",
                      "administration_id": 123,
                      "contact_id": "502689233424615074",
                      "contact": {
                        "id": "502689233424615074",
                        "administration_id": 123,
                        "company_name": "Foobar Holding B.V.",
                        "firstname": null,
                        "lastname": null,
                        "address1": "Hoofdstraat 12",
                        "address2": null,
                        "zipcode": "1234AB",
                        "city": "Amsterdam",
                        "country": "NL",
                        "phone": null,
                        "delivery_method": "Email",
                        "customer_id": "customer-1",
                        "tax_number": null,
                        "chamber_of_commerce": null,
                        "bank_account": null,
                        "is_trusted": false,
                        "max_transfer_amount": null,
                        "attention": null,
                        "email": "info@example.com",
                        "email_ubl": true,
                        "send_invoices_to_attention": null,
                        "send_invoices_to_email": "info@example.com",
                        "send_estimates_to_attention": null,
                        "send_estimates_to_email": "info@example.com",
                        "direct_debit": false,
                        "sepa_active": false,
                        "sepa_iban": null,
                        "sepa_iban_account_name": null,
                        "sepa_bic": null,
                        "sepa_mandate_id": null,
                        "sepa_mandate_date": null,
                        "sepa_sequence_type": "RCUR",
                        "credit_card_number": null,
                        "credit_card_reference": null,
                        "credit_card_type": null,
                        "tax_number_validated_at": null,
                        "tax_number_valid": null,
                        "invoice_workflow_id": null,
                        "estimate_workflow_id": null,
                        "si_identifier": null,
                        "si_identifier_type": null,
                        "moneybird_payments_mandate": false,
                        "created_at": "2026-11-02T12:17:12.771Z",
                        "updated_at": "2026-11-02T12:17:12.771Z",
                        "version": 1793621832,
                        "sales_invoices_url": "https://moneybird.dev/123/sales_invoices/0000000000000000000000000000000000000000000000000000000000000001/all",
                        "notes": [],
                        "custom_fields": [],
                        "contact_people": [],
                        "archived": false
                      },
                      "contact_person_id": "502689233429857956",
                      "contact_person": {
                        "id": null,
                        "contact_id": "502689233424615074",
                        "administration_id": 123,
                        "firstname": "Jan",
                        "lastname": "Janssen",
                        "phone": "123-456-2346",
                        "email": "janjanssen@dev.null.moneybird.net",
                        "department": "Sales",
                        "created_at": "2026-11-02T12:17:12.776Z",
                        "updated_at": "2026-11-02T12:17:12.776Z",
                        "version": 1793621832
                      },
                      "estimate_id": "2026-0001",
                      "estimate_sequence_id": "0001",
                      "workflow_id": "502689109222884501",
                      "document_style_id": "502689109280556185",
                      "identity_id": "502689108656653419",
                      "draft_id": null,
                      "state": "open",
                      "estimate_date": "2026-11-02",
                      "due_date": "2026-11-16",
                      "reference": "Project X",
                      "language": "nl",
                      "currency": "EUR",
                      "exchange_rate": "1.0",
                      "discount": "0.0",
                      "original_estimate_id": null,
                      "show_tax": true,
                      "sign_online": true,
                      "sent_at": "2026-11-02",
                      "accepted_at": null,
                      "rejected_at": null,
                      "archived_at": null,
                      "created_at": "2026-11-02T12:17:12.805Z",
                      "updated_at": "2026-11-02T12:17:12.839Z",
                      "public_view_code": "315517",
                      "public_view_code_expires_at": "2027-02-02T12:17:12.823Z",
                      "version": 1793621832,
                      "pre_text": "Hello, here is your quote",
                      "post_text": "Please sign it",
                      "details": [
                        {
                          "id": "502689233461315240",
                          "administration_id": 123,
                          "tax_rate_id": "502689108899923082",
                          "ledger_account_id": "502689108787725434",
                          "project_id": null,
                          "product_id": null,
                          "amount": "1 x",
                          "amount_decimal": "1.0",
                          "description": "Project X",
                          "price": "300.0",
                          "period": null,
                          "row_order": 1,
                          "total_price_excl_tax_with_discount": "300.0",
                          "total_price_excl_tax_with_discount_base": "300.0",
                          "tax_report_reference": [
                            "NL/1a"
                          ],
                          "mandatory_tax_text": null,
                          "created_at": "2026-11-02T12:17:12.807Z",
                          "updated_at": "2026-11-02T12:17:12.838Z",
                          "is_optional": false,
                          "is_selected": true
                        }
                      ],
                      "prices_are_incl_tax": false,
                      "total_price_excl_tax": "300.0",
                      "total_price_excl_tax_base": "300.0",
                      "total_price_incl_tax": "363.0",
                      "total_price_incl_tax_base": "363.0",
                      "total_discount": "0.0",
                      "url": "http://moneybird.dev/123/external/0000000000000000000000000000000000000000000000000000000000000001/a74d452db2e3b38e4c9539c174ec36ae9b8a853d00436e42443ff34d3a513d8d/estimate",
                      "custom_fields": [],
                      "notes": [],
                      "attachments": [],
                      "events": [
                        {
                          "administration_id": 123,
                          "user_id": "502689108256097381",
                          "action": "estimate_created",
                          "link_entity_id": null,
                          "link_entity_type": null,
                          "data": {},
                          "created_at": "2026-11-02T12:17:12.811Z",
                          "updated_at": "2026-11-02T12:17:12.811Z"
                        },
                        {
                          "administration_id": 123,
                          "user_id": "502689108256097381",
                          "action": "estimate_send_email",
                          "link_entity_id": null,
                          "link_entity_type": null,
                          "data": {
                            "email_address": "info@example.com; janjanssen@dev.null.moneybird.net",
                            "email_message": "Geachte Jan Janssen,\n\nHierbij ontvangt u van ons een prijsopgave 2026-0001 voor onze\ndiensten.\n\nMet vriendelijke groet,\n\nParkietje B.V."
                          },
                          "created_at": "2026-11-02T12:17:12.843Z",
                          "updated_at": "2026-11-02T12:17:12.843Z"
                        }
                      ],
                      "tax_totals": [
                        {
                          "tax_rate_id": "502689108899923082",
                          "taxable_amount": "300.0",
                          "taxable_amount_base": "300.0",
                          "tax_amount": "63.0",
                          "tax_amount_base": "63.0"
                        }
                      ]
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Not found",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/symbolic_error"
                },
                "examples": {
                  "RespondsWithA404CodeWhenEstimateDoesNotExist": {
                    "summary": "Responds with a 404 code when estimate does not exist",
                    "value": {
                      "error": "Estimate with estimate_id: 0 was not found",
                      "symbolic": {
                        "estimate_id": "not_found"
                      }
                    }
                  }
                }
              }
            }
          }
        },
        "operationId": "get_administration_id_estimates_find_by_estimate_id_estimate_id"
      }
    },
    "/{administration_id}/estimates/synchronization{format}": {
      "get": {
        "summary": "List all ids and versions",
        "description": "Returns all estimates in the administration. The list contains the id and version of the estimate.\nIf the version of the estimate is newer than the version you have stored locally, use the `POST`\nvariant to fetch estimates with the given ids.\n\n### Required scope(s)\n `estimates`",
        "tags": [
          "Estimates"
        ],
        "security": [
          {
            "bearerAuth": [
              "estimates"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/administration_id"
          },
          {
            "$ref": "#/components/parameters/format"
          },
          {
            "name": "filter",
            "in": "query",
            "required": false,
            "description": "Comma-separated `key:value` filter terms. Same syntax as `GET /estimates` — see that operation's description for the available keys.",
            "schema": {
              "type": "string"
            },
            "examples": {
              "RetrievesTheIdsForSynchronizationFilteredOnState": {
                "summary": "Retrieves the ids for synchronization filtered on state",
                "value": "state:open"
              }
            }
          }
        ],
        "responses": {
          "200": {
            "description": "IDs and versions of records",
            "content": {
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "type": "object",
                    "unevaluatedProperties": false,
                    "properties": {
                      "id": {
                        "type": [
                          "integer",
                          "string"
                        ]
                      },
                      "version": {
                        "type": [
                          "integer",
                          "string"
                        ]
                      }
                    }
                  }
                },
                "examples": {
                  "RetrievesTheIdsForSynchronization": {
                    "summary": "Retrieves the ids for synchronization",
                    "value": [
                      {
                        "id": "502689233816782535",
                        "version": 1793621833
                      },
                      {
                        "id": "502689233733945026",
                        "version": 1793621833
                      }
                    ]
                  },
                  "RetrievesTheIdsForSynchronizationFilteredOnState": {
                    "summary": "Retrieves the ids for synchronization filtered on state",
                    "value": [
                      {
                        "id": "502689233882842832",
                        "version": 1793621833
                      }
                    ]
                  }
                }
              }
            }
          }
        },
        "operationId": "get_administration_id_estimates_synchronization"
      },
      "post": {
        "summary": "Fetch estimates with given ids",
        "x-query": true,
        "description": "Given a list of estimate ids, returns the estimate information belonging to the estimates.\nReturns a maximum of 100 estimates, even if more ids are provided.\n\n### Required scope(s)\n `estimates`",
        "tags": [
          "Estimates"
        ],
        "security": [
          {
            "bearerAuth": [
              "estimates"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/administration_id"
          },
          {
            "$ref": "#/components/parameters/format"
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/*": {
              "schema": {
                "unevaluatedProperties": false,
                "type": "object",
                "properties": {
                  "ids": {
                    "type": "array",
                    "items": {
                      "type": [
                        "integer",
                        "string"
                      ]
                    }
                  }
                },
                "required": [
                  "ids"
                ]
              },
              "examples": {
                "RetrievesEstimatesByGivenIds": {
                  "summary": "Retrieves estimates by given ids",
                  "value": {
                    "ids": [
                      502689232025814600,
                      502689232100263500
                    ]
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "A list of estimates",
            "content": {
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "$ref": "#/components/schemas/estimate_response"
                  }
                },
                "examples": {
                  "RetrievesEstimatesByGivenIds": {
                    "summary": "Retrieves estimates by given ids",
                    "value": [
                      {
                        "id": "502689232025814588",
                        "administration_id": 123,
                        "contact_id": "502689231996454455",
                        "contact": {
                          "id": "502689231996454455",
                          "administration_id": 123,
                          "company_name": "Foobar Holding B.V.",
                          "firstname": null,
                          "lastname": null,
                          "address1": "Hoofdstraat 12",
                          "address2": null,
                          "zipcode": "1234AB",
                          "city": "Amsterdam",
                          "country": "NL",
                          "phone": null,
                          "delivery_method": "Email",
                          "customer_id": "customer-1",
                          "tax_number": null,
                          "chamber_of_commerce": null,
                          "bank_account": null,
                          "is_trusted": false,
                          "max_transfer_amount": null,
                          "attention": null,
                          "email": "info@example.com",
                          "email_ubl": true,
                          "send_invoices_to_attention": null,
                          "send_invoices_to_email": "info@example.com",
                          "send_estimates_to_attention": null,
                          "send_estimates_to_email": "info@example.com",
                          "direct_debit": false,
                          "sepa_active": false,
                          "sepa_iban": null,
                          "sepa_iban_account_name": null,
                          "sepa_bic": null,
                          "sepa_mandate_id": null,
                          "sepa_mandate_date": null,
                          "sepa_sequence_type": "RCUR",
                          "credit_card_number": null,
                          "credit_card_reference": null,
                          "credit_card_type": null,
                          "tax_number_validated_at": null,
                          "tax_number_valid": null,
                          "invoice_workflow_id": null,
                          "estimate_workflow_id": null,
                          "si_identifier": null,
                          "si_identifier_type": null,
                          "moneybird_payments_mandate": false,
                          "created_at": "2026-11-02T12:17:11.410Z",
                          "updated_at": "2026-11-02T12:17:11.410Z",
                          "version": 1793621831,
                          "sales_invoices_url": "https://moneybird.dev/123/sales_invoices/0000000000000000000000000000000000000000000000000000000000000001/all",
                          "notes": [],
                          "custom_fields": [],
                          "contact_people": [],
                          "archived": false
                        },
                        "contact_person_id": "502689231999600185",
                        "contact_person": {
                          "id": null,
                          "contact_id": "502689231996454455",
                          "administration_id": 123,
                          "firstname": "Jan",
                          "lastname": "Janssen",
                          "phone": "123-456-2346",
                          "email": "janjanssen@dev.null.moneybird.net",
                          "department": "Sales",
                          "created_at": "2026-11-02T12:17:11.413Z",
                          "updated_at": "2026-11-02T12:17:11.413Z",
                          "version": 1793621831
                        },
                        "estimate_id": "2026-0001",
                        "estimate_sequence_id": "0001",
                        "workflow_id": "502689109222884501",
                        "document_style_id": "502689109280556185",
                        "identity_id": "502689108656653419",
                        "draft_id": null,
                        "state": "open",
                        "estimate_date": "2026-11-02",
                        "due_date": "2026-11-16",
                        "reference": "Project X",
                        "language": "nl",
                        "currency": "EUR",
                        "exchange_rate": "1.0",
                        "discount": "0.0",
                        "original_estimate_id": null,
                        "show_tax": true,
                        "sign_online": true,
                        "sent_at": "2026-11-02",
                        "accepted_at": null,
                        "rejected_at": null,
                        "archived_at": null,
                        "created_at": "2026-11-02T12:17:11.437Z",
                        "updated_at": "2026-11-02T12:17:11.480Z",
                        "public_view_code": "983281",
                        "public_view_code_expires_at": "2027-02-02T12:17:11.461Z",
                        "version": 1793621831,
                        "pre_text": "Hello, here is your quote",
                        "post_text": "Please sign it",
                        "details": [
                          {
                            "id": "502689232027911741",
                            "administration_id": 123,
                            "tax_rate_id": "502689108899923082",
                            "ledger_account_id": "502689108787725434",
                            "project_id": null,
                            "product_id": null,
                            "amount": "1 x",
                            "amount_decimal": "1.0",
                            "description": "Project X",
                            "price": "300.0",
                            "period": null,
                            "row_order": 1,
                            "total_price_excl_tax_with_discount": "300.0",
                            "total_price_excl_tax_with_discount_base": "300.0",
                            "tax_report_reference": [
                              "NL/1a"
                            ],
                            "mandatory_tax_text": null,
                            "created_at": "2026-11-02T12:17:11.439Z",
                            "updated_at": "2026-11-02T12:17:11.479Z",
                            "is_optional": false,
                            "is_selected": true
                          }
                        ],
                        "prices_are_incl_tax": false,
                        "total_price_excl_tax": "300.0",
                        "total_price_excl_tax_base": "300.0",
                        "total_price_incl_tax": "363.0",
                        "total_price_incl_tax_base": "363.0",
                        "total_discount": "0.0",
                        "url": "http://moneybird.dev/123/external/0000000000000000000000000000000000000000000000000000000000000001/d01fc1d50f16847226ba100d9666886fde4f1f29fa414ac65124d7dad77a4484/estimate",
                        "custom_fields": [],
                        "notes": [],
                        "attachments": [],
                        "events": [
                          {
                            "administration_id": 123,
                            "user_id": "502689108256097381",
                            "action": "estimate_created",
                            "link_entity_id": null,
                            "link_entity_type": null,
                            "data": {},
                            "created_at": "2026-11-02T12:17:11.444Z",
                            "updated_at": "2026-11-02T12:17:11.444Z"
                          },
                          {
                            "administration_id": 123,
                            "user_id": "502689108256097381",
                            "action": "estimate_send_email",
                            "link_entity_id": null,
                            "link_entity_type": null,
                            "data": {
                              "email_address": "info@example.com; janjanssen@dev.null.moneybird.net",
                              "email_message": "Geachte Jan Janssen,\n\nHierbij ontvangt u van ons een prijsopgave 2026-0001 voor onze\ndiensten.\n\nMet vriendelijke groet,\n\nParkietje B.V."
                            },
                            "created_at": "2026-11-02T12:17:11.487Z",
                            "updated_at": "2026-11-02T12:17:11.487Z"
                          }
                        ],
                        "tax_totals": [
                          {
                            "tax_rate_id": "502689108899923082",
                            "taxable_amount": "300.0",
                            "taxable_amount_base": "300.0",
                            "tax_amount": "63.0",
                            "tax_amount_base": "63.0"
                          }
                        ]
                      },
                      {
                        "id": "502689232100263489",
                        "administration_id": 123,
                        "contact_id": "502689231996454455",
                        "contact": {
                          "id": "502689231996454455",
                          "administration_id": 123,
                          "company_name": "Foobar Holding B.V.",
                          "firstname": null,
                          "lastname": null,
                          "address1": "Hoofdstraat 12",
                          "address2": null,
                          "zipcode": "1234AB",
                          "city": "Amsterdam",
                          "country": "NL",
                          "phone": null,
                          "delivery_method": "Email",
                          "customer_id": "customer-1",
                          "tax_number": null,
                          "chamber_of_commerce": null,
                          "bank_account": null,
                          "is_trusted": false,
                          "max_transfer_amount": null,
                          "attention": null,
                          "email": "info@example.com",
                          "email_ubl": true,
                          "send_invoices_to_attention": null,
                          "send_invoices_to_email": "info@example.com",
                          "send_estimates_to_attention": null,
                          "send_estimates_to_email": "info@example.com",
                          "direct_debit": false,
                          "sepa_active": false,
                          "sepa_iban": null,
                          "sepa_iban_account_name": null,
                          "sepa_bic": null,
                          "sepa_mandate_id": null,
                          "sepa_mandate_date": null,
                          "sepa_sequence_type": "RCUR",
                          "credit_card_number": null,
                          "credit_card_reference": null,
                          "credit_card_type": null,
                          "tax_number_validated_at": null,
                          "tax_number_valid": null,
                          "invoice_workflow_id": null,
                          "estimate_workflow_id": null,
                          "si_identifier": null,
                          "si_identifier_type": null,
                          "moneybird_payments_mandate": false,
                          "created_at": "2026-11-02T12:17:11.410Z",
                          "updated_at": "2026-11-02T12:17:11.410Z",
                          "version": 1793621831,
                          "sales_invoices_url": "https://moneybird.dev/123/sales_invoices/0000000000000000000000000000000000000000000000000000000000000001/all",
                          "notes": [],
                          "custom_fields": [],
                          "contact_people": [
                            {
                              "id": "502689231999600185",
                              "contact_id": "502689231996454455",
                              "administration_id": 123,
                              "firstname": "Jan",
                              "lastname": "Janssen",
                              "phone": "123-456-2346",
                              "email": "janjanssen@dev.null.moneybird.net",
                              "department": "Sales",
                              "created_at": "2026-11-02T12:17:11.413Z",
                              "updated_at": "2026-11-02T12:17:11.413Z",
                              "version": 1793621831
                            }
                          ],
                          "archived": false
                        },
                        "contact_person_id": null,
                        "contact_person": null,
                        "estimate_id": null,
                        "estimate_sequence_id": null,
                        "workflow_id": "502689109222884501",
                        "document_style_id": "502689109280556185",
                        "identity_id": "502689108656653419",
                        "draft_id": 2,
                        "state": "draft",
                        "estimate_date": null,
                        "due_date": "2026-11-16",
                        "reference": "Project X",
                        "language": "nl",
                        "currency": "EUR",
                        "exchange_rate": "1.0",
                        "discount": "0.0",
                        "original_estimate_id": null,
                        "show_tax": true,
                        "sign_online": true,
                        "sent_at": null,
                        "accepted_at": null,
                        "rejected_at": null,
                        "archived_at": null,
                        "created_at": "2026-11-02T12:17:11.508Z",
                        "updated_at": "2026-11-02T12:17:11.511Z",
                        "public_view_code": null,
                        "public_view_code_expires_at": null,
                        "version": 1793621831,
                        "pre_text": "Hello, here is your quote",
                        "post_text": "Please sign it",
                        "details": [
                          {
                            "id": "502689232101312066",
                            "administration_id": 123,
                            "tax_rate_id": "502689108899923082",
                            "ledger_account_id": "502689108787725434",
                            "project_id": null,
                            "product_id": null,
                            "amount": "1 x",
                            "amount_decimal": "1.0",
                            "description": "Project X",
                            "price": "300.0",
                            "period": null,
                            "row_order": 1,
                            "total_price_excl_tax_with_discount": "300.0",
                            "total_price_excl_tax_with_discount_base": "300.0",
                            "tax_report_reference": [
                              "NL/1a"
                            ],
                            "mandatory_tax_text": null,
                            "created_at": "2026-11-02T12:17:11.510Z",
                            "updated_at": "2026-11-02T12:17:11.510Z",
                            "is_optional": false,
                            "is_selected": true
                          }
                        ],
                        "prices_are_incl_tax": false,
                        "total_price_excl_tax": "300.0",
                        "total_price_excl_tax_base": "300.0",
                        "total_price_incl_tax": "363.0",
                        "total_price_incl_tax_base": "363.0",
                        "total_discount": "0.0",
                        "url": "http://moneybird.dev/123/external/0000000000000000000000000000000000000000000000000000000000000001/f2f44768854d5018273879b22e2336f6eb557928d85fc332a07a5229f759d2de/estimate",
                        "custom_fields": [],
                        "notes": [],
                        "attachments": [],
                        "events": [
                          {
                            "administration_id": 123,
                            "user_id": "502689108256097381",
                            "action": "estimate_created",
                            "link_entity_id": null,
                            "link_entity_type": null,
                            "data": {},
                            "created_at": "2026-11-02T12:17:11.513Z",
                            "updated_at": "2026-11-02T12:17:11.513Z"
                          }
                        ],
                        "tax_totals": [
                          {
                            "tax_rate_id": "502689108899923082",
                            "taxable_amount": "300.0",
                            "taxable_amount_base": "300.0",
                            "tax_amount": "63.0",
                            "tax_amount_base": "63.0"
                          }
                        ]
                      }
                    ]
                  }
                }
              }
            }
          },
          "400": {
            "description": "Bad request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/symbolic_error"
                },
                "examples": {
                  "Returns400IfIdsParamIsMissing": {
                    "summary": "Returns 400 if ids param is missing",
                    "value": {
                      "error": "Ids is required",
                      "symbolic": {
                        "ids": "required"
                      }
                    }
                  }
                }
              }
            }
          }
        },
        "operationId": "post_administration_id_estimates_synchronization"
      }
    },
    "/{administration_id}/estimates/{estimate_id}/attachments/{id}/download{format}": {
      "get": {
        "summary": "Download attachment",
        "description": "Download the attachment. The response will be a redirect to a temporarily available URL\nwhere the attachment can be downloaded. Use the `Location` header in the response\nto download the attachment.\n\n### Required scope(s)\n `estimates`",
        "tags": [
          "Estimates"
        ],
        "security": [
          {
            "bearerAuth": [
              "estimates"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/administration_id"
          },
          {
            "name": "estimate_id",
            "in": "path",
            "required": true,
            "schema": {
              "$ref": "#/components/schemas/identifier"
            }
          },
          {
            "name": "id",
            "in": "path",
            "required": true,
            "schema": {
              "$ref": "#/components/schemas/identifier"
            }
          },
          {
            "$ref": "#/components/parameters/format"
          }
        ],
        "responses": {
          "302": {
            "description": "Found",
            "content": {
              "text/plain": {
                "schema": {
                  "type": "string"
                },
                "examples": {
                  "DownloadsTheAttachment": {
                    "summary": "Downloads the attachment",
                    "value": "{\"message\":\"Use the Location header to download the attachment\"}"
                  }
                }
              }
            }
          },
          "404": {
            "$ref": "#/components/responses/404_not_found"
          }
        },
        "operationId": "get_administration_id_estimates_estimate_id_attachments_id_download"
      }
    },
    "/{administration_id}/estimates/{estimate_id}/attachments/{id}{format}": {
      "delete": {
        "summary": "Delete an attachment",
        "description": "Deletes an attachment of an attachable.\n\n### Required scope(s)\n `estimates`",
        "tags": [
          "Estimates"
        ],
        "security": [
          {
            "bearerAuth": [
              "estimates"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/administration_id"
          },
          {
            "name": "estimate_id",
            "in": "path",
            "required": true,
            "schema": {
              "$ref": "#/components/schemas/identifier"
            }
          },
          {
            "name": "id",
            "in": "path",
            "required": true,
            "schema": {
              "$ref": "#/components/schemas/identifier"
            }
          },
          {
            "$ref": "#/components/parameters/format"
          }
        ],
        "responses": {
          "204": {
            "description": "Attachment deleted"
          },
          "404": {
            "$ref": "#/components/responses/404_not_found"
          }
        },
        "operationId": "delete_administration_id_estimates_estimate_id_attachments_id"
      }
    },
    "/{administration_id}/estimates/{estimate_id}/notes/{id}{format}": {
      "delete": {
        "summary": "Destroys note from entity",
        "description": "Deletes a note from the estimate.\n\n### Required scope(s)\n `estimates`",
        "tags": [
          "Estimates"
        ],
        "security": [
          {
            "bearerAuth": [
              "estimates"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/administration_id"
          },
          {
            "name": "estimate_id",
            "in": "path",
            "required": true,
            "schema": {
              "$ref": "#/components/schemas/identifier"
            }
          },
          {
            "name": "id",
            "in": "path",
            "required": true,
            "schema": {
              "$ref": "#/components/schemas/identifier"
            }
          },
          {
            "$ref": "#/components/parameters/format"
          }
        ],
        "responses": {
          "204": {
            "description": "Note deleted"
          },
          "404": {
            "description": "Not found",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/symbolic_error"
                },
                "examples": {
                  "Returns404IfTheIdIsWrong": {
                    "summary": "Returns 404 if the id is wrong",
                    "value": {
                      "error": "record not found",
                      "symbolic": {
                        "id": "not_found"
                      }
                    }
                  }
                }
              }
            }
          }
        },
        "operationId": "delete_administration_id_estimates_estimate_id_notes_id"
      }
    },
    "/{administration_id}/estimates/{estimate_id}/notes{format}": {
      "post": {
        "summary": "Adds note to entity",
        "description": "Adds a note to the estimate.\n\n### Required scope(s)\n `estimates`",
        "tags": [
          "Estimates"
        ],
        "security": [
          {
            "bearerAuth": [
              "estimates"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/administration_id"
          },
          {
            "name": "estimate_id",
            "in": "path",
            "required": true,
            "schema": {
              "$ref": "#/components/schemas/identifier"
            }
          },
          {
            "$ref": "#/components/parameters/format"
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/*": {
              "schema": {
                "unevaluatedProperties": false,
                "type": "object",
                "properties": {
                  "note": {
                    "type": "object",
                    "unevaluatedProperties": false,
                    "properties": {
                      "note": {
                        "type": "string",
                        "description": "**Required**. Text for the note or to-do."
                      },
                      "todo": {
                        "type": [
                          "boolean",
                          "string"
                        ],
                        "description": "If `true` the note is a to-do."
                      },
                      "assignee_id": {
                        "$ref": "#/components/schemas/identifier",
                        "description": "Assign to-do to user. Should be a valid user id. If assignee_id is provided the note will be a to-do."
                      }
                    },
                    "required": []
                  }
                },
                "required": []
              },
              "examples": {
                "CreatesANote": {
                  "summary": "Creates a note",
                  "value": {
                    "note": {
                      "note": "A pending TODO",
                      "assignee_id": 502689226347775170,
                      "todo": true
                    }
                  }
                }
              }
            }
          }
        },
        "responses": {
          "201": {
            "description": "Note created",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/note_response"
                },
                "examples": {
                  "CreatesANote": {
                    "summary": "Creates a note",
                    "value": {
                      "id": "502689226360358065",
                      "administration_id": 123,
                      "entity_id": "502689226295346346",
                      "entity_type": "Estimate",
                      "user_id": "502689108256097381",
                      "assignee_id": "502689226347775151",
                      "todo": true,
                      "note": "A pending TODO",
                      "completed_at": null,
                      "completed_by_id": null,
                      "todo_type": null,
                      "data": {},
                      "created_at": "2026-11-02T12:17:06.035Z",
                      "updated_at": "2026-11-02T12:17:06.035Z"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "Bad request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/symbolic_error"
                },
                "examples": {
                  "Returns400IfTheEstimateDoesNotExist": {
                    "summary": "Returns 400 if the estimate does not exist",
                    "value": {
                      "error": "Entity is invalid; User has no permissions to notes for Estimate",
                      "symbolic": {
                        "entity": "not_found",
                        "user": "insufficient_permissions"
                      }
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "Unprocessable entity",
            "content": {
              "application/json": {
                "schema": {
                  "anyOf": [
                    {
                      "$ref": "#/components/schemas/symbolic_error"
                    },
                    {
                      "$ref": "#/components/schemas/non_symbolic_error"
                    }
                  ]
                },
                "examples": {
                  "Returns422IfTheNoteIsInvalid": {
                    "summary": "Returns 422 if the note is invalid",
                    "value": {
                      "error": {
                        "note": [
                          "can't be blank"
                        ],
                        "todo_type": [
                          "can't be blank"
                        ]
                      },
                      "details": {
                        "note": [
                          {
                            "error": "blank"
                          }
                        ],
                        "todo_type": [
                          {
                            "error": "blank"
                          }
                        ]
                      }
                    }
                  }
                }
              }
            }
          }
        },
        "operationId": "post_administration_id_estimates_estimate_id_notes"
      }
    },
    "/{administration_id}/estimates/{id}/attachments{format}": {
      "post": {
        "summary": "Add attachment to estimate",
        "description": "Add an attachment to an estimate.\n\n### Required scope(s)\n `estimates`",
        "tags": [
          "Estimates"
        ],
        "security": [
          {
            "bearerAuth": [
              "estimates"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/administration_id"
          },
          {
            "name": "id",
            "in": "path",
            "required": true,
            "schema": {
              "$ref": "#/components/schemas/identifier"
            }
          },
          {
            "$ref": "#/components/parameters/format"
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "multipart/form-data": {
              "schema": {
                "type": "object",
                "properties": {
                  "file": {
                    "type": "string",
                    "format": "binary"
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Status code",
            "content": {
              "application/json": {
                "schema": {
                  "type": "integer"
                },
                "examples": {
                  "UploadsAnAttachment": {
                    "summary": "Uploads an attachment",
                    "value": 200
                  }
                }
              }
            }
          },
          "400": {
            "$ref": "#/components/responses/400_bad_request"
          },
          "404": {
            "$ref": "#/components/responses/404_not_found"
          },
          "422": {
            "$ref": "#/components/responses/422_unprocessable_entity"
          }
        },
        "operationId": "post_administration_id_estimates_id_attachments"
      }
    },
    "/{administration_id}/estimates/{id}/bill_estimate{format}": {
      "patch": {
        "summary": "Bills an estimate",
        "description": "An invoice is created based on the accepted estimate.\n\n### Required scope(s)\n `estimates` and `sales_invoices`",
        "tags": [
          "Estimates"
        ],
        "security": [
          {
            "bearerAuth": [
              "estimates",
              "sales_invoices"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/administration_id"
          },
          {
            "name": "id",
            "in": "path",
            "required": true,
            "schema": {
              "$ref": "#/components/schemas/identifier"
            }
          },
          {
            "$ref": "#/components/parameters/format"
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/*": {
              "schema": {
                "unevaluatedProperties": false,
                "type": "object"
              },
              "examples": {
                "BillsAnOpenEstimate": {
                  "summary": "Bills an open estimate",
                  "value": {}
                },
                "BillsAnAcceptedEstimate": {
                  "summary": "Bills an accepted estimate",
                  "value": {}
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Estimate billed",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/sales_invoice_response"
                },
                "examples": {
                  "BillsAnOpenEstimate": {
                    "summary": "Bills an open estimate",
                    "value": {
                      "id": "502689232527033955",
                      "administration_id": 123,
                      "contact_id": "502689232315221587",
                      "contact": {
                        "id": "502689232315221587",
                        "administration_id": 123,
                        "company_name": "Foobar Holding B.V.",
                        "firstname": null,
                        "lastname": null,
                        "address1": "Hoofdstraat 12",
                        "address2": null,
                        "zipcode": "1234AB",
                        "city": "Amsterdam",
                        "country": "NL",
                        "phone": null,
                        "delivery_method": "Email",
                        "customer_id": "customer-1",
                        "tax_number": null,
                        "chamber_of_commerce": null,
                        "bank_account": null,
                        "is_trusted": false,
                        "max_transfer_amount": null,
                        "attention": null,
                        "email": "info@example.com",
                        "email_ubl": true,
                        "send_invoices_to_attention": null,
                        "send_invoices_to_email": "info@example.com",
                        "send_estimates_to_attention": null,
                        "send_estimates_to_email": "info@example.com",
                        "direct_debit": false,
                        "sepa_active": false,
                        "sepa_iban": null,
                        "sepa_iban_account_name": null,
                        "sepa_bic": null,
                        "sepa_mandate_id": null,
                        "sepa_mandate_date": null,
                        "sepa_sequence_type": "RCUR",
                        "credit_card_number": null,
                        "credit_card_reference": null,
                        "credit_card_type": null,
                        "tax_number_validated_at": null,
                        "tax_number_valid": null,
                        "invoice_workflow_id": null,
                        "estimate_workflow_id": null,
                        "si_identifier": null,
                        "si_identifier_type": null,
                        "moneybird_payments_mandate": false,
                        "created_at": "2026-11-02T12:17:11.713Z",
                        "updated_at": "2026-11-02T12:17:11.713Z",
                        "version": 1793621831,
                        "sales_invoices_url": "https://moneybird.dev/123/sales_invoices/0000000000000000000000000000000000000000000000000000000000000001/all",
                        "notes": [],
                        "custom_fields": [],
                        "contact_people": [
                          {
                            "id": "502689232318367317",
                            "contact_id": "502689232315221587",
                            "administration_id": 123,
                            "firstname": "Jan",
                            "lastname": "Janssen",
                            "phone": "123-456-2346",
                            "email": "janjanssen@dev.null.moneybird.net",
                            "department": "Sales",
                            "created_at": "2026-11-02T12:17:11.716Z",
                            "updated_at": "2026-11-02T12:17:11.716Z",
                            "version": 1793621831
                          }
                        ],
                        "archived": false
                      },
                      "contact_person_id": null,
                      "contact_person": null,
                      "invoice_id": null,
                      "recurring_sales_invoice_id": null,
                      "subscription_id": null,
                      "workflow_id": "502689109097055375",
                      "document_style_id": "502689109280556185",
                      "identity_id": "502689108656653419",
                      "draft_id": 1,
                      "state": "draft",
                      "invoice_date": null,
                      "due_date": "2026-11-16",
                      "payment_conditions": "We verzoeken u vriendelijk het bovenstaande bedrag van {document.total_price} voor {document.due_date} te voldoen op onze bankrekening onder vermelding van de omschrijving {document.payment_reference}. Voor vragen kunt u contact opnemen per e-mail.",
                      "payment_reference": null,
                      "short_payment_reference": null,
                      "reference": "Project X",
                      "language": "nl",
                      "currency": "EUR",
                      "discount": "0.0",
                      "original_sales_invoice_id": null,
                      "paused": false,
                      "paid_at": null,
                      "sent_at": null,
                      "created_at": "2026-11-02T12:17:11.915Z",
                      "updated_at": "2026-11-02T12:17:11.920Z",
                      "public_view_code": null,
                      "public_view_code_expires_at": null,
                      "version": 1793621831,
                      "details": [
                        {
                          "id": "502689232530179684",
                          "administration_id": 123,
                          "tax_rate_id": "502689108899923082",
                          "ledger_account_id": "502689108787725434",
                          "project_id": null,
                          "product_id": null,
                          "amount": "1 x",
                          "amount_decimal": "1.0",
                          "description": "Project X",
                          "price": "300.0",
                          "period": null,
                          "row_order": 1,
                          "total_price_excl_tax_with_discount": "300.0",
                          "total_price_excl_tax_with_discount_base": "300.0",
                          "tax_report_reference": [
                            "NL/1a"
                          ],
                          "mandatory_tax_text": null,
                          "created_at": "2026-11-02T12:17:11.918Z",
                          "updated_at": "2026-11-02T12:17:11.918Z"
                        }
                      ],
                      "payments": [],
                      "total_paid": "0.0",
                      "total_unpaid": "363.0",
                      "total_unpaid_base": "363.0",
                      "prices_are_incl_tax": false,
                      "total_price_excl_tax": "300.0",
                      "total_price_excl_tax_base": "300.0",
                      "total_price_incl_tax": "363.0",
                      "total_price_incl_tax_base": "363.0",
                      "total_discount": "0.0",
                      "marked_dubious_on": null,
                      "marked_uncollectible_on": null,
                      "reminder_count": 0,
                      "next_reminder": null,
                      "original_estimate_id": "502689232416933469",
                      "url": "http://moneybird.dev/123/external/0000000000000000000000000000000000000000000000000000000000000001/9140b9b24ba1173b4beba1a23e3f34ac59e638e71b4a239309320361b8ed7c76/sales_invoice",
                      "payment_url": "http://moneybird.dev/123/external/0000000000000000000000000000000000000000000000000000000000000001/9140b9b24ba1173b4beba1a23e3f34ac59e638e71b4a239309320361b8ed7c76/sales_invoice",
                      "custom_fields": [],
                      "notes": [],
                      "attachments": [],
                      "events": [
                        {
                          "administration_id": 123,
                          "user_id": "502689108256097381",
                          "action": "sales_invoice_created_based_on_estimate",
                          "link_entity_id": null,
                          "link_entity_type": null,
                          "data": {
                            "original_estimate": "2026-0002"
                          },
                          "created_at": "2026-11-02T12:17:11.922Z",
                          "updated_at": "2026-11-02T12:17:11.922Z"
                        }
                      ],
                      "tax_totals": [
                        {
                          "tax_rate_id": "502689108899923082",
                          "taxable_amount": "300.0",
                          "taxable_amount_base": "300.0",
                          "tax_amount": "63.0",
                          "tax_amount_base": "63.0"
                        }
                      ],
                      "time_entries": []
                    }
                  },
                  "BillsAnAcceptedEstimate": {
                    "summary": "Bills an accepted estimate",
                    "value": {
                      "id": "502689232890889848",
                      "administration_id": 123,
                      "contact_id": "502689232613017192",
                      "contact": {
                        "id": "502689232613017192",
                        "administration_id": 123,
                        "company_name": "Foobar Holding B.V.",
                        "firstname": null,
                        "lastname": null,
                        "address1": "Hoofdstraat 12",
                        "address2": null,
                        "zipcode": "1234AB",
                        "city": "Amsterdam",
                        "country": "NL",
                        "phone": null,
                        "delivery_method": "Email",
                        "customer_id": "customer-1",
                        "tax_number": null,
                        "chamber_of_commerce": null,
                        "bank_account": null,
                        "is_trusted": false,
                        "max_transfer_amount": null,
                        "attention": null,
                        "email": "info@example.com",
                        "email_ubl": true,
                        "send_invoices_to_attention": null,
                        "send_invoices_to_email": "info@example.com",
                        "send_estimates_to_attention": null,
                        "send_estimates_to_email": "info@example.com",
                        "direct_debit": false,
                        "sepa_active": false,
                        "sepa_iban": null,
                        "sepa_iban_account_name": null,
                        "sepa_bic": null,
                        "sepa_mandate_id": null,
                        "sepa_mandate_date": null,
                        "sepa_sequence_type": "RCUR",
                        "credit_card_number": null,
                        "credit_card_reference": null,
                        "credit_card_type": null,
                        "tax_number_validated_at": null,
                        "tax_number_valid": null,
                        "invoice_workflow_id": null,
                        "estimate_workflow_id": null,
                        "si_identifier": null,
                        "si_identifier_type": null,
                        "moneybird_payments_mandate": false,
                        "created_at": "2026-11-02T12:17:11.997Z",
                        "updated_at": "2026-11-02T12:17:11.997Z",
                        "version": 1793621831,
                        "sales_invoices_url": "https://moneybird.dev/123/sales_invoices/0000000000000000000000000000000000000000000000000000000000000001/all",
                        "notes": [],
                        "custom_fields": [],
                        "contact_people": [
                          {
                            "id": "502689232616162922",
                            "contact_id": "502689232613017192",
                            "administration_id": 123,
                            "firstname": "Jan",
                            "lastname": "Janssen",
                            "phone": "123-456-2346",
                            "email": "janjanssen@dev.null.moneybird.net",
                            "department": "Sales",
                            "created_at": "2026-11-02T12:17:12.001Z",
                            "updated_at": "2026-11-02T12:17:12.001Z",
                            "version": 1793621832
                          }
                        ],
                        "archived": false
                      },
                      "contact_person_id": null,
                      "contact_person": null,
                      "invoice_id": null,
                      "recurring_sales_invoice_id": null,
                      "subscription_id": null,
                      "workflow_id": "502689109097055375",
                      "document_style_id": "502689109280556185",
                      "identity_id": "502689108656653419",
                      "draft_id": 1,
                      "state": "draft",
                      "invoice_date": null,
                      "due_date": "2026-11-16",
                      "payment_conditions": "We verzoeken u vriendelijk het bovenstaande bedrag van {document.total_price} voor {document.due_date} te voldoen op onze bankrekening onder vermelding van de omschrijving {document.payment_reference}. Voor vragen kunt u contact opnemen per e-mail.",
                      "payment_reference": null,
                      "short_payment_reference": null,
                      "reference": "Project X",
                      "language": "nl",
                      "currency": "EUR",
                      "discount": "0.0",
                      "original_sales_invoice_id": null,
                      "paused": false,
                      "paid_at": null,
                      "sent_at": null,
                      "created_at": "2026-11-02T12:17:12.262Z",
                      "updated_at": "2026-11-02T12:17:12.266Z",
                      "public_view_code": null,
                      "public_view_code_expires_at": null,
                      "version": 1793621832,
                      "details": [
                        {
                          "id": "502689232894035577",
                          "administration_id": 123,
                          "tax_rate_id": "502689108899923082",
                          "ledger_account_id": "502689108787725434",
                          "project_id": null,
                          "product_id": null,
                          "amount": "1 x",
                          "amount_decimal": "1.0",
                          "description": "Project X",
                          "price": "300.0",
                          "period": null,
                          "row_order": 1,
                          "total_price_excl_tax_with_discount": "300.0",
                          "total_price_excl_tax_with_discount_base": "300.0",
                          "tax_report_reference": [
                            "NL/1a"
                          ],
                          "mandatory_tax_text": null,
                          "created_at": "2026-11-02T12:17:12.265Z",
                          "updated_at": "2026-11-02T12:17:12.265Z"
                        }
                      ],
                      "payments": [],
                      "total_paid": "0.0",
                      "total_unpaid": "363.0",
                      "total_unpaid_base": "363.0",
                      "prices_are_incl_tax": false,
                      "total_price_excl_tax": "300.0",
                      "total_price_excl_tax_base": "300.0",
                      "total_price_incl_tax": "363.0",
                      "total_price_incl_tax_base": "363.0",
                      "total_discount": "0.0",
                      "marked_dubious_on": null,
                      "marked_uncollectible_on": null,
                      "reminder_count": 0,
                      "next_reminder": null,
                      "original_estimate_id": "502689232713680498",
                      "url": "http://moneybird.dev/123/external/0000000000000000000000000000000000000000000000000000000000000001/c3b3549e10be5e5e0c990921a1808f1ac1343107941447f67e2697ad42294b54/sales_invoice",
                      "payment_url": "http://moneybird.dev/123/external/0000000000000000000000000000000000000000000000000000000000000001/c3b3549e10be5e5e0c990921a1808f1ac1343107941447f67e2697ad42294b54/sales_invoice",
                      "custom_fields": [],
                      "notes": [],
                      "attachments": [],
                      "events": [
                        {
                          "administration_id": 123,
                          "user_id": "502689108256097381",
                          "action": "sales_invoice_created_based_on_estimate",
                          "link_entity_id": null,
                          "link_entity_type": null,
                          "data": {
                            "original_estimate": "2026-0002"
                          },
                          "created_at": "2026-11-02T12:17:12.268Z",
                          "updated_at": "2026-11-02T12:17:12.268Z"
                        }
                      ],
                      "tax_totals": [
                        {
                          "tax_rate_id": "502689108899923082",
                          "taxable_amount": "300.0",
                          "taxable_amount_base": "300.0",
                          "tax_amount": "63.0",
                          "tax_amount_base": "63.0"
                        }
                      ],
                      "time_entries": []
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "Bad request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/symbolic_error"
                },
                "examples": {
                  "CanNotBillAnOpenEstimate": {
                    "summary": "Can not bill an open estimate",
                    "value": {
                      "error": "You cannot invoice this quote. Check the state of the quote and whether the contact still exists.",
                      "symbolic": {
                        "id": "state"
                      }
                    }
                  }
                }
              }
            }
          },
          "402": {
            "description": "Payment required",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/symbolic_error"
                },
                "examples": {
                  "Return402IfLimitIsReached": {
                    "summary": "Return 402 if limit is reached",
                    "value": {
                      "error": "creating sales invoices is limited",
                      "symbolic": {
                        "administration": "limit_reached"
                      }
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Not found",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/symbolic_error"
                },
                "examples": {
                  "Returns404IfTheEstimateDoesNotExist": {
                    "summary": "Returns 404 if the estimate does not exist",
                    "value": {
                      "error": "record not found",
                      "symbolic": {
                        "id": "not_found"
                      }
                    }
                  }
                }
              }
            }
          }
        },
        "operationId": "patch_administration_id_estimates_id_bill_estimate"
      }
    },
    "/{administration_id}/estimates/{id}/change_state{format}": {
      "patch": {
        "summary": "Changes the state of an estimate",
        "description": "Not every state change is allowed. e.g. open to billed is accepted, draft to open is not.\nNote: this only changes the state and does not perform other actions like sending or billing the estimate.\n\n### Required scope(s)\n `estimates`",
        "tags": [
          "Estimates"
        ],
        "security": [
          {
            "bearerAuth": [
              "estimates"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/administration_id"
          },
          {
            "name": "id",
            "in": "path",
            "required": true,
            "schema": {
              "$ref": "#/components/schemas/identifier"
            }
          },
          {
            "$ref": "#/components/parameters/format"
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/*": {
              "schema": {
                "unevaluatedProperties": false,
                "type": "object",
                "properties": {
                  "state": {
                    "type": "string",
                    "description": "Can be accepted, rejected, open, late, billed or archived."
                  }
                },
                "required": [
                  "state"
                ]
              },
              "examples": {
                "ChangesFromOpenToAccepted": {
                  "summary": "Changes from open to accepted",
                  "value": {
                    "state": "accepted"
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Estimate updated",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/estimate_response"
                },
                "examples": {
                  "ChangesFromOpenToAccepted": {
                    "summary": "Changes from open to accepted",
                    "value": {
                      "id": "502689227120575732",
                      "administration_id": 123,
                      "contact_id": "502689227030398186",
                      "contact": {
                        "id": "502689227030398186",
                        "administration_id": 123,
                        "company_name": "Foobar Holding B.V.",
                        "firstname": null,
                        "lastname": null,
                        "address1": "Hoofdstraat 12",
                        "address2": null,
                        "zipcode": "1234AB",
                        "city": "Amsterdam",
                        "country": "NL",
                        "phone": null,
                        "delivery_method": "Email",
                        "customer_id": "customer-1",
                        "tax_number": null,
                        "chamber_of_commerce": null,
                        "bank_account": null,
                        "is_trusted": false,
                        "max_transfer_amount": null,
                        "attention": null,
                        "email": "info@example.com",
                        "email_ubl": true,
                        "send_invoices_to_attention": null,
                        "send_invoices_to_email": "info@example.com",
                        "send_estimates_to_attention": null,
                        "send_estimates_to_email": "info@example.com",
                        "direct_debit": false,
                        "sepa_active": false,
                        "sepa_iban": null,
                        "sepa_iban_account_name": null,
                        "sepa_bic": null,
                        "sepa_mandate_id": null,
                        "sepa_mandate_date": null,
                        "sepa_sequence_type": "RCUR",
                        "credit_card_number": null,
                        "credit_card_reference": null,
                        "credit_card_type": null,
                        "tax_number_validated_at": null,
                        "tax_number_valid": null,
                        "invoice_workflow_id": null,
                        "estimate_workflow_id": null,
                        "si_identifier": null,
                        "si_identifier_type": null,
                        "moneybird_payments_mandate": false,
                        "created_at": "2026-11-02T12:17:06.673Z",
                        "updated_at": "2026-11-02T12:17:06.673Z",
                        "version": 1793621826,
                        "sales_invoices_url": "https://moneybird.dev/123/sales_invoices/0000000000000000000000000000000000000000000000000000000000000001/all",
                        "notes": [],
                        "custom_fields": [],
                        "contact_people": [],
                        "archived": false
                      },
                      "contact_person_id": null,
                      "contact_person": null,
                      "estimate_id": "2026-0002",
                      "estimate_sequence_id": "0002",
                      "workflow_id": "502689109222884501",
                      "document_style_id": "502689109280556185",
                      "identity_id": "502689108656653419",
                      "draft_id": null,
                      "state": "accepted",
                      "estimate_date": "2026-11-02",
                      "due_date": "2026-11-16",
                      "reference": "Project X",
                      "language": "nl",
                      "currency": "EUR",
                      "exchange_rate": "1.0",
                      "discount": "0.0",
                      "original_estimate_id": null,
                      "show_tax": true,
                      "sign_online": true,
                      "sent_at": "2026-11-02",
                      "accepted_at": "2026-11-02",
                      "rejected_at": null,
                      "archived_at": null,
                      "created_at": "2026-11-02T12:17:06.759Z",
                      "updated_at": "2026-11-02T12:17:06.816Z",
                      "public_view_code": "111329",
                      "public_view_code_expires_at": "2027-02-02T12:17:06.778Z",
                      "version": 1793621826,
                      "pre_text": "Hello, here is your quote",
                      "post_text": "Please sign it",
                      "details": [
                        {
                          "id": "502689227121624309",
                          "administration_id": 123,
                          "tax_rate_id": "502689108899923082",
                          "ledger_account_id": "502689108787725434",
                          "project_id": null,
                          "product_id": null,
                          "amount": "1 x",
                          "amount_decimal": "1.0",
                          "description": "Project X",
                          "price": "300.0",
                          "period": null,
                          "row_order": 1,
                          "total_price_excl_tax_with_discount": "300.0",
                          "total_price_excl_tax_with_discount_base": "300.0",
                          "tax_report_reference": [
                            "NL/1a"
                          ],
                          "mandatory_tax_text": null,
                          "created_at": "2026-11-02T12:17:06.761Z",
                          "updated_at": "2026-11-02T12:17:06.793Z",
                          "is_optional": false,
                          "is_selected": true
                        }
                      ],
                      "prices_are_incl_tax": false,
                      "total_price_excl_tax": "300.0",
                      "total_price_excl_tax_base": "300.0",
                      "total_price_incl_tax": "363.0",
                      "total_price_incl_tax_base": "363.0",
                      "total_discount": "0.0",
                      "url": "http://moneybird.dev/123/external/0000000000000000000000000000000000000000000000000000000000000001/1addb944d05ec8a61d2611fc41c3fe9d6d6b3256a406403a36c74b4648b35570/estimate",
                      "custom_fields": [],
                      "notes": [],
                      "attachments": [],
                      "events": [
                        {
                          "administration_id": 123,
                          "user_id": "502689108256097381",
                          "action": "estimate_created",
                          "link_entity_id": null,
                          "link_entity_type": null,
                          "data": {},
                          "created_at": "2026-11-02T12:17:06.764Z",
                          "updated_at": "2026-11-02T12:17:06.764Z"
                        },
                        {
                          "administration_id": 123,
                          "user_id": "502689108256097381",
                          "action": "estimate_send_email",
                          "link_entity_id": null,
                          "link_entity_type": null,
                          "data": {
                            "email_address": "info@example.com",
                            "email_message": "Geachte Foobar Holding B.V.,\n\nHierbij ontvangt u van ons een prijsopgave 2026-0002 voor onze\ndiensten.\n\nMet vriendelijke groet,\n\nParkietje B.V."
                          },
                          "created_at": "2026-11-02T12:17:06.799Z",
                          "updated_at": "2026-11-02T12:17:06.799Z"
                        },
                        {
                          "administration_id": 123,
                          "user_id": "502689108256097381",
                          "action": "estimate_mark_accepted",
                          "link_entity_id": null,
                          "link_entity_type": null,
                          "data": {},
                          "created_at": "2026-11-02T12:17:06.818Z",
                          "updated_at": "2026-11-02T12:17:06.818Z"
                        }
                      ],
                      "tax_totals": [
                        {
                          "tax_rate_id": "502689108899923082",
                          "taxable_amount": "300.0",
                          "taxable_amount_base": "300.0",
                          "tax_amount": "63.0",
                          "tax_amount_base": "63.0"
                        }
                      ]
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "Bad request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/symbolic_error"
                },
                "examples": {
                  "Returns400IfTheStateChangeIsInvalid": {
                    "summary": "Returns 400 if the state change is invalid",
                    "value": {
                      "error": "State isn't an option",
                      "symbolic": {
                        "state": "in"
                      }
                    }
                  },
                  "ReturnsAnErrorIfEstimateCannotBeMarkedFromDraftToOpen": {
                    "summary": "Returns an error if estimate cannot be marked from draft to open",
                    "value": {
                      "error": "State is invalid",
                      "symbolic": {
                        "state": "can_not_change_draft_to_open"
                      }
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Not found",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/symbolic_error"
                },
                "examples": {
                  "Returns404IfTheEstimateDoesNotExist": {
                    "summary": "Returns 404 if the estimate does not exist",
                    "value": {
                      "error": "record not found",
                      "symbolic": {
                        "id": "not_found"
                      }
                    }
                  }
                }
              }
            }
          }
        },
        "operationId": "patch_administration_id_estimates_id_change_state"
      }
    },
    "/{administration_id}/estimates/{id}/download_pdf{format}": {
      "get": {
        "summary": "Download estimate PDF by id",
        "description": "Redirects to the download URL of the estimate as PDF. The link is valid for 30 seconds.\n\n### Required scope(s)\n `estimates`",
        "tags": [
          "Estimates"
        ],
        "security": [
          {
            "bearerAuth": [
              "estimates"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/administration_id"
          },
          {
            "name": "id",
            "in": "path",
            "required": true,
            "schema": {
              "$ref": "#/components/schemas/identifier"
            }
          },
          {
            "$ref": "#/components/parameters/format"
          },
          {
            "name": "media",
            "in": "query",
            "required": false,
            "schema": {
              "type": "string",
              "description": "In case you want to hide sender address and logo you can set this to 'stationery'."
            }
          }
        ],
        "responses": {
          "302": {
            "description": "Found",
            "content": {
              "text/plain": {
                "schema": {
                  "type": "string"
                },
                "examples": {
                  "ReturnsEstimateByGivenIdAsPdf": {
                    "summary": "Returns estimate by given id as pdf",
                    "value": "\"This resource has been moved temporarily to http://moneybird-storage-develop-moneybird-storage-sandbox-de-175c5207.ci.svc.cluster.local:80/ce53e01f1524fbbea61520e5768c6e71b02147baa072f6da85a7403e99238b03/2bffa4a39f4a8a3c77396d770661eb00e5fd04b903b6be9d1919abf76f1abf26/download.\""
                  }
                }
              }
            }
          },
          "404": {
            "description": "Not found",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/symbolic_error"
                },
                "examples": {
                  "Returns404WhenEstimateDoesNotExist": {
                    "summary": "Returns 404 when estimate does not exist",
                    "value": {
                      "error": "record not found",
                      "symbolic": {
                        "id": "not_found"
                      }
                    }
                  }
                }
              }
            }
          }
        },
        "operationId": "get_administration_id_estimates_id_download_pdf"
      }
    },
    "/{administration_id}/estimates/{id}/download_signed_pdf{format}": {
      "get": {
        "summary": "Download signed estimate PDF by id",
        "description": "Redirects to the download URL of the estimate PDF that the contact signed online. This PDF has an extra page with the signature and the audit trail. The PDF is available shortly after the contact signed the estimate.\n\n### Required scope(s)\n `estimates`",
        "tags": [
          "Estimates"
        ],
        "security": [
          {
            "bearerAuth": [
              "estimates"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/administration_id"
          },
          {
            "name": "id",
            "in": "path",
            "required": true,
            "schema": {
              "$ref": "#/components/schemas/identifier"
            }
          },
          {
            "$ref": "#/components/parameters/format"
          }
        ],
        "responses": {
          "302": {
            "description": "Found",
            "content": {
              "text/plain": {
                "schema": {
                  "type": "string"
                },
                "examples": {
                  "ReturnsTheEstimateSignedByTheContactAsPdf": {
                    "summary": "Returns the estimate signed by the contact as pdf",
                    "value": "\"This resource has been moved temporarily to http://moneybird-storage-develop-moneybird-storage-sandbox-de-175c5207.ci.svc.cluster.local:80/4fa0e1917557650aabec7d6b4ae628cec0716b3bce25e80b9dd728137c62f7ea/cf81c266a3da29efa691db4d0401eb2fc2ed660cee5e9adef0b34f59f9cce0f0/download.\""
                  }
                }
              }
            }
          },
          "404": {
            "$ref": "#/components/responses/404_not_found"
          },
          "422": {
            "$ref": "#/components/responses/422_unprocessable_entity"
          }
        },
        "operationId": "get_administration_id_estimates_id_download_signed_pdf"
      }
    },
    "/{administration_id}/estimates/{id}/send_estimate{format}": {
      "patch": {
        "summary": "Sends an estimate",
        "description": "You can provide a send method, email address and message. If you don't provide any arguments, the defaults\nfrom the contact and workflow will be used. If you have sent the estimate before, then the settings from\nthe previous sending are used instead of the defaults.\n\n### Required scope(s)\n `estimates`",
        "tags": [
          "Estimates"
        ],
        "security": [
          {
            "bearerAuth": [
              "estimates"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/administration_id"
          },
          {
            "name": "id",
            "in": "path",
            "required": true,
            "schema": {
              "$ref": "#/components/schemas/identifier"
            }
          },
          {
            "$ref": "#/components/parameters/format"
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/*": {
              "schema": {
                "unevaluatedProperties": false,
                "type": "object",
                "properties": {
                  "estimate_sending": {
                    "type": "object",
                    "unevaluatedProperties": false,
                    "properties": {
                      "delivery_method": {
                        "type": "string",
                        "enum": [
                          "Email",
                          "Manual"
                        ]
                      },
                      "email_address": {
                        "type": "string",
                        "description": "Recipient email address. Only used when `delivery_method` is `Email`; defaults to the contact's email address."
                      },
                      "email_message": {
                        "type": "string",
                        "description": "Message included in the email. Only used when `delivery_method` is `Email`; defaults to the workflow's estimate email text."
                      },
                      "sign_online": {
                        "type": [
                          "boolean",
                          "string"
                        ]
                      }
                    },
                    "required": []
                  },
                  "sender": {
                    "type": [
                      "boolean",
                      "string"
                    ]
                  },
                  "signature_output": {
                    "type": "string"
                  },
                  "audit_trail": {
                    "type": "string"
                  },
                  "ip_address": {
                    "type": "string"
                  }
                },
                "required": []
              },
              "examples": {
                "SendsViaEmailIfContactHasDeliveryMethodSimplerinvoicing": {
                  "summary": "Sends via email if contact has delivery method simplerinvoicing",
                  "value": {}
                },
                "SendsAnEstimateWithAlternativeInformation": {
                  "summary": "Sends an estimate with alternative information",
                  "value": {
                    "estimate_sending": {
                      "delivery_method": "Email",
                      "email_address": "alternative@example.com",
                      "email_message": "Hi, this is an estimate with id {invoice_id}!"
                    }
                  }
                },
                "SendsAnEstimateByGivenId": {
                  "summary": "Sends an estimate by given id",
                  "value": {}
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Estimate updated",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/estimate_response"
                },
                "examples": {
                  "SendsViaEmailIfContactHasDeliveryMethodSimplerinvoicing": {
                    "summary": "Sends via email if contact has delivery method simplerinvoicing",
                    "value": {
                      "id": "502689227976213807",
                      "administration_id": 123,
                      "contact_id": "502689227955242285",
                      "contact": {
                        "id": "502689227955242285",
                        "administration_id": 123,
                        "company_name": "Foobar Holding B.V.",
                        "firstname": null,
                        "lastname": null,
                        "address1": "Hoofdstraat 12",
                        "address2": null,
                        "zipcode": "1234AB",
                        "city": "Amsterdam",
                        "country": "NL",
                        "phone": null,
                        "delivery_method": "Simplerinvoicing",
                        "customer_id": "customer-1",
                        "tax_number": null,
                        "chamber_of_commerce": null,
                        "bank_account": null,
                        "is_trusted": false,
                        "max_transfer_amount": null,
                        "attention": null,
                        "email": "info@example.com",
                        "email_ubl": true,
                        "send_invoices_to_attention": null,
                        "send_invoices_to_email": "info@example.com",
                        "send_estimates_to_attention": null,
                        "send_estimates_to_email": "info@example.com",
                        "direct_debit": false,
                        "sepa_active": false,
                        "sepa_iban": null,
                        "sepa_iban_account_name": null,
                        "sepa_bic": null,
                        "sepa_mandate_id": null,
                        "sepa_mandate_date": null,
                        "sepa_sequence_type": "RCUR",
                        "credit_card_number": null,
                        "credit_card_reference": null,
                        "credit_card_type": null,
                        "tax_number_validated_at": null,
                        "tax_number_valid": null,
                        "invoice_workflow_id": null,
                        "estimate_workflow_id": null,
                        "si_identifier": "12345678",
                        "si_identifier_type": "NL:KVK",
                        "moneybird_payments_mandate": false,
                        "created_at": "2026-11-02T12:17:07.555Z",
                        "updated_at": "2026-11-02T12:17:07.595Z",
                        "version": 1793621827,
                        "sales_invoices_url": "https://moneybird.dev/123/sales_invoices/0000000000000000000000000000000000000000000000000000000000000001/all",
                        "notes": [],
                        "custom_fields": [],
                        "contact_people": [],
                        "archived": false
                      },
                      "contact_person_id": null,
                      "contact_person": null,
                      "estimate_id": "2026-0001",
                      "estimate_sequence_id": "0001",
                      "workflow_id": "502689109222884501",
                      "document_style_id": "502689109280556185",
                      "identity_id": "502689108656653419",
                      "draft_id": null,
                      "state": "open",
                      "estimate_date": "2026-11-02",
                      "due_date": "2026-11-16",
                      "reference": "Project X",
                      "language": "nl",
                      "currency": "EUR",
                      "exchange_rate": "1.0",
                      "discount": "0.0",
                      "original_estimate_id": null,
                      "show_tax": true,
                      "sign_online": true,
                      "sent_at": "2026-11-02",
                      "accepted_at": null,
                      "rejected_at": null,
                      "archived_at": null,
                      "created_at": "2026-11-02T12:17:07.575Z",
                      "updated_at": "2026-11-02T12:17:07.640Z",
                      "public_view_code": "315010",
                      "public_view_code_expires_at": "2027-02-02T12:17:07.620Z",
                      "version": 1793621827,
                      "pre_text": "Hello, here is your quote",
                      "post_text": "Please sign it",
                      "details": [
                        {
                          "id": "502689227977262384",
                          "administration_id": 123,
                          "tax_rate_id": "502689108899923082",
                          "ledger_account_id": "502689108787725434",
                          "project_id": null,
                          "product_id": null,
                          "amount": "1 x",
                          "amount_decimal": "1.0",
                          "description": "Project X",
                          "price": "300.0",
                          "period": null,
                          "row_order": 1,
                          "total_price_excl_tax_with_discount": "300.0",
                          "total_price_excl_tax_with_discount_base": "300.0",
                          "tax_report_reference": [
                            "NL/1a"
                          ],
                          "mandatory_tax_text": null,
                          "created_at": "2026-11-02T12:17:07.576Z",
                          "updated_at": "2026-11-02T12:17:07.639Z",
                          "is_optional": false,
                          "is_selected": true
                        }
                      ],
                      "prices_are_incl_tax": false,
                      "total_price_excl_tax": "300.0",
                      "total_price_excl_tax_base": "300.0",
                      "total_price_incl_tax": "363.0",
                      "total_price_incl_tax_base": "363.0",
                      "total_discount": "0.0",
                      "url": "http://moneybird.dev/123/external/0000000000000000000000000000000000000000000000000000000000000001/1d6798cad256bb81caf4743548b3520166cc06e7b5a6fdc0b116b527e53b9628/estimate",
                      "custom_fields": [],
                      "notes": [],
                      "attachments": [],
                      "events": [
                        {
                          "administration_id": 123,
                          "user_id": "502689108256097381",
                          "action": "estimate_created",
                          "link_entity_id": null,
                          "link_entity_type": null,
                          "data": {},
                          "created_at": "2026-11-02T12:17:07.580Z",
                          "updated_at": "2026-11-02T12:17:07.580Z"
                        },
                        {
                          "administration_id": 123,
                          "user_id": "502689108256097381",
                          "action": "estimate_send_email",
                          "link_entity_id": null,
                          "link_entity_type": null,
                          "data": {
                            "email_address": "info@example.com",
                            "email_message": "Geachte Foobar Holding B.V.,\n\nHierbij ontvangt u van ons een prijsopgave 2026-0001 voor onze\ndiensten.\n\nMet vriendelijke groet,\n\nParkietje B.V."
                          },
                          "created_at": "2026-11-02T12:17:07.647Z",
                          "updated_at": "2026-11-02T12:17:07.647Z"
                        }
                      ],
                      "tax_totals": [
                        {
                          "tax_rate_id": "502689108899923082",
                          "taxable_amount": "300.0",
                          "taxable_amount_base": "300.0",
                          "tax_amount": "63.0",
                          "tax_amount_base": "63.0"
                        }
                      ]
                    }
                  },
                  "SendsAnEstimateWithAlternativeInformation": {
                    "summary": "Sends an estimate with alternative information",
                    "value": {
                      "id": "502689228108334392",
                      "administration_id": 123,
                      "contact_id": "502689228085265718",
                      "contact": {
                        "id": "502689228085265718",
                        "administration_id": 123,
                        "company_name": "Foobar Holding B.V.",
                        "firstname": null,
                        "lastname": null,
                        "address1": "Hoofdstraat 12",
                        "address2": null,
                        "zipcode": "1234AB",
                        "city": "Amsterdam",
                        "country": "NL",
                        "phone": null,
                        "delivery_method": "Email",
                        "customer_id": "customer-1",
                        "tax_number": null,
                        "chamber_of_commerce": null,
                        "bank_account": null,
                        "is_trusted": false,
                        "max_transfer_amount": null,
                        "attention": null,
                        "email": "info@example.com",
                        "email_ubl": true,
                        "send_invoices_to_attention": null,
                        "send_invoices_to_email": "info@example.com",
                        "send_estimates_to_attention": null,
                        "send_estimates_to_email": "info@example.com",
                        "direct_debit": false,
                        "sepa_active": false,
                        "sepa_iban": null,
                        "sepa_iban_account_name": null,
                        "sepa_bic": null,
                        "sepa_mandate_id": null,
                        "sepa_mandate_date": null,
                        "sepa_sequence_type": "RCUR",
                        "credit_card_number": null,
                        "credit_card_reference": null,
                        "credit_card_type": null,
                        "tax_number_validated_at": null,
                        "tax_number_valid": null,
                        "invoice_workflow_id": null,
                        "estimate_workflow_id": null,
                        "si_identifier": null,
                        "si_identifier_type": null,
                        "moneybird_payments_mandate": false,
                        "created_at": "2026-11-02T12:17:07.679Z",
                        "updated_at": "2026-11-02T12:17:07.679Z",
                        "version": 1793621827,
                        "sales_invoices_url": "https://moneybird.dev/123/sales_invoices/0000000000000000000000000000000000000000000000000000000000000001/all",
                        "notes": [],
                        "custom_fields": [],
                        "contact_people": [],
                        "archived": false
                      },
                      "contact_person_id": null,
                      "contact_person": null,
                      "estimate_id": "2026-0001",
                      "estimate_sequence_id": "0001",
                      "workflow_id": "502689109222884501",
                      "document_style_id": "502689109280556185",
                      "identity_id": "502689108656653419",
                      "draft_id": null,
                      "state": "open",
                      "estimate_date": "2026-11-02",
                      "due_date": "2026-11-16",
                      "reference": "Project X",
                      "language": "nl",
                      "currency": "EUR",
                      "exchange_rate": "1.0",
                      "discount": "0.0",
                      "original_estimate_id": null,
                      "show_tax": true,
                      "sign_online": true,
                      "sent_at": "2026-11-02",
                      "accepted_at": null,
                      "rejected_at": null,
                      "archived_at": null,
                      "created_at": "2026-11-02T12:17:07.701Z",
                      "updated_at": "2026-11-02T12:17:07.749Z",
                      "public_view_code": "343345",
                      "public_view_code_expires_at": "2027-02-02T12:17:07.732Z",
                      "version": 1793621827,
                      "pre_text": "Hello, here is your quote",
                      "post_text": "Please sign it",
                      "details": [
                        {
                          "id": "502689228109382969",
                          "administration_id": 123,
                          "tax_rate_id": "502689108899923082",
                          "ledger_account_id": "502689108787725434",
                          "project_id": null,
                          "product_id": null,
                          "amount": "1 x",
                          "amount_decimal": "1.0",
                          "description": "Project X",
                          "price": "300.0",
                          "period": null,
                          "row_order": 1,
                          "total_price_excl_tax_with_discount": "300.0",
                          "total_price_excl_tax_with_discount_base": "300.0",
                          "tax_report_reference": [
                            "NL/1a"
                          ],
                          "mandatory_tax_text": null,
                          "created_at": "2026-11-02T12:17:07.703Z",
                          "updated_at": "2026-11-02T12:17:07.748Z",
                          "is_optional": false,
                          "is_selected": true
                        }
                      ],
                      "prices_are_incl_tax": false,
                      "total_price_excl_tax": "300.0",
                      "total_price_excl_tax_base": "300.0",
                      "total_price_incl_tax": "363.0",
                      "total_price_incl_tax_base": "363.0",
                      "total_discount": "0.0",
                      "url": "http://moneybird.dev/123/external/0000000000000000000000000000000000000000000000000000000000000001/8c82e3979dff870c9622240715cb7c0932498041ceda63d8ffc38c970da98d44/estimate",
                      "custom_fields": [],
                      "notes": [],
                      "attachments": [],
                      "events": [
                        {
                          "administration_id": 123,
                          "user_id": "502689108256097381",
                          "action": "estimate_created",
                          "link_entity_id": null,
                          "link_entity_type": null,
                          "data": {},
                          "created_at": "2026-11-02T12:17:07.706Z",
                          "updated_at": "2026-11-02T12:17:07.706Z"
                        },
                        {
                          "administration_id": 123,
                          "user_id": "502689108256097381",
                          "action": "estimate_send_email",
                          "link_entity_id": null,
                          "link_entity_type": null,
                          "data": {
                            "email_address": "alternative@example.com",
                            "email_message": "Hi, this is an estimate with id {invoice_id}!"
                          },
                          "created_at": "2026-11-02T12:17:07.753Z",
                          "updated_at": "2026-11-02T12:17:07.753Z"
                        }
                      ],
                      "tax_totals": [
                        {
                          "tax_rate_id": "502689108899923082",
                          "taxable_amount": "300.0",
                          "taxable_amount_base": "300.0",
                          "tax_amount": "63.0",
                          "tax_amount_base": "63.0"
                        }
                      ]
                    }
                  },
                  "SendsAnEstimateByGivenId": {
                    "summary": "Sends an estimate by given id",
                    "value": {
                      "id": "502689228234163520",
                      "administration_id": 123,
                      "contact_id": "502689228210046270",
                      "contact": {
                        "id": "502689228210046270",
                        "administration_id": 123,
                        "company_name": "Foobar Holding B.V.",
                        "firstname": null,
                        "lastname": null,
                        "address1": "Hoofdstraat 12",
                        "address2": null,
                        "zipcode": "1234AB",
                        "city": "Amsterdam",
                        "country": "NL",
                        "phone": null,
                        "delivery_method": "Email",
                        "customer_id": "customer-1",
                        "tax_number": null,
                        "chamber_of_commerce": null,
                        "bank_account": null,
                        "is_trusted": false,
                        "max_transfer_amount": null,
                        "attention": null,
                        "email": "info@example.com",
                        "email_ubl": true,
                        "send_invoices_to_attention": null,
                        "send_invoices_to_email": "info@example.com",
                        "send_estimates_to_attention": null,
                        "send_estimates_to_email": "info@example.com",
                        "direct_debit": false,
                        "sepa_active": false,
                        "sepa_iban": null,
                        "sepa_iban_account_name": null,
                        "sepa_bic": null,
                        "sepa_mandate_id": null,
                        "sepa_mandate_date": null,
                        "sepa_sequence_type": "RCUR",
                        "credit_card_number": null,
                        "credit_card_reference": null,
                        "credit_card_type": null,
                        "tax_number_validated_at": null,
                        "tax_number_valid": null,
                        "invoice_workflow_id": null,
                        "estimate_workflow_id": null,
                        "si_identifier": null,
                        "si_identifier_type": null,
                        "moneybird_payments_mandate": false,
                        "created_at": "2026-11-02T12:17:07.798Z",
                        "updated_at": "2026-11-02T12:17:07.798Z",
                        "version": 1793621827,
                        "sales_invoices_url": "https://moneybird.dev/123/sales_invoices/0000000000000000000000000000000000000000000000000000000000000001/all",
                        "notes": [],
                        "custom_fields": [],
                        "contact_people": [],
                        "archived": false
                      },
                      "contact_person_id": null,
                      "contact_person": null,
                      "estimate_id": "2026-0001",
                      "estimate_sequence_id": "0001",
                      "workflow_id": "502689109222884501",
                      "document_style_id": "502689109280556185",
                      "identity_id": "502689108656653419",
                      "draft_id": null,
                      "state": "open",
                      "estimate_date": "2026-11-02",
                      "due_date": "2026-11-16",
                      "reference": "Project X",
                      "language": "nl",
                      "currency": "EUR",
                      "exchange_rate": "1.0",
                      "discount": "0.0",
                      "original_estimate_id": null,
                      "show_tax": true,
                      "sign_online": true,
                      "sent_at": "2026-11-02",
                      "accepted_at": null,
                      "rejected_at": null,
                      "archived_at": null,
                      "created_at": "2026-11-02T12:17:07.821Z",
                      "updated_at": "2026-11-02T12:17:07.869Z",
                      "public_view_code": "935024",
                      "public_view_code_expires_at": "2027-02-02T12:17:07.848Z",
                      "version": 1793621827,
                      "pre_text": "Hello, here is your quote",
                      "post_text": "Please sign it",
                      "details": [
                        {
                          "id": "502689228235212097",
                          "administration_id": 123,
                          "tax_rate_id": "502689108899923082",
                          "ledger_account_id": "502689108787725434",
                          "project_id": null,
                          "product_id": null,
                          "amount": "1 x",
                          "amount_decimal": "1.0",
                          "description": "Project X",
                          "price": "300.0",
                          "period": null,
                          "row_order": 1,
                          "total_price_excl_tax_with_discount": "300.0",
                          "total_price_excl_tax_with_discount_base": "300.0",
                          "tax_report_reference": [
                            "NL/1a"
                          ],
                          "mandatory_tax_text": null,
                          "created_at": "2026-11-02T12:17:07.823Z",
                          "updated_at": "2026-11-02T12:17:07.868Z",
                          "is_optional": false,
                          "is_selected": true
                        }
                      ],
                      "prices_are_incl_tax": false,
                      "total_price_excl_tax": "300.0",
                      "total_price_excl_tax_base": "300.0",
                      "total_price_incl_tax": "363.0",
                      "total_price_incl_tax_base": "363.0",
                      "total_discount": "0.0",
                      "url": "http://moneybird.dev/123/external/0000000000000000000000000000000000000000000000000000000000000001/f8b6632eb15024b997d5adff82efeedce075abce7df1270e1cbc64a6eb81b490/estimate",
                      "custom_fields": [],
                      "notes": [],
                      "attachments": [],
                      "events": [
                        {
                          "administration_id": 123,
                          "user_id": "502689108256097381",
                          "action": "estimate_created",
                          "link_entity_id": null,
                          "link_entity_type": null,
                          "data": {},
                          "created_at": "2026-11-02T12:17:07.827Z",
                          "updated_at": "2026-11-02T12:17:07.827Z"
                        },
                        {
                          "administration_id": 123,
                          "user_id": "502689108256097381",
                          "action": "estimate_send_email",
                          "link_entity_id": null,
                          "link_entity_type": null,
                          "data": {
                            "email_address": "info@example.com",
                            "email_message": "Geachte Foobar Holding B.V.,\n\nHierbij ontvangt u van ons een prijsopgave 2026-0001 voor onze\ndiensten.\n\nMet vriendelijke groet,\n\nParkietje B.V."
                          },
                          "created_at": "2026-11-02T12:17:07.876Z",
                          "updated_at": "2026-11-02T12:17:07.876Z"
                        }
                      ],
                      "tax_totals": [
                        {
                          "tax_rate_id": "502689108899923082",
                          "taxable_amount": "300.0",
                          "taxable_amount_base": "300.0",
                          "tax_amount": "63.0",
                          "tax_amount_base": "63.0"
                        }
                      ]
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "Bad request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/symbolic_error"
                },
                "examples": {
                  "ReturnsErrorWhenSendingInvalidEstimateWithoutDetails": {
                    "summary": "Returns error when sending invalid estimate without details",
                    "value": {
                      "error": "details cannot be empty",
                      "symbolic": {
                        "estimate": "details_cannot_be_empty"
                      }
                    }
                  },
                  "ReturnsAnErrorIfDeliveryMethodSimplerinvoicingIsGiven": {
                    "summary": "Returns an error if delivery method simplerinvoicing is given",
                    "value": {
                      "error": "Delivery Method isn't an option",
                      "symbolic": {
                        "estimate_sending": {
                          "delivery_method": "in"
                        }
                      }
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Not found",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/symbolic_error"
                },
                "examples": {
                  "Returns404IfTheEstimateDoesNotExist": {
                    "summary": "Returns 404 if the estimate does not exist",
                    "value": {
                      "error": "record not found",
                      "symbolic": {
                        "id": "not_found"
                      }
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "Unprocessable entity",
            "content": {
              "application/json": {
                "schema": {
                  "anyOf": [
                    {
                      "$ref": "#/components/schemas/symbolic_error"
                    },
                    {
                      "$ref": "#/components/schemas/non_symbolic_error"
                    }
                  ]
                },
                "examples": {
                  "ReturnsErrorWhenSendingEstimateToContactWithoutEmailAddress": {
                    "summary": "Returns error when sending estimate to contact without email address",
                    "value": {
                      "error": {
                        "email_address": [
                          "can't be blank"
                        ]
                      },
                      "details": {
                        "email_address": [
                          {
                            "error": "blank"
                          }
                        ]
                      }
                    }
                  },
                  "ReturnsErrorWhenSendingEstimateFromIdentityWithoutEmail": {
                    "summary": "Returns error when sending estimate from identity without email",
                    "value": {
                      "error": {
                        "delivery_method": [
                          "The sender address must contain an email address"
                        ]
                      },
                      "details": {
                        "delivery_method": [
                          {
                            "error": "need_identity_email"
                          }
                        ]
                      }
                    }
                  }
                }
              }
            }
          }
        },
        "operationId": "patch_administration_id_estimates_id_send_estimate"
      }
    },
    "/{administration_id}/estimates/{id}{format}": {
      "get": {
        "summary": "Get an estimate by id",
        "description": "Returns all information about an estimate.\n\n### Required scope(s)\n `estimates`",
        "tags": [
          "Estimates"
        ],
        "security": [
          {
            "bearerAuth": [
              "estimates"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/administration_id"
          },
          {
            "name": "id",
            "in": "path",
            "required": true,
            "schema": {
              "$ref": "#/components/schemas/identifier"
            }
          },
          {
            "$ref": "#/components/parameters/format"
          },
          {
            "name": "includes",
            "in": "query",
            "required": false,
            "schema": {
              "type": "array",
              "items": {
                "type": "string"
              }
            }
          }
        ],
        "responses": {
          "200": {
            "description": "A estimate",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/estimate_response"
                },
                "examples": {
                  "ReturnsEstimateByGivenId": {
                    "summary": "Returns estimate by given id",
                    "value": {
                      "id": "502689225873818759",
                      "administration_id": 123,
                      "contact_id": "502689225833972866",
                      "contact": {
                        "id": "502689225833972866",
                        "administration_id": 123,
                        "company_name": "Foobar Holding B.V.",
                        "firstname": null,
                        "lastname": null,
                        "address1": "Hoofdstraat 12",
                        "address2": null,
                        "zipcode": "1234AB",
                        "city": "Amsterdam",
                        "country": "NL",
                        "phone": null,
                        "delivery_method": "Email",
                        "customer_id": "customer-1",
                        "tax_number": null,
                        "chamber_of_commerce": null,
                        "bank_account": null,
                        "is_trusted": false,
                        "max_transfer_amount": null,
                        "attention": null,
                        "email": "info@example.com",
                        "email_ubl": true,
                        "send_invoices_to_attention": null,
                        "send_invoices_to_email": "info@example.com",
                        "send_estimates_to_attention": null,
                        "send_estimates_to_email": "info@example.com",
                        "direct_debit": false,
                        "sepa_active": false,
                        "sepa_iban": null,
                        "sepa_iban_account_name": null,
                        "sepa_bic": null,
                        "sepa_mandate_id": null,
                        "sepa_mandate_date": null,
                        "sepa_sequence_type": "RCUR",
                        "credit_card_number": null,
                        "credit_card_reference": null,
                        "credit_card_type": null,
                        "tax_number_validated_at": null,
                        "tax_number_valid": null,
                        "invoice_workflow_id": null,
                        "estimate_workflow_id": null,
                        "si_identifier": null,
                        "si_identifier_type": null,
                        "moneybird_payments_mandate": false,
                        "created_at": "2026-11-02T12:17:05.531Z",
                        "updated_at": "2026-11-02T12:17:05.531Z",
                        "version": 1793621825,
                        "sales_invoices_url": "https://moneybird.dev/123/sales_invoices/0000000000000000000000000000000000000000000000000000000000000001/all",
                        "notes": [],
                        "custom_fields": [],
                        "contact_people": [],
                        "archived": false
                      },
                      "contact_person_id": "502689225839215748",
                      "contact_person": {
                        "id": null,
                        "contact_id": "502689225833972866",
                        "administration_id": 123,
                        "firstname": "Jan",
                        "lastname": "Janssen",
                        "phone": "123-456-2346",
                        "email": "janjanssen@dev.null.moneybird.net",
                        "department": "Sales",
                        "created_at": "2026-11-02T12:17:05.537Z",
                        "updated_at": "2026-11-02T12:17:05.537Z",
                        "version": 1793621825
                      },
                      "estimate_id": "2026-0001",
                      "estimate_sequence_id": "0001",
                      "workflow_id": "502689109222884501",
                      "document_style_id": "502689109280556185",
                      "identity_id": "502689108656653419",
                      "draft_id": null,
                      "state": "open",
                      "estimate_date": "2026-11-02",
                      "due_date": "2026-11-16",
                      "reference": "Project X",
                      "language": "nl",
                      "currency": "EUR",
                      "exchange_rate": "1.0",
                      "discount": "0.0",
                      "original_estimate_id": null,
                      "show_tax": true,
                      "sign_online": true,
                      "sent_at": "2026-11-02",
                      "accepted_at": null,
                      "rejected_at": null,
                      "archived_at": null,
                      "created_at": "2026-11-02T12:17:05.570Z",
                      "updated_at": "2026-11-02T12:17:05.621Z",
                      "public_view_code": "229878",
                      "public_view_code_expires_at": "2027-02-02T12:17:05.596Z",
                      "version": 1793621825,
                      "pre_text": "Hello, here is your quote",
                      "post_text": "Please sign it",
                      "details": [
                        {
                          "id": "502689225875915912",
                          "administration_id": 123,
                          "tax_rate_id": "502689108899923082",
                          "ledger_account_id": "502689108787725434",
                          "project_id": null,
                          "product_id": null,
                          "amount": "1 x",
                          "amount_decimal": "1.0",
                          "description": "Project X",
                          "price": "300.0",
                          "period": null,
                          "row_order": 1,
                          "total_price_excl_tax_with_discount": "300.0",
                          "total_price_excl_tax_with_discount_base": "300.0",
                          "tax_report_reference": [
                            "NL/1a"
                          ],
                          "mandatory_tax_text": null,
                          "created_at": "2026-11-02T12:17:05.572Z",
                          "updated_at": "2026-11-02T12:17:05.620Z",
                          "is_optional": false,
                          "is_selected": true
                        }
                      ],
                      "prices_are_incl_tax": false,
                      "total_price_excl_tax": "300.0",
                      "total_price_excl_tax_base": "300.0",
                      "total_price_incl_tax": "363.0",
                      "total_price_incl_tax_base": "363.0",
                      "total_discount": "0.0",
                      "url": "http://moneybird.dev/123/external/0000000000000000000000000000000000000000000000000000000000000001/6357a8fadb72b3b63a2e72b99bcf97ccba91b3518d32386acafe8cc1032675b1/estimate",
                      "custom_fields": [],
                      "notes": [],
                      "attachments": [],
                      "events": [
                        {
                          "administration_id": 123,
                          "user_id": "502689108256097381",
                          "action": "estimate_created",
                          "link_entity_id": null,
                          "link_entity_type": null,
                          "data": {},
                          "created_at": "2026-11-02T12:17:05.577Z",
                          "updated_at": "2026-11-02T12:17:05.577Z"
                        },
                        {
                          "administration_id": 123,
                          "user_id": "502689108256097381",
                          "action": "estimate_send_email",
                          "link_entity_id": null,
                          "link_entity_type": null,
                          "data": {
                            "email_address": "info@example.com; janjanssen@dev.null.moneybird.net",
                            "email_message": "Geachte Jan Janssen,\n\nHierbij ontvangt u van ons een prijsopgave 2026-0001 voor onze\ndiensten.\n\nMet vriendelijke groet,\n\nParkietje B.V."
                          },
                          "created_at": "2026-11-02T12:17:05.627Z",
                          "updated_at": "2026-11-02T12:17:05.627Z"
                        }
                      ],
                      "tax_totals": [
                        {
                          "tax_rate_id": "502689108899923082",
                          "taxable_amount": "300.0",
                          "taxable_amount_base": "300.0",
                          "tax_amount": "63.0",
                          "tax_amount_base": "63.0"
                        }
                      ]
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Not found",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/symbolic_error"
                },
                "examples": {
                  "RespondsWithA404CodeWhenEstimateDoesNotExist": {
                    "summary": "Responds with a 404 code when estimate does not exist",
                    "value": {
                      "error": "record not found",
                      "symbolic": {
                        "id": "not_found"
                      }
                    }
                  }
                }
              }
            }
          }
        },
        "operationId": "get_administration_id_estimates_id"
      },
      "patch": {
        "summary": "Updates an estimate",
        "description": "When updating an estimate, provide only the attributes you want to update. The other\nattributes will not be changed.\n\n### Required scope(s)\n `estimates`",
        "tags": [
          "Estimates"
        ],
        "security": [
          {
            "bearerAuth": [
              "estimates"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/administration_id"
          },
          {
            "name": "id",
            "in": "path",
            "required": true,
            "schema": {
              "$ref": "#/components/schemas/identifier"
            }
          },
          {
            "$ref": "#/components/parameters/format"
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/*": {
              "schema": {
                "unevaluatedProperties": false,
                "type": "object",
                "properties": {
                  "estimate": {
                    "type": "object",
                    "unevaluatedProperties": false,
                    "properties": {
                      "contact_id": {
                        "$ref": "#/components/schemas/identifier",
                        "description": "Should be a valid contact id."
                      },
                      "contact_person_id": {
                        "$ref": "#/components/schemas/identifier",
                        "description": "Should be a valid contact person id."
                      },
                      "update_contact": {
                        "type": [
                          "boolean",
                          "string"
                        ],
                        "description": "When `true`, the contact's address and other details are updated on the estimate from the current contact record."
                      },
                      "document_style_id": {
                        "$ref": "#/components/schemas/identifier",
                        "description": "Default document style is used when value is not provided. Should be a valid document style id."
                      },
                      "workflow_id": {
                        "$ref": "#/components/schemas/identifier",
                        "description": "If value is not provided, the workflow saved in the contact is used. If the contact doesn't have a default workflow, the administration's default workflow is used. Should be a valid workflow id."
                      },
                      "reference": {
                        "type": "string",
                        "description": "Your own reference for this estimate, e.g. a project code or PO number. Visible to the recipient."
                      },
                      "estimate_date": {
                        "type": "string",
                        "description": "The date of the estimate.",
                        "format": "date"
                      },
                      "estimate_sequence_id": {
                        "type": [
                          "string",
                          "integer"
                        ],
                        "description": "The sequence number that is put in the estimate number template, e.g. `0042`."
                      },
                      "remove_estimate_sequence_id": {
                        "type": [
                          "boolean",
                          "string"
                        ],
                        "description": "Set to `true` to remove the sequence number of an estimate that is not sent yet. The next number in the sequence is then used when the estimate is sent."
                      },
                      "language": {
                        "type": "string",
                        "description": "Can be `bg`, `cs`, `da`, `de`, `el`, `en`, `es`, `fr`, `hr`, `hu`, `it`, `no`, `nl`, `nl-be`, `pl`, `pt`, `ro`, `sv`, `tr` or `uk`."
                      },
                      "currency": {
                        "type": "string",
                        "description": "ISO three-character currency code, e.g. EUR or USD."
                      },
                      "prices_are_incl_tax": {
                        "type": [
                          "boolean",
                          "string"
                        ],
                        "description": "Whether the prices on the estimate are inclusive of tax."
                      },
                      "show_tax": {
                        "type": [
                          "boolean",
                          "string"
                        ],
                        "description": "Whether to show tax amounts on the estimate."
                      },
                      "first_due_interval": {
                        "type": "integer",
                        "description": "The number of days after the estimate date before the estimate expires."
                      },
                      "pre_text": {
                        "type": "string",
                        "description": "Introductory text displayed above the details on the estimate document."
                      },
                      "post_text": {
                        "type": "string",
                        "description": "Closing text displayed below the details on the estimate document."
                      },
                      "discount": {
                        "$ref": "#/components/schemas/number",
                        "description": "Discount percentage, e.g. 10,0%. Should be a number 0 <= *n* <= 100."
                      },
                      "original_sales_invoice_id": {
                        "$ref": "#/components/schemas/identifier",
                        "description": "The ID of the sales invoice this estimate was created from."
                      },
                      "details_attributes": {
                        "$ref": "#/components/schemas/details_attributes"
                      },
                      "custom_fields_attributes": {
                        "$ref": "#/components/schemas/custom_fields_attributes"
                      }
                    },
                    "required": []
                  }
                },
                "required": []
              },
              "examples": {
                "UpdatesTheDiscount": {
                  "summary": "Updates the discount",
                  "value": {
                    "estimate": {
                      "reference": "Updated Reference"
                    }
                  }
                },
                "UpdatesEstimateDetails": {
                  "summary": "Updates estimate details",
                  "value": {
                    "estimate": {
                      "details_attributes": {
                        "0": {
                          "description": "Detail description",
                          "price": 99,
                          "amount": 1,
                          "tax_rate_id": 502689108899923100,
                          "ledger_account_id": 502689108787725440
                        },
                        "1": {
                          "id": 502689236234799000,
                          "_destroy": true
                        }
                      }
                    }
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Estimate updated",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/estimate_response"
                },
                "examples": {
                  "UpdatesTheDiscount": {
                    "summary": "Updates the discount",
                    "value": {
                      "id": "502689235994675080",
                      "administration_id": 123,
                      "contact_id": "502689235933857667",
                      "contact": {
                        "id": "502689235933857667",
                        "administration_id": 123,
                        "company_name": "Foobar Holding B.V.",
                        "firstname": null,
                        "lastname": null,
                        "address1": "Hoofdstraat 12",
                        "address2": null,
                        "zipcode": "1234AB",
                        "city": "Amsterdam",
                        "country": "NL",
                        "phone": null,
                        "delivery_method": "Email",
                        "customer_id": "customer-1",
                        "tax_number": null,
                        "chamber_of_commerce": null,
                        "bank_account": null,
                        "is_trusted": false,
                        "max_transfer_amount": null,
                        "attention": null,
                        "email": "info@example.com",
                        "email_ubl": true,
                        "send_invoices_to_attention": null,
                        "send_invoices_to_email": "info@example.com",
                        "send_estimates_to_attention": null,
                        "send_estimates_to_email": "info@example.com",
                        "direct_debit": false,
                        "sepa_active": false,
                        "sepa_iban": null,
                        "sepa_iban_account_name": null,
                        "sepa_bic": null,
                        "sepa_mandate_id": null,
                        "sepa_mandate_date": null,
                        "sepa_sequence_type": "RCUR",
                        "credit_card_number": null,
                        "credit_card_reference": null,
                        "credit_card_type": null,
                        "tax_number_validated_at": null,
                        "tax_number_valid": null,
                        "invoice_workflow_id": null,
                        "estimate_workflow_id": null,
                        "si_identifier": null,
                        "si_identifier_type": null,
                        "moneybird_payments_mandate": false,
                        "created_at": "2026-11-02T12:17:15.152Z",
                        "updated_at": "2026-11-02T12:17:15.152Z",
                        "version": 1793621835,
                        "sales_invoices_url": "https://moneybird.dev/123/sales_invoices/0000000000000000000000000000000000000000000000000000000000000001/all",
                        "notes": [],
                        "custom_fields": [],
                        "contact_people": [],
                        "archived": false
                      },
                      "contact_person_id": "502689235938051973",
                      "contact_person": {
                        "id": null,
                        "contact_id": "502689235933857667",
                        "administration_id": 123,
                        "firstname": "Jan",
                        "lastname": "Janssen",
                        "phone": "123-456-2346",
                        "email": "janjanssen@dev.null.moneybird.net",
                        "department": "Sales",
                        "created_at": "2026-11-02T12:17:15.169Z",
                        "updated_at": "2026-11-02T12:17:15.169Z",
                        "version": 1793621835
                      },
                      "estimate_id": "2026-0001",
                      "estimate_sequence_id": "0001",
                      "workflow_id": "502689109222884501",
                      "document_style_id": "502689109280556185",
                      "identity_id": "502689108656653419",
                      "draft_id": null,
                      "state": "open",
                      "estimate_date": "2026-11-02",
                      "due_date": "2026-11-16",
                      "reference": "Updated Reference",
                      "language": "nl",
                      "currency": "EUR",
                      "exchange_rate": "1.0",
                      "discount": "0.0",
                      "original_estimate_id": null,
                      "show_tax": true,
                      "sign_online": true,
                      "sent_at": "2026-11-02",
                      "accepted_at": null,
                      "rejected_at": null,
                      "archived_at": null,
                      "created_at": "2026-11-02T12:17:15.222Z",
                      "updated_at": "2026-11-02T12:17:15.314Z",
                      "public_view_code": "963453",
                      "public_view_code_expires_at": "2027-02-02T12:17:15.254Z",
                      "version": 1793621835,
                      "pre_text": "Hello, here is your quote",
                      "post_text": "Please sign it",
                      "details": [
                        {
                          "id": "502689235998869385",
                          "administration_id": 123,
                          "tax_rate_id": "502689108899923082",
                          "ledger_account_id": "502689108787725434",
                          "project_id": null,
                          "product_id": null,
                          "amount": "1 x",
                          "amount_decimal": "1.0",
                          "description": "Project X",
                          "price": "300.0",
                          "period": null,
                          "row_order": 1,
                          "total_price_excl_tax_with_discount": "300.0",
                          "total_price_excl_tax_with_discount_base": "300.0",
                          "tax_report_reference": [
                            "NL/1a"
                          ],
                          "mandatory_tax_text": null,
                          "created_at": "2026-11-02T12:17:15.225Z",
                          "updated_at": "2026-11-02T12:17:15.278Z",
                          "is_optional": false,
                          "is_selected": true
                        }
                      ],
                      "prices_are_incl_tax": false,
                      "total_price_excl_tax": "300.0",
                      "total_price_excl_tax_base": "300.0",
                      "total_price_incl_tax": "363.0",
                      "total_price_incl_tax_base": "363.0",
                      "total_discount": "0.0",
                      "url": "http://moneybird.dev/123/external/0000000000000000000000000000000000000000000000000000000000000001/8d100023aef84ee31ea0f07ee8b34527584ff37879c72b4e4789725ba3f246cb/estimate",
                      "custom_fields": [],
                      "notes": [],
                      "attachments": [],
                      "events": [
                        {
                          "administration_id": 123,
                          "user_id": "502689108256097381",
                          "action": "estimate_created",
                          "link_entity_id": null,
                          "link_entity_type": null,
                          "data": {},
                          "created_at": "2026-11-02T12:17:15.231Z",
                          "updated_at": "2026-11-02T12:17:15.231Z"
                        },
                        {
                          "administration_id": 123,
                          "user_id": "502689108256097381",
                          "action": "estimate_send_email",
                          "link_entity_id": null,
                          "link_entity_type": null,
                          "data": {
                            "email_address": "info@example.com; janjanssen@dev.null.moneybird.net",
                            "email_message": "Geachte Jan Janssen,\n\nHierbij ontvangt u van ons een prijsopgave 2026-0001 voor onze\ndiensten.\n\nMet vriendelijke groet,\n\nParkietje B.V."
                          },
                          "created_at": "2026-11-02T12:17:15.285Z",
                          "updated_at": "2026-11-02T12:17:15.285Z"
                        },
                        {
                          "administration_id": 123,
                          "user_id": "502689108256097381",
                          "action": "estimate_updated",
                          "link_entity_id": null,
                          "link_entity_type": null,
                          "data": {
                            "reference": [
                              "Project X",
                              "Updated Reference"
                            ],
                            "updated_at": [
                              "2026-11-02T13:17:15.279+01:00",
                              "2026-11-02T13:17:15.314+01:00"
                            ]
                          },
                          "created_at": "2026-11-02T12:17:15.317Z",
                          "updated_at": "2026-11-02T12:17:15.317Z"
                        }
                      ],
                      "tax_totals": [
                        {
                          "tax_rate_id": "502689108899923082",
                          "taxable_amount": "300.0",
                          "taxable_amount_base": "300.0",
                          "tax_amount": "63.0",
                          "tax_amount_base": "63.0"
                        }
                      ]
                    }
                  },
                  "UpdatesEstimateDetails": {
                    "summary": "Updates estimate details",
                    "value": {
                      "id": "502689236232701844",
                      "administration_id": 123,
                      "contact_id": "502689236183418767",
                      "contact": {
                        "id": "502689236183418767",
                        "administration_id": 123,
                        "company_name": "Foobar Holding B.V.",
                        "firstname": null,
                        "lastname": null,
                        "address1": "Hoofdstraat 12",
                        "address2": null,
                        "zipcode": "1234AB",
                        "city": "Amsterdam",
                        "country": "NL",
                        "phone": null,
                        "delivery_method": "Email",
                        "customer_id": "customer-1",
                        "tax_number": null,
                        "chamber_of_commerce": null,
                        "bank_account": null,
                        "is_trusted": false,
                        "max_transfer_amount": null,
                        "attention": null,
                        "email": "info@example.com",
                        "email_ubl": true,
                        "send_invoices_to_attention": null,
                        "send_invoices_to_email": "info@example.com",
                        "send_estimates_to_attention": null,
                        "send_estimates_to_email": "info@example.com",
                        "direct_debit": false,
                        "sepa_active": false,
                        "sepa_iban": null,
                        "sepa_iban_account_name": null,
                        "sepa_bic": null,
                        "sepa_mandate_id": null,
                        "sepa_mandate_date": null,
                        "sepa_sequence_type": "RCUR",
                        "credit_card_number": null,
                        "credit_card_reference": null,
                        "credit_card_type": null,
                        "tax_number_validated_at": null,
                        "tax_number_valid": null,
                        "invoice_workflow_id": null,
                        "estimate_workflow_id": null,
                        "si_identifier": null,
                        "si_identifier_type": null,
                        "moneybird_payments_mandate": false,
                        "created_at": "2026-11-02T12:17:15.402Z",
                        "updated_at": "2026-11-02T12:17:15.402Z",
                        "version": 1793621835,
                        "sales_invoices_url": "https://moneybird.dev/123/sales_invoices/0000000000000000000000000000000000000000000000000000000000000001/all",
                        "notes": [],
                        "custom_fields": [],
                        "contact_people": [],
                        "archived": false
                      },
                      "contact_person_id": "502689236193904529",
                      "contact_person": {
                        "id": null,
                        "contact_id": "502689236183418767",
                        "administration_id": 123,
                        "firstname": "Jan",
                        "lastname": "Janssen",
                        "phone": "123-456-2346",
                        "email": "janjanssen@dev.null.moneybird.net",
                        "department": "Sales",
                        "created_at": "2026-11-02T12:17:15.412Z",
                        "updated_at": "2026-11-02T12:17:15.412Z",
                        "version": 1793621835
                      },
                      "estimate_id": "2026-0001",
                      "estimate_sequence_id": "0001",
                      "workflow_id": "502689109222884501",
                      "document_style_id": "502689109280556185",
                      "identity_id": "502689108656653419",
                      "draft_id": null,
                      "state": "open",
                      "estimate_date": "2026-11-02",
                      "due_date": "2026-11-16",
                      "reference": "Project X",
                      "language": "nl",
                      "currency": "EUR",
                      "exchange_rate": "1.0",
                      "discount": "0.0",
                      "original_estimate_id": null,
                      "show_tax": true,
                      "sign_online": true,
                      "sent_at": "2026-11-02",
                      "accepted_at": null,
                      "rejected_at": null,
                      "archived_at": null,
                      "created_at": "2026-11-02T12:17:15.448Z",
                      "updated_at": "2026-11-02T12:17:15.544Z",
                      "public_view_code": "867449",
                      "public_view_code_expires_at": "2027-02-02T12:17:15.476Z",
                      "version": 1793621835,
                      "pre_text": "Hello, here is your quote",
                      "post_text": "Please sign it",
                      "details": [
                        {
                          "id": "502689236331267993",
                          "administration_id": 123,
                          "tax_rate_id": "502689108899923082",
                          "ledger_account_id": "502689108787725434",
                          "project_id": null,
                          "product_id": null,
                          "amount": "1",
                          "amount_decimal": "1.0",
                          "description": "Detail description",
                          "price": "99.0",
                          "period": null,
                          "row_order": 0,
                          "total_price_excl_tax_with_discount": "99.0",
                          "total_price_excl_tax_with_discount_base": "99.0",
                          "tax_report_reference": [
                            "NL/1a"
                          ],
                          "mandatory_tax_text": null,
                          "created_at": "2026-11-02T12:17:15.543Z",
                          "updated_at": "2026-11-02T12:17:15.543Z",
                          "is_optional": false,
                          "is_selected": true
                        }
                      ],
                      "prices_are_incl_tax": false,
                      "total_price_excl_tax": "99.0",
                      "total_price_excl_tax_base": "99.0",
                      "total_price_incl_tax": "119.79",
                      "total_price_incl_tax_base": "119.79",
                      "total_discount": "0.0",
                      "url": "http://moneybird.dev/123/external/0000000000000000000000000000000000000000000000000000000000000001/c0f49eb4869a827ceba46fd12c0f98a0e3a1b6f42204bc69ed9dac1f000f9969/estimate",
                      "custom_fields": [],
                      "notes": [],
                      "attachments": [],
                      "events": [
                        {
                          "administration_id": 123,
                          "user_id": "502689108256097381",
                          "action": "estimate_created",
                          "link_entity_id": null,
                          "link_entity_type": null,
                          "data": {},
                          "created_at": "2026-11-02T12:17:15.455Z",
                          "updated_at": "2026-11-02T12:17:15.455Z"
                        },
                        {
                          "administration_id": 123,
                          "user_id": "502689108256097381",
                          "action": "estimate_send_email",
                          "link_entity_id": null,
                          "link_entity_type": null,
                          "data": {
                            "email_address": "info@example.com; janjanssen@dev.null.moneybird.net",
                            "email_message": "Geachte Jan Janssen,\n\nHierbij ontvangt u van ons een prijsopgave 2026-0001 voor onze\ndiensten.\n\nMet vriendelijke groet,\n\nParkietje B.V."
                          },
                          "created_at": "2026-11-02T12:17:15.508Z",
                          "updated_at": "2026-11-02T12:17:15.508Z"
                        },
                        {
                          "administration_id": 123,
                          "user_id": "502689108256097381",
                          "action": "estimate_updated",
                          "link_entity_id": null,
                          "link_entity_type": null,
                          "data": {
                            "total_price_excl_tax": [
                              "300.0",
                              "99.0"
                            ],
                            "total_price_excl_tax_base": [
                              "300.0",
                              "99.0"
                            ],
                            "total_price_incl_tax": [
                              "363.0",
                              "119.79"
                            ],
                            "total_price_incl_tax_base": [
                              "363.0",
                              "119.79"
                            ],
                            "cached_taxes": [
                              [
                                {
                                  "tax_rate_id": "502689108899923082",
                                  "report_reference": "NL/1a",
                                  "payable": true,
                                  "debit": 0,
                                  "credit": "63.0"
                                }
                              ],
                              [
                                {
                                  "tax_rate_id": "502689108899923082",
                                  "report_reference": "NL/1a",
                                  "payable": true,
                                  "debit": 0,
                                  "credit": "20.79"
                                }
                              ]
                            ],
                            "updated_at": [
                              "2026-11-02T13:17:15.502+01:00",
                              "2026-11-02T13:17:15.539+01:00"
                            ]
                          },
                          "created_at": "2026-11-02T12:17:15.545Z",
                          "updated_at": "2026-11-02T12:17:15.545Z"
                        }
                      ],
                      "tax_totals": [
                        {
                          "tax_rate_id": "502689108899923082",
                          "taxable_amount": "99.0",
                          "taxable_amount_base": "99.0",
                          "tax_amount": "20.79",
                          "tax_amount_base": "20.79"
                        }
                      ]
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "Bad request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/symbolic_error"
                },
                "examples": {
                  "Returns400IfTheUpdateIsInvalid": {
                    "summary": "Returns 400 if the update is invalid",
                    "value": {
                      "error": "Estimate can't be nil",
                      "symbolic": {
                        "estimate": "nils"
                      }
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Not found",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/symbolic_error"
                },
                "examples": {
                  "RespondsWithA404CodeWhenEstimateDoesNotExist": {
                    "summary": "Responds with a 404 code when estimate does not exist",
                    "value": {
                      "error": "record not found",
                      "symbolic": {
                        "id": "not_found"
                      }
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "Unprocessable entity",
            "content": {
              "application/json": {
                "schema": {
                  "anyOf": [
                    {
                      "$ref": "#/components/schemas/symbolic_error"
                    },
                    {
                      "$ref": "#/components/schemas/non_symbolic_error"
                    }
                  ]
                },
                "examples": {
                  "Returns422IfTheUpdateIsInvalid": {
                    "summary": "Returns 422 if the update is invalid",
                    "value": {
                      "error": {
                        "language": [
                          "is not included in the list"
                        ]
                      },
                      "details": {
                        "language": [
                          {
                            "error": "inclusion",
                            "value": "abracadabra"
                          }
                        ]
                      }
                    }
                  }
                }
              }
            }
          }
        },
        "operationId": "patch_administration_id_estimates_id"
      },
      "delete": {
        "summary": "Deletes an estimate",
        "description": "Deletes an estimate.\n\n### Required scope(s)\n `estimates`",
        "tags": [
          "Estimates"
        ],
        "security": [
          {
            "bearerAuth": [
              "estimates"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/administration_id"
          },
          {
            "name": "id",
            "in": "path",
            "required": true,
            "schema": {
              "$ref": "#/components/schemas/identifier"
            }
          },
          {
            "$ref": "#/components/parameters/format"
          }
        ],
        "responses": {
          "204": {
            "description": "Estimate deleted"
          },
          "404": {
            "description": "Not found",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/symbolic_error"
                },
                "examples": {
                  "Returns404IfTheEstimateDoesNotExist": {
                    "summary": "Returns 404 if the estimate does not exist",
                    "value": {
                      "error": "record not found",
                      "symbolic": {
                        "id": "not_found"
                      }
                    }
                  }
                }
              }
            }
          }
        },
        "operationId": "delete_administration_id_estimates_id"
      }
    },
    "/{administration_id}/estimates{format}": {
      "get": {
        "summary": "List all estimates",
        "description": "Returns a paginated list of estimates in the administration.\n\n### Required scope(s)\n `estimates`",
        "tags": [
          "Estimates"
        ],
        "security": [
          {
            "bearerAuth": [
              "estimates"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/administration_id"
          },
          {
            "$ref": "#/components/parameters/format"
          },
          {
            "name": "filter",
            "in": "query",
            "required": false,
            "description": "Filters are `key:value` terms separated by commas (e.g. `period:this_year,state:all`). Any filter you pass replaces the defaults below entirely, so include every key you need. Available filters:\n\n| **Filter** | **Type** | **Default** | **Description** |\n| --- | --- | --- | --- |\n| state | `String` | `all` | `all`, `draft`, `open`, `late`, `accepted`, `rejected`, `billed` or `archived` |\n| period | `String` | `this_year` | Matches on the estimate date. This can either be the description of a period (`this_week`, `prev_week`, `next_week`, `this_month`, `prev_month`, `next_month`, `this_quarter`, `prev_quarter`, `next_quarter`, `this_year`, `prev_year`, `next_year`) or a custom period (`201301..201302`, `20130101..20130131`). A custom period must have a start and an end date. It must not be longer than 10 years and must be between `20000101` and `21000101`. For one month, use `202401..202401`, not `202401`. Without `period`, the filter does not limit the dates. The default `this_year` applies only when you send no `filter`. |\n| contact_id | `Integer` | | Filters estimates by a single contact |\n| workflow_id | `Integer` | | Filters estimates by a single workflow |\n\nThe `period` filter matches on the estimate date. It does not look at the `period` of the individual details, which says which months the expenses belong to. Read `details[].period` in the response when you need those months, or use the reports endpoints, which already spread the amounts over that period. A detail's period can fall outside the filtered range, however wide you make it, so this filter cannot tell you which periods amounts fall in. Use the reports endpoints for that.\n\nYou can filter by multiple states at the same time as well. To do this, separate the state values by a pipe: `state:draft|scheduled`.",
            "schema": {
              "type": "string",
              "default": "period:this_year"
            },
            "examples": {
              "ReturnsAllEstimatesFilteredOnPeriod": {
                "summary": "Returns all estimates filtered on period",
                "value": "period:this_month"
              },
              "ReturnsAllEstimatesFilteredOnState": {
                "summary": "Returns all estimates filtered on state",
                "value": "state:open"
              }
            }
          },
          {
            "$ref": "#/components/parameters/page"
          },
          {
            "$ref": "#/components/parameters/per_page"
          }
        ],
        "responses": {
          "200": {
            "description": "A list of estimates",
            "content": {
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "$ref": "#/components/schemas/estimate_response"
                  }
                },
                "examples": {
                  "ReturnsAllEstimatesOfAnAdministration": {
                    "summary": "Returns all estimates of an administration",
                    "value": [
                      {
                        "id": "502689228667225438",
                        "administration_id": 123,
                        "contact_id": "502689228408227148",
                        "contact": {
                          "id": "502689228408227148",
                          "administration_id": 123,
                          "company_name": "Foobar Holding B.V.",
                          "firstname": null,
                          "lastname": null,
                          "address1": "Hoofdstraat 12",
                          "address2": null,
                          "zipcode": "1234AB",
                          "city": "Amsterdam",
                          "country": "NL",
                          "phone": null,
                          "delivery_method": "Email",
                          "customer_id": "customer-1",
                          "tax_number": null,
                          "chamber_of_commerce": null,
                          "bank_account": null,
                          "is_trusted": false,
                          "max_transfer_amount": null,
                          "attention": null,
                          "email": "info@example.com",
                          "email_ubl": true,
                          "send_invoices_to_attention": null,
                          "send_invoices_to_email": "info@example.com",
                          "send_estimates_to_attention": null,
                          "send_estimates_to_email": "info@example.com",
                          "direct_debit": false,
                          "sepa_active": false,
                          "sepa_iban": null,
                          "sepa_iban_account_name": null,
                          "sepa_bic": null,
                          "sepa_mandate_id": null,
                          "sepa_mandate_date": null,
                          "sepa_sequence_type": "RCUR",
                          "credit_card_number": null,
                          "credit_card_reference": null,
                          "credit_card_type": null,
                          "tax_number_validated_at": null,
                          "tax_number_valid": null,
                          "invoice_workflow_id": null,
                          "estimate_workflow_id": null,
                          "si_identifier": null,
                          "si_identifier_type": null,
                          "moneybird_payments_mandate": false,
                          "created_at": "2026-11-02T12:17:07.987Z",
                          "updated_at": "2026-11-02T12:17:07.987Z",
                          "version": 1793621827,
                          "sales_invoices_url": "https://moneybird.dev/123/sales_invoices/0000000000000000000000000000000000000000000000000000000000000001/all",
                          "notes": [],
                          "custom_fields": [],
                          "contact_people": [],
                          "archived": false
                        },
                        "contact_person_id": null,
                        "contact_person": null,
                        "estimate_id": "2026-0004",
                        "estimate_sequence_id": "0004",
                        "workflow_id": "502689109222884501",
                        "document_style_id": "502689109280556185",
                        "identity_id": "502689108656653419",
                        "draft_id": null,
                        "state": "open",
                        "estimate_date": "2026-11-02",
                        "due_date": "2026-11-16",
                        "reference": "Project X",
                        "language": "nl",
                        "currency": "EUR",
                        "exchange_rate": "1.0",
                        "discount": "0.0",
                        "original_estimate_id": null,
                        "show_tax": true,
                        "sign_online": true,
                        "sent_at": "2026-11-02",
                        "accepted_at": null,
                        "rejected_at": null,
                        "archived_at": null,
                        "created_at": "2026-11-02T12:17:08.235Z",
                        "updated_at": "2026-11-02T12:17:08.268Z",
                        "public_view_code": "198224",
                        "public_view_code_expires_at": "2027-02-02T12:17:08.253Z",
                        "version": 1793621828,
                        "pre_text": "Hello, here is your quote",
                        "post_text": "Please sign it",
                        "details": [
                          {
                            "id": "502689228669322591",
                            "administration_id": 123,
                            "tax_rate_id": "502689108899923082",
                            "ledger_account_id": "502689108787725434",
                            "project_id": null,
                            "product_id": null,
                            "amount": "1 x",
                            "amount_decimal": "1.0",
                            "description": "Project X",
                            "price": "300.0",
                            "period": null,
                            "row_order": 1,
                            "total_price_excl_tax_with_discount": "300.0",
                            "total_price_excl_tax_with_discount_base": "300.0",
                            "tax_report_reference": [
                              "NL/1a"
                            ],
                            "mandatory_tax_text": null,
                            "created_at": "2026-11-02T12:17:08.236Z",
                            "updated_at": "2026-11-02T12:17:08.267Z",
                            "is_optional": false,
                            "is_selected": true
                          }
                        ],
                        "prices_are_incl_tax": false,
                        "total_price_excl_tax": "300.0",
                        "total_price_excl_tax_base": "300.0",
                        "total_price_incl_tax": "363.0",
                        "total_price_incl_tax_base": "363.0",
                        "total_discount": "0.0",
                        "url": "http://moneybird.dev/123/external/0000000000000000000000000000000000000000000000000000000000000001/ae41895e64cf74bae40f059c24d7170c4c2b9bd202b51872605946170d3e7c40/estimate",
                        "custom_fields": [],
                        "notes": [],
                        "attachments": [],
                        "events": [
                          {
                            "administration_id": 123,
                            "user_id": "502689108256097381",
                            "action": "estimate_created",
                            "link_entity_id": null,
                            "link_entity_type": null,
                            "data": {},
                            "created_at": "2026-11-02T12:17:08.239Z",
                            "updated_at": "2026-11-02T12:17:08.239Z"
                          },
                          {
                            "administration_id": 123,
                            "user_id": "502689108256097381",
                            "action": "estimate_send_email",
                            "link_entity_id": null,
                            "link_entity_type": null,
                            "data": {
                              "email_address": "info@example.com",
                              "email_message": "Geachte Foobar Holding B.V.,\n\nHierbij ontvangt u van ons een prijsopgave 2026-0004 voor onze\ndiensten.\n\nMet vriendelijke groet,\n\nParkietje B.V."
                            },
                            "created_at": "2026-11-02T12:17:08.273Z",
                            "updated_at": "2026-11-02T12:17:08.273Z"
                          }
                        ],
                        "tax_totals": [
                          {
                            "tax_rate_id": "502689108899923082",
                            "taxable_amount": "300.0",
                            "taxable_amount_base": "300.0",
                            "tax_amount": "63.0",
                            "tax_amount_base": "63.0"
                          }
                        ]
                      },
                      {
                        "id": "502689228598019418",
                        "administration_id": 123,
                        "contact_id": "502689228408227148",
                        "contact": {
                          "id": "502689228408227148",
                          "administration_id": 123,
                          "company_name": "Foobar Holding B.V.",
                          "firstname": null,
                          "lastname": null,
                          "address1": "Hoofdstraat 12",
                          "address2": null,
                          "zipcode": "1234AB",
                          "city": "Amsterdam",
                          "country": "NL",
                          "phone": null,
                          "delivery_method": "Email",
                          "customer_id": "customer-1",
                          "tax_number": null,
                          "chamber_of_commerce": null,
                          "bank_account": null,
                          "is_trusted": false,
                          "max_transfer_amount": null,
                          "attention": null,
                          "email": "info@example.com",
                          "email_ubl": true,
                          "send_invoices_to_attention": null,
                          "send_invoices_to_email": "info@example.com",
                          "send_estimates_to_attention": null,
                          "send_estimates_to_email": "info@example.com",
                          "direct_debit": false,
                          "sepa_active": false,
                          "sepa_iban": null,
                          "sepa_iban_account_name": null,
                          "sepa_bic": null,
                          "sepa_mandate_id": null,
                          "sepa_mandate_date": null,
                          "sepa_sequence_type": "RCUR",
                          "credit_card_number": null,
                          "credit_card_reference": null,
                          "credit_card_type": null,
                          "tax_number_validated_at": null,
                          "tax_number_valid": null,
                          "invoice_workflow_id": null,
                          "estimate_workflow_id": null,
                          "si_identifier": null,
                          "si_identifier_type": null,
                          "moneybird_payments_mandate": false,
                          "created_at": "2026-11-02T12:17:07.987Z",
                          "updated_at": "2026-11-02T12:17:07.987Z",
                          "version": 1793621827,
                          "sales_invoices_url": "https://moneybird.dev/123/sales_invoices/0000000000000000000000000000000000000000000000000000000000000001/all",
                          "notes": [],
                          "custom_fields": [],
                          "contact_people": [],
                          "archived": false
                        },
                        "contact_person_id": null,
                        "contact_person": null,
                        "estimate_id": "2026-0003",
                        "estimate_sequence_id": "0003",
                        "workflow_id": "502689109222884501",
                        "document_style_id": "502689109280556185",
                        "identity_id": "502689108656653419",
                        "draft_id": null,
                        "state": "open",
                        "estimate_date": "2026-11-02",
                        "due_date": "2026-11-16",
                        "reference": "Project X",
                        "language": "nl",
                        "currency": "EUR",
                        "exchange_rate": "1.0",
                        "discount": "0.0",
                        "original_estimate_id": null,
                        "show_tax": true,
                        "sign_online": true,
                        "sent_at": "2026-11-02",
                        "accepted_at": null,
                        "rejected_at": null,
                        "archived_at": null,
                        "created_at": "2026-11-02T12:17:08.168Z",
                        "updated_at": "2026-11-02T12:17:08.206Z",
                        "public_view_code": "445003",
                        "public_view_code_expires_at": "2027-02-02T12:17:08.190Z",
                        "version": 1793621828,
                        "pre_text": "Hello, here is your quote",
                        "post_text": "Please sign it",
                        "details": [
                          {
                            "id": "502689228599067995",
                            "administration_id": 123,
                            "tax_rate_id": "502689108899923082",
                            "ledger_account_id": "502689108787725434",
                            "project_id": null,
                            "product_id": null,
                            "amount": "1 x",
                            "amount_decimal": "1.0",
                            "description": "Project X",
                            "price": "300.0",
                            "period": null,
                            "row_order": 1,
                            "total_price_excl_tax_with_discount": "300.0",
                            "total_price_excl_tax_with_discount_base": "300.0",
                            "tax_report_reference": [
                              "NL/1a"
                            ],
                            "mandatory_tax_text": null,
                            "created_at": "2026-11-02T12:17:08.170Z",
                            "updated_at": "2026-11-02T12:17:08.206Z",
                            "is_optional": false,
                            "is_selected": true
                          }
                        ],
                        "prices_are_incl_tax": false,
                        "total_price_excl_tax": "300.0",
                        "total_price_excl_tax_base": "300.0",
                        "total_price_incl_tax": "363.0",
                        "total_price_incl_tax_base": "363.0",
                        "total_discount": "0.0",
                        "url": "http://moneybird.dev/123/external/0000000000000000000000000000000000000000000000000000000000000001/01678946ef3f4c441a6526f9625c6cf6d11d708f511dabaa82c2abf0ff5ca4b5/estimate",
                        "custom_fields": [],
                        "notes": [],
                        "attachments": [],
                        "events": [
                          {
                            "administration_id": 123,
                            "user_id": "502689108256097381",
                            "action": "estimate_created",
                            "link_entity_id": null,
                            "link_entity_type": null,
                            "data": {},
                            "created_at": "2026-11-02T12:17:08.173Z",
                            "updated_at": "2026-11-02T12:17:08.173Z"
                          },
                          {
                            "administration_id": 123,
                            "user_id": "502689108256097381",
                            "action": "estimate_send_email",
                            "link_entity_id": null,
                            "link_entity_type": null,
                            "data": {
                              "email_address": "info@example.com",
                              "email_message": "Geachte Foobar Holding B.V.,\n\nHierbij ontvangt u van ons een prijsopgave 2026-0003 voor onze\ndiensten.\n\nMet vriendelijke groet,\n\nParkietje B.V."
                            },
                            "created_at": "2026-11-02T12:17:08.212Z",
                            "updated_at": "2026-11-02T12:17:08.212Z"
                          }
                        ],
                        "tax_totals": [
                          {
                            "tax_rate_id": "502689108899923082",
                            "taxable_amount": "300.0",
                            "taxable_amount_base": "300.0",
                            "tax_amount": "63.0",
                            "tax_amount_base": "63.0"
                          }
                        ]
                      },
                      {
                        "id": "502689228519376214",
                        "administration_id": 123,
                        "contact_id": "502689228408227148",
                        "contact": {
                          "id": "502689228408227148",
                          "administration_id": 123,
                          "company_name": "Foobar Holding B.V.",
                          "firstname": null,
                          "lastname": null,
                          "address1": "Hoofdstraat 12",
                          "address2": null,
                          "zipcode": "1234AB",
                          "city": "Amsterdam",
                          "country": "NL",
                          "phone": null,
                          "delivery_method": "Email",
                          "customer_id": "customer-1",
                          "tax_number": null,
                          "chamber_of_commerce": null,
                          "bank_account": null,
                          "is_trusted": false,
                          "max_transfer_amount": null,
                          "attention": null,
                          "email": "info@example.com",
                          "email_ubl": true,
                          "send_invoices_to_attention": null,
                          "send_invoices_to_email": "info@example.com",
                          "send_estimates_to_attention": null,
                          "send_estimates_to_email": "info@example.com",
                          "direct_debit": false,
                          "sepa_active": false,
                          "sepa_iban": null,
                          "sepa_iban_account_name": null,
                          "sepa_bic": null,
                          "sepa_mandate_id": null,
                          "sepa_mandate_date": null,
                          "sepa_sequence_type": "RCUR",
                          "credit_card_number": null,
                          "credit_card_reference": null,
                          "credit_card_type": null,
                          "tax_number_validated_at": null,
                          "tax_number_valid": null,
                          "invoice_workflow_id": null,
                          "estimate_workflow_id": null,
                          "si_identifier": null,
                          "si_identifier_type": null,
                          "moneybird_payments_mandate": false,
                          "created_at": "2026-11-02T12:17:07.987Z",
                          "updated_at": "2026-11-02T12:17:07.987Z",
                          "version": 1793621827,
                          "sales_invoices_url": "https://moneybird.dev/123/sales_invoices/0000000000000000000000000000000000000000000000000000000000000001/all",
                          "notes": [],
                          "custom_fields": [],
                          "contact_people": [],
                          "archived": false
                        },
                        "contact_person_id": null,
                        "contact_person": null,
                        "estimate_id": "2026-0002",
                        "estimate_sequence_id": "0002",
                        "workflow_id": "502689109222884501",
                        "document_style_id": "502689109280556185",
                        "identity_id": "502689108656653419",
                        "draft_id": null,
                        "state": "open",
                        "estimate_date": "2026-11-02",
                        "due_date": "2026-11-16",
                        "reference": "Project X",
                        "language": "nl",
                        "currency": "EUR",
                        "exchange_rate": "1.0",
                        "discount": "0.0",
                        "original_estimate_id": null,
                        "show_tax": true,
                        "sign_online": true,
                        "sent_at": "2026-11-02",
                        "accepted_at": null,
                        "rejected_at": null,
                        "archived_at": null,
                        "created_at": "2026-11-02T12:17:08.093Z",
                        "updated_at": "2026-11-02T12:17:08.135Z",
                        "public_view_code": "828774",
                        "public_view_code_expires_at": "2027-02-02T12:17:08.116Z",
                        "version": 1793621828,
                        "pre_text": "Hello, here is your quote",
                        "post_text": "Please sign it",
                        "details": [
                          {
                            "id": "502689228521473367",
                            "administration_id": 123,
                            "tax_rate_id": "502689108899923082",
                            "ledger_account_id": "502689108787725434",
                            "project_id": null,
                            "product_id": null,
                            "amount": "1 x",
                            "amount_decimal": "1.0",
                            "description": "Project X",
                            "price": "300.0",
                            "period": null,
                            "row_order": 1,
                            "total_price_excl_tax_with_discount": "300.0",
                            "total_price_excl_tax_with_discount_base": "300.0",
                            "tax_report_reference": [
                              "NL/1a"
                            ],
                            "mandatory_tax_text": null,
                            "created_at": "2026-11-02T12:17:08.095Z",
                            "updated_at": "2026-11-02T12:17:08.134Z",
                            "is_optional": false,
                            "is_selected": true
                          }
                        ],
                        "prices_are_incl_tax": false,
                        "total_price_excl_tax": "300.0",
                        "total_price_excl_tax_base": "300.0",
                        "total_price_incl_tax": "363.0",
                        "total_price_incl_tax_base": "363.0",
                        "total_discount": "0.0",
                        "url": "http://moneybird.dev/123/external/0000000000000000000000000000000000000000000000000000000000000001/c54e5a4d973d3735bcb3198d86e0e770a3b5e4a63f0fea426e4fd218ddc9af9c/estimate",
                        "custom_fields": [],
                        "notes": [],
                        "attachments": [],
                        "events": [
                          {
                            "administration_id": 123,
                            "user_id": "502689108256097381",
                            "action": "estimate_created",
                            "link_entity_id": null,
                            "link_entity_type": null,
                            "data": {},
                            "created_at": "2026-11-02T12:17:08.099Z",
                            "updated_at": "2026-11-02T12:17:08.099Z"
                          },
                          {
                            "administration_id": 123,
                            "user_id": "502689108256097381",
                            "action": "estimate_send_email",
                            "link_entity_id": null,
                            "link_entity_type": null,
                            "data": {
                              "email_address": "info@example.com",
                              "email_message": "Geachte Foobar Holding B.V.,\n\nHierbij ontvangt u van ons een prijsopgave 2026-0002 voor onze\ndiensten.\n\nMet vriendelijke groet,\n\nParkietje B.V."
                            },
                            "created_at": "2026-11-02T12:17:08.141Z",
                            "updated_at": "2026-11-02T12:17:08.141Z"
                          }
                        ],
                        "tax_totals": [
                          {
                            "tax_rate_id": "502689108899923082",
                            "taxable_amount": "300.0",
                            "taxable_amount_base": "300.0",
                            "tax_amount": "63.0",
                            "tax_amount_base": "63.0"
                          }
                        ]
                      },
                      {
                        "id": "502689228444927313",
                        "administration_id": 123,
                        "contact_id": "502689228408227148",
                        "contact": {
                          "id": "502689228408227148",
                          "administration_id": 123,
                          "company_name": "Foobar Holding B.V.",
                          "firstname": null,
                          "lastname": null,
                          "address1": "Hoofdstraat 12",
                          "address2": null,
                          "zipcode": "1234AB",
                          "city": "Amsterdam",
                          "country": "NL",
                          "phone": null,
                          "delivery_method": "Email",
                          "customer_id": "customer-1",
                          "tax_number": null,
                          "chamber_of_commerce": null,
                          "bank_account": null,
                          "is_trusted": false,
                          "max_transfer_amount": null,
                          "attention": null,
                          "email": "info@example.com",
                          "email_ubl": true,
                          "send_invoices_to_attention": null,
                          "send_invoices_to_email": "info@example.com",
                          "send_estimates_to_attention": null,
                          "send_estimates_to_email": "info@example.com",
                          "direct_debit": false,
                          "sepa_active": false,
                          "sepa_iban": null,
                          "sepa_iban_account_name": null,
                          "sepa_bic": null,
                          "sepa_mandate_id": null,
                          "sepa_mandate_date": null,
                          "sepa_sequence_type": "RCUR",
                          "credit_card_number": null,
                          "credit_card_reference": null,
                          "credit_card_type": null,
                          "tax_number_validated_at": null,
                          "tax_number_valid": null,
                          "invoice_workflow_id": null,
                          "estimate_workflow_id": null,
                          "si_identifier": null,
                          "si_identifier_type": null,
                          "moneybird_payments_mandate": false,
                          "created_at": "2026-11-02T12:17:07.987Z",
                          "updated_at": "2026-11-02T12:17:07.987Z",
                          "version": 1793621827,
                          "sales_invoices_url": "https://moneybird.dev/123/sales_invoices/0000000000000000000000000000000000000000000000000000000000000001/all",
                          "notes": [],
                          "custom_fields": [],
                          "contact_people": [],
                          "archived": false
                        },
                        "contact_person_id": "502689228415567182",
                        "contact_person": {
                          "id": null,
                          "contact_id": "502689228408227148",
                          "administration_id": 123,
                          "firstname": "Jan",
                          "lastname": "Janssen",
                          "phone": "123-456-2346",
                          "email": "janjanssen@dev.null.moneybird.net",
                          "department": "Sales",
                          "created_at": "2026-11-02T12:17:07.994Z",
                          "updated_at": "2026-11-02T12:17:07.994Z",
                          "version": 1793621827
                        },
                        "estimate_id": "2026-0001",
                        "estimate_sequence_id": "0001",
                        "workflow_id": "502689109222884501",
                        "document_style_id": "502689109280556185",
                        "identity_id": "502689108656653419",
                        "draft_id": null,
                        "state": "open",
                        "estimate_date": "2026-11-02",
                        "due_date": "2026-11-16",
                        "reference": "Project X",
                        "language": "nl",
                        "currency": "EUR",
                        "exchange_rate": "1.0",
                        "discount": "0.0",
                        "original_estimate_id": null,
                        "show_tax": true,
                        "sign_online": true,
                        "sent_at": "2026-11-02",
                        "accepted_at": null,
                        "rejected_at": null,
                        "archived_at": null,
                        "created_at": "2026-11-02T12:17:08.022Z",
                        "updated_at": "2026-11-02T12:17:08.065Z",
                        "public_view_code": "966882",
                        "public_view_code_expires_at": "2027-02-02T12:17:08.046Z",
                        "version": 1793621828,
                        "pre_text": "Hello, here is your quote",
                        "post_text": "Please sign it",
                        "details": [
                          {
                            "id": "502689228447024466",
                            "administration_id": 123,
                            "tax_rate_id": "502689108899923082",
                            "ledger_account_id": "502689108787725434",
                            "project_id": null,
                            "product_id": null,
                            "amount": "1 x",
                            "amount_decimal": "1.0",
                            "description": "Project X",
                            "price": "300.0",
                            "period": null,
                            "row_order": 1,
                            "total_price_excl_tax_with_discount": "300.0",
                            "total_price_excl_tax_with_discount_base": "300.0",
                            "tax_report_reference": [
                              "NL/1a"
                            ],
                            "mandatory_tax_text": null,
                            "created_at": "2026-11-02T12:17:08.024Z",
                            "updated_at": "2026-11-02T12:17:08.064Z",
                            "is_optional": false,
                            "is_selected": true
                          }
                        ],
                        "prices_are_incl_tax": false,
                        "total_price_excl_tax": "300.0",
                        "total_price_excl_tax_base": "300.0",
                        "total_price_incl_tax": "363.0",
                        "total_price_incl_tax_base": "363.0",
                        "total_discount": "0.0",
                        "url": "http://moneybird.dev/123/external/0000000000000000000000000000000000000000000000000000000000000001/259dc15c01d92a321efbc86391e191f38d114e1fd3b30801db215b165fdbc102/estimate",
                        "custom_fields": [],
                        "notes": [],
                        "attachments": [],
                        "events": [
                          {
                            "administration_id": 123,
                            "user_id": "502689108256097381",
                            "action": "estimate_created",
                            "link_entity_id": null,
                            "link_entity_type": null,
                            "data": {},
                            "created_at": "2026-11-02T12:17:08.029Z",
                            "updated_at": "2026-11-02T12:17:08.029Z"
                          },
                          {
                            "administration_id": 123,
                            "user_id": "502689108256097381",
                            "action": "estimate_send_email",
                            "link_entity_id": null,
                            "link_entity_type": null,
                            "data": {
                              "email_address": "info@example.com; janjanssen@dev.null.moneybird.net",
                              "email_message": "Geachte Jan Janssen,\n\nHierbij ontvangt u van ons een prijsopgave 2026-0001 voor onze\ndiensten.\n\nMet vriendelijke groet,\n\nParkietje B.V."
                            },
                            "created_at": "2026-11-02T12:17:08.070Z",
                            "updated_at": "2026-11-02T12:17:08.070Z"
                          }
                        ],
                        "tax_totals": [
                          {
                            "tax_rate_id": "502689108899923082",
                            "taxable_amount": "300.0",
                            "taxable_amount_base": "300.0",
                            "tax_amount": "63.0",
                            "tax_amount_base": "63.0"
                          }
                        ]
                      }
                    ]
                  },
                  "ReturnsPaginatedEstimatesOnPage2": {
                    "summary": "Returns paginated estimates on page 2",
                    "value": [
                      {
                        "id": "502689229320488334",
                        "administration_id": 123,
                        "contact_id": "502689229133841792",
                        "contact": {
                          "id": "502689229133841792",
                          "administration_id": 123,
                          "company_name": "Foobar Holding B.V.",
                          "firstname": null,
                          "lastname": null,
                          "address1": "Hoofdstraat 12",
                          "address2": null,
                          "zipcode": "1234AB",
                          "city": "Amsterdam",
                          "country": "NL",
                          "phone": null,
                          "delivery_method": "Email",
                          "customer_id": "customer-1",
                          "tax_number": null,
                          "chamber_of_commerce": null,
                          "bank_account": null,
                          "is_trusted": false,
                          "max_transfer_amount": null,
                          "attention": null,
                          "email": "info@example.com",
                          "email_ubl": true,
                          "send_invoices_to_attention": null,
                          "send_invoices_to_email": "info@example.com",
                          "send_estimates_to_attention": null,
                          "send_estimates_to_email": "info@example.com",
                          "direct_debit": false,
                          "sepa_active": false,
                          "sepa_iban": null,
                          "sepa_iban_account_name": null,
                          "sepa_bic": null,
                          "sepa_mandate_id": null,
                          "sepa_mandate_date": null,
                          "sepa_sequence_type": "RCUR",
                          "credit_card_number": null,
                          "credit_card_reference": null,
                          "credit_card_type": null,
                          "tax_number_validated_at": null,
                          "tax_number_valid": null,
                          "invoice_workflow_id": null,
                          "estimate_workflow_id": null,
                          "si_identifier": null,
                          "si_identifier_type": null,
                          "moneybird_payments_mandate": false,
                          "created_at": "2026-11-02T12:17:08.679Z",
                          "updated_at": "2026-11-02T12:17:08.679Z",
                          "version": 1793621828,
                          "sales_invoices_url": "https://moneybird.dev/123/sales_invoices/0000000000000000000000000000000000000000000000000000000000000001/all",
                          "notes": [],
                          "custom_fields": [],
                          "contact_people": [],
                          "archived": false
                        },
                        "contact_person_id": null,
                        "contact_person": null,
                        "estimate_id": "2026-0003",
                        "estimate_sequence_id": "0003",
                        "workflow_id": "502689109222884501",
                        "document_style_id": "502689109280556185",
                        "identity_id": "502689108656653419",
                        "draft_id": null,
                        "state": "open",
                        "estimate_date": "2026-11-02",
                        "due_date": "2026-11-16",
                        "reference": "Project X",
                        "language": "nl",
                        "currency": "EUR",
                        "exchange_rate": "1.0",
                        "discount": "0.0",
                        "original_estimate_id": null,
                        "show_tax": true,
                        "sign_online": true,
                        "sent_at": "2026-11-02",
                        "accepted_at": null,
                        "rejected_at": null,
                        "archived_at": null,
                        "created_at": "2026-11-02T12:17:08.857Z",
                        "updated_at": "2026-11-02T12:17:08.892Z",
                        "public_view_code": "522280",
                        "public_view_code_expires_at": "2027-02-02T12:17:08.877Z",
                        "version": 1793621828,
                        "pre_text": "Hello, here is your quote",
                        "post_text": "Please sign it",
                        "details": [
                          {
                            "id": "502689229322585487",
                            "administration_id": 123,
                            "tax_rate_id": "502689108899923082",
                            "ledger_account_id": "502689108787725434",
                            "project_id": null,
                            "product_id": null,
                            "amount": "1 x",
                            "amount_decimal": "1.0",
                            "description": "Project X",
                            "price": "300.0",
                            "period": null,
                            "row_order": 1,
                            "total_price_excl_tax_with_discount": "300.0",
                            "total_price_excl_tax_with_discount_base": "300.0",
                            "tax_report_reference": [
                              "NL/1a"
                            ],
                            "mandatory_tax_text": null,
                            "created_at": "2026-11-02T12:17:08.859Z",
                            "updated_at": "2026-11-02T12:17:08.891Z",
                            "is_optional": false,
                            "is_selected": true
                          }
                        ],
                        "prices_are_incl_tax": false,
                        "total_price_excl_tax": "300.0",
                        "total_price_excl_tax_base": "300.0",
                        "total_price_incl_tax": "363.0",
                        "total_price_incl_tax_base": "363.0",
                        "total_discount": "0.0",
                        "url": "http://moneybird.dev/123/external/0000000000000000000000000000000000000000000000000000000000000001/69d8f81ca37a45bd0de341dd31a3af6926c12dc6cf590fd55e712a96151b9c66/estimate",
                        "custom_fields": [],
                        "notes": [],
                        "attachments": [],
                        "events": [
                          {
                            "administration_id": 123,
                            "user_id": "502689108256097381",
                            "action": "estimate_created",
                            "link_entity_id": null,
                            "link_entity_type": null,
                            "data": {},
                            "created_at": "2026-11-02T12:17:08.864Z",
                            "updated_at": "2026-11-02T12:17:08.864Z"
                          },
                          {
                            "administration_id": 123,
                            "user_id": "502689108256097381",
                            "action": "estimate_send_email",
                            "link_entity_id": null,
                            "link_entity_type": null,
                            "data": {
                              "email_address": "info@example.com",
                              "email_message": "Geachte Foobar Holding B.V.,\n\nHierbij ontvangt u van ons een prijsopgave 2026-0003 voor onze\ndiensten.\n\nMet vriendelijke groet,\n\nParkietje B.V."
                            },
                            "created_at": "2026-11-02T12:17:08.897Z",
                            "updated_at": "2026-11-02T12:17:08.897Z"
                          }
                        ],
                        "tax_totals": [
                          {
                            "tax_rate_id": "502689108899923082",
                            "taxable_amount": "300.0",
                            "taxable_amount_base": "300.0",
                            "tax_amount": "63.0",
                            "tax_amount_base": "63.0"
                          }
                        ]
                      }
                    ]
                  },
                  "ReturnsAllEstimatesFilteredOnPeriod": {
                    "summary": "Returns all estimates filtered on period",
                    "value": [
                      {
                        "id": "502689229729433004",
                        "administration_id": 123,
                        "contact_id": "502689229505037722",
                        "contact": {
                          "id": "502689229505037722",
                          "administration_id": 123,
                          "company_name": "Foobar Holding B.V.",
                          "firstname": null,
                          "lastname": null,
                          "address1": "Hoofdstraat 12",
                          "address2": null,
                          "zipcode": "1234AB",
                          "city": "Amsterdam",
                          "country": "NL",
                          "phone": null,
                          "delivery_method": "Email",
                          "customer_id": "customer-1",
                          "tax_number": null,
                          "chamber_of_commerce": null,
                          "bank_account": null,
                          "is_trusted": false,
                          "max_transfer_amount": null,
                          "attention": null,
                          "email": "info@example.com",
                          "email_ubl": true,
                          "send_invoices_to_attention": null,
                          "send_invoices_to_email": "info@example.com",
                          "send_estimates_to_attention": null,
                          "send_estimates_to_email": "info@example.com",
                          "direct_debit": false,
                          "sepa_active": false,
                          "sepa_iban": null,
                          "sepa_iban_account_name": null,
                          "sepa_bic": null,
                          "sepa_mandate_id": null,
                          "sepa_mandate_date": null,
                          "sepa_sequence_type": "RCUR",
                          "credit_card_number": null,
                          "credit_card_reference": null,
                          "credit_card_type": null,
                          "tax_number_validated_at": null,
                          "tax_number_valid": null,
                          "invoice_workflow_id": null,
                          "estimate_workflow_id": null,
                          "si_identifier": null,
                          "si_identifier_type": null,
                          "moneybird_payments_mandate": false,
                          "created_at": "2026-11-02T12:17:09.033Z",
                          "updated_at": "2026-11-02T12:17:09.033Z",
                          "version": 1793621829,
                          "sales_invoices_url": "https://moneybird.dev/123/sales_invoices/0000000000000000000000000000000000000000000000000000000000000001/all",
                          "notes": [],
                          "custom_fields": [],
                          "contact_people": [],
                          "archived": false
                        },
                        "contact_person_id": null,
                        "contact_person": null,
                        "estimate_id": "2026-0004",
                        "estimate_sequence_id": "0004",
                        "workflow_id": "502689109222884501",
                        "document_style_id": "502689109280556185",
                        "identity_id": "502689108656653419",
                        "draft_id": null,
                        "state": "open",
                        "estimate_date": "2026-11-02",
                        "due_date": "2026-11-16",
                        "reference": "Project X",
                        "language": "nl",
                        "currency": "EUR",
                        "exchange_rate": "1.0",
                        "discount": "0.0",
                        "original_estimate_id": null,
                        "show_tax": true,
                        "sign_online": true,
                        "sent_at": "2026-11-02",
                        "accepted_at": null,
                        "rejected_at": null,
                        "archived_at": null,
                        "created_at": "2026-11-02T12:17:09.248Z",
                        "updated_at": "2026-11-02T12:17:09.280Z",
                        "public_view_code": "959859",
                        "public_view_code_expires_at": "2027-02-02T12:17:09.265Z",
                        "version": 1793621829,
                        "pre_text": "Hello, here is your quote",
                        "post_text": "Please sign it",
                        "details": [
                          {
                            "id": "502689229731530157",
                            "administration_id": 123,
                            "tax_rate_id": "502689108899923082",
                            "ledger_account_id": "502689108787725434",
                            "project_id": null,
                            "product_id": null,
                            "amount": "1 x",
                            "amount_decimal": "1.0",
                            "description": "Project X",
                            "price": "300.0",
                            "period": null,
                            "row_order": 1,
                            "total_price_excl_tax_with_discount": "300.0",
                            "total_price_excl_tax_with_discount_base": "300.0",
                            "tax_report_reference": [
                              "NL/1a"
                            ],
                            "mandatory_tax_text": null,
                            "created_at": "2026-11-02T12:17:09.249Z",
                            "updated_at": "2026-11-02T12:17:09.279Z",
                            "is_optional": false,
                            "is_selected": true
                          }
                        ],
                        "prices_are_incl_tax": false,
                        "total_price_excl_tax": "300.0",
                        "total_price_excl_tax_base": "300.0",
                        "total_price_incl_tax": "363.0",
                        "total_price_incl_tax_base": "363.0",
                        "total_discount": "0.0",
                        "url": "http://moneybird.dev/123/external/0000000000000000000000000000000000000000000000000000000000000001/f82975798028ac676f85c131e17ac5581eede76b0b118257d5f2d7960e020149/estimate",
                        "custom_fields": [],
                        "notes": [],
                        "attachments": [],
                        "events": [
                          {
                            "administration_id": 123,
                            "user_id": "502689108256097381",
                            "action": "estimate_created",
                            "link_entity_id": null,
                            "link_entity_type": null,
                            "data": {},
                            "created_at": "2026-11-02T12:17:09.252Z",
                            "updated_at": "2026-11-02T12:17:09.252Z"
                          },
                          {
                            "administration_id": 123,
                            "user_id": "502689108256097381",
                            "action": "estimate_send_email",
                            "link_entity_id": null,
                            "link_entity_type": null,
                            "data": {
                              "email_address": "info@example.com",
                              "email_message": "Geachte Foobar Holding B.V.,\n\nHierbij ontvangt u van ons een prijsopgave 2026-0004 voor onze\ndiensten.\n\nMet vriendelijke groet,\n\nParkietje B.V."
                            },
                            "created_at": "2026-11-02T12:17:09.285Z",
                            "updated_at": "2026-11-02T12:17:09.285Z"
                          }
                        ],
                        "tax_totals": [
                          {
                            "tax_rate_id": "502689108899923082",
                            "taxable_amount": "300.0",
                            "taxable_amount_base": "300.0",
                            "tax_amount": "63.0",
                            "tax_amount_base": "63.0"
                          }
                        ]
                      },
                      {
                        "id": "502689229672809896",
                        "administration_id": 123,
                        "contact_id": "502689229505037722",
                        "contact": {
                          "id": "502689229505037722",
                          "administration_id": 123,
                          "company_name": "Foobar Holding B.V.",
                          "firstname": null,
                          "lastname": null,
                          "address1": "Hoofdstraat 12",
                          "address2": null,
                          "zipcode": "1234AB",
                          "city": "Amsterdam",
                          "country": "NL",
                          "phone": null,
                          "delivery_method": "Email",
                          "customer_id": "customer-1",
                          "tax_number": null,
                          "chamber_of_commerce": null,
                          "bank_account": null,
                          "is_trusted": false,
                          "max_transfer_amount": null,
                          "attention": null,
                          "email": "info@example.com",
                          "email_ubl": true,
                          "send_invoices_to_attention": null,
                          "send_invoices_to_email": "info@example.com",
                          "send_estimates_to_attention": null,
                          "send_estimates_to_email": "info@example.com",
                          "direct_debit": false,
                          "sepa_active": false,
                          "sepa_iban": null,
                          "sepa_iban_account_name": null,
                          "sepa_bic": null,
                          "sepa_mandate_id": null,
                          "sepa_mandate_date": null,
                          "sepa_sequence_type": "RCUR",
                          "credit_card_number": null,
                          "credit_card_reference": null,
                          "credit_card_type": null,
                          "tax_number_validated_at": null,
                          "tax_number_valid": null,
                          "invoice_workflow_id": null,
                          "estimate_workflow_id": null,
                          "si_identifier": null,
                          "si_identifier_type": null,
                          "moneybird_payments_mandate": false,
                          "created_at": "2026-11-02T12:17:09.033Z",
                          "updated_at": "2026-11-02T12:17:09.033Z",
                          "version": 1793621829,
                          "sales_invoices_url": "https://moneybird.dev/123/sales_invoices/0000000000000000000000000000000000000000000000000000000000000001/all",
                          "notes": [],
                          "custom_fields": [],
                          "contact_people": [],
                          "archived": false
                        },
                        "contact_person_id": null,
                        "contact_person": null,
                        "estimate_id": "2026-0003",
                        "estimate_sequence_id": "0003",
                        "workflow_id": "502689109222884501",
                        "document_style_id": "502689109280556185",
                        "identity_id": "502689108656653419",
                        "draft_id": null,
                        "state": "open",
                        "estimate_date": "2026-11-02",
                        "due_date": "2026-11-16",
                        "reference": "Project X",
                        "language": "nl",
                        "currency": "EUR",
                        "exchange_rate": "1.0",
                        "discount": "0.0",
                        "original_estimate_id": null,
                        "show_tax": true,
                        "sign_online": true,
                        "sent_at": "2026-11-02",
                        "accepted_at": null,
                        "rejected_at": null,
                        "archived_at": null,
                        "created_at": "2026-11-02T12:17:09.193Z",
                        "updated_at": "2026-11-02T12:17:09.225Z",
                        "public_view_code": "607626",
                        "public_view_code_expires_at": "2027-02-02T12:17:09.209Z",
                        "version": 1793621829,
                        "pre_text": "Hello, here is your quote",
                        "post_text": "Please sign it",
                        "details": [
                          {
                            "id": "502689229673858473",
                            "administration_id": 123,
                            "tax_rate_id": "502689108899923082",
                            "ledger_account_id": "502689108787725434",
                            "project_id": null,
                            "product_id": null,
                            "amount": "1 x",
                            "amount_decimal": "1.0",
                            "description": "Project X",
                            "price": "300.0",
                            "period": null,
                            "row_order": 1,
                            "total_price_excl_tax_with_discount": "300.0",
                            "total_price_excl_tax_with_discount_base": "300.0",
                            "tax_report_reference": [
                              "NL/1a"
                            ],
                            "mandatory_tax_text": null,
                            "created_at": "2026-11-02T12:17:09.195Z",
                            "updated_at": "2026-11-02T12:17:09.223Z",
                            "is_optional": false,
                            "is_selected": true
                          }
                        ],
                        "prices_are_incl_tax": false,
                        "total_price_excl_tax": "300.0",
                        "total_price_excl_tax_base": "300.0",
                        "total_price_incl_tax": "363.0",
                        "total_price_incl_tax_base": "363.0",
                        "total_discount": "0.0",
                        "url": "http://moneybird.dev/123/external/0000000000000000000000000000000000000000000000000000000000000001/65d027c2f96cd6a982503c3610b7cc2da03e7ca76fcdebf3c15871aae37a993f/estimate",
                        "custom_fields": [],
                        "notes": [],
                        "attachments": [],
                        "events": [
                          {
                            "administration_id": 123,
                            "user_id": "502689108256097381",
                            "action": "estimate_created",
                            "link_entity_id": null,
                            "link_entity_type": null,
                            "data": {},
                            "created_at": "2026-11-02T12:17:09.198Z",
                            "updated_at": "2026-11-02T12:17:09.198Z"
                          },
                          {
                            "administration_id": 123,
                            "user_id": "502689108256097381",
                            "action": "estimate_send_email",
                            "link_entity_id": null,
                            "link_entity_type": null,
                            "data": {
                              "email_address": "info@example.com",
                              "email_message": "Geachte Foobar Holding B.V.,\n\nHierbij ontvangt u van ons een prijsopgave 2026-0003 voor onze\ndiensten.\n\nMet vriendelijke groet,\n\nParkietje B.V."
                            },
                            "created_at": "2026-11-02T12:17:09.230Z",
                            "updated_at": "2026-11-02T12:17:09.230Z"
                          }
                        ],
                        "tax_totals": [
                          {
                            "tax_rate_id": "502689108899923082",
                            "taxable_amount": "300.0",
                            "taxable_amount_base": "300.0",
                            "tax_amount": "63.0",
                            "tax_amount_base": "63.0"
                          }
                        ]
                      },
                      {
                        "id": "502689229603603876",
                        "administration_id": 123,
                        "contact_id": "502689229505037722",
                        "contact": {
                          "id": "502689229505037722",
                          "administration_id": 123,
                          "company_name": "Foobar Holding B.V.",
                          "firstname": null,
                          "lastname": null,
                          "address1": "Hoofdstraat 12",
                          "address2": null,
                          "zipcode": "1234AB",
                          "city": "Amsterdam",
                          "country": "NL",
                          "phone": null,
                          "delivery_method": "Email",
                          "customer_id": "customer-1",
                          "tax_number": null,
                          "chamber_of_commerce": null,
                          "bank_account": null,
                          "is_trusted": false,
                          "max_transfer_amount": null,
                          "attention": null,
                          "email": "info@example.com",
                          "email_ubl": true,
                          "send_invoices_to_attention": null,
                          "send_invoices_to_email": "info@example.com",
                          "send_estimates_to_attention": null,
                          "send_estimates_to_email": "info@example.com",
                          "direct_debit": false,
                          "sepa_active": false,
                          "sepa_iban": null,
                          "sepa_iban_account_name": null,
                          "sepa_bic": null,
                          "sepa_mandate_id": null,
                          "sepa_mandate_date": null,
                          "sepa_sequence_type": "RCUR",
                          "credit_card_number": null,
                          "credit_card_reference": null,
                          "credit_card_type": null,
                          "tax_number_validated_at": null,
                          "tax_number_valid": null,
                          "invoice_workflow_id": null,
                          "estimate_workflow_id": null,
                          "si_identifier": null,
                          "si_identifier_type": null,
                          "moneybird_payments_mandate": false,
                          "created_at": "2026-11-02T12:17:09.033Z",
                          "updated_at": "2026-11-02T12:17:09.033Z",
                          "version": 1793621829,
                          "sales_invoices_url": "https://moneybird.dev/123/sales_invoices/0000000000000000000000000000000000000000000000000000000000000001/all",
                          "notes": [],
                          "custom_fields": [],
                          "contact_people": [],
                          "archived": false
                        },
                        "contact_person_id": null,
                        "contact_person": null,
                        "estimate_id": "2026-0002",
                        "estimate_sequence_id": "0002",
                        "workflow_id": "502689109222884501",
                        "document_style_id": "502689109280556185",
                        "identity_id": "502689108656653419",
                        "draft_id": null,
                        "state": "open",
                        "estimate_date": "2026-11-02",
                        "due_date": "2026-11-16",
                        "reference": "Project X",
                        "language": "nl",
                        "currency": "EUR",
                        "exchange_rate": "1.0",
                        "discount": "0.0",
                        "original_estimate_id": null,
                        "show_tax": true,
                        "sign_online": true,
                        "sent_at": "2026-11-02",
                        "accepted_at": null,
                        "rejected_at": null,
                        "archived_at": null,
                        "created_at": "2026-11-02T12:17:09.127Z",
                        "updated_at": "2026-11-02T12:17:09.167Z",
                        "public_view_code": "222375",
                        "public_view_code_expires_at": "2027-02-02T12:17:09.146Z",
                        "version": 1793621829,
                        "pre_text": "Hello, here is your quote",
                        "post_text": "Please sign it",
                        "details": [
                          {
                            "id": "502689229604652453",
                            "administration_id": 123,
                            "tax_rate_id": "502689108899923082",
                            "ledger_account_id": "502689108787725434",
                            "project_id": null,
                            "product_id": null,
                            "amount": "1 x",
                            "amount_decimal": "1.0",
                            "description": "Project X",
                            "price": "300.0",
                            "period": null,
                            "row_order": 1,
                            "total_price_excl_tax_with_discount": "300.0",
                            "total_price_excl_tax_with_discount_base": "300.0",
                            "tax_report_reference": [
                              "NL/1a"
                            ],
                            "mandatory_tax_text": null,
                            "created_at": "2026-11-02T12:17:09.129Z",
                            "updated_at": "2026-11-02T12:17:09.166Z",
                            "is_optional": false,
                            "is_selected": true
                          }
                        ],
                        "prices_are_incl_tax": false,
                        "total_price_excl_tax": "300.0",
                        "total_price_excl_tax_base": "300.0",
                        "total_price_incl_tax": "363.0",
                        "total_price_incl_tax_base": "363.0",
                        "total_discount": "0.0",
                        "url": "http://moneybird.dev/123/external/0000000000000000000000000000000000000000000000000000000000000001/4f5cf1ea6ab358a8f4d4ee3380f15cd01714a8225a98d815a7b58fba478ffb2b/estimate",
                        "custom_fields": [],
                        "notes": [],
                        "attachments": [],
                        "events": [
                          {
                            "administration_id": 123,
                            "user_id": "502689108256097381",
                            "action": "estimate_created",
                            "link_entity_id": null,
                            "link_entity_type": null,
                            "data": {},
                            "created_at": "2026-11-02T12:17:09.132Z",
                            "updated_at": "2026-11-02T12:17:09.132Z"
                          },
                          {
                            "administration_id": 123,
                            "user_id": "502689108256097381",
                            "action": "estimate_send_email",
                            "link_entity_id": null,
                            "link_entity_type": null,
                            "data": {
                              "email_address": "info@example.com",
                              "email_message": "Geachte Foobar Holding B.V.,\n\nHierbij ontvangt u van ons een prijsopgave 2026-0002 voor onze\ndiensten.\n\nMet vriendelijke groet,\n\nParkietje B.V."
                            },
                            "created_at": "2026-11-02T12:17:09.172Z",
                            "updated_at": "2026-11-02T12:17:09.172Z"
                          }
                        ],
                        "tax_totals": [
                          {
                            "tax_rate_id": "502689108899923082",
                            "taxable_amount": "300.0",
                            "taxable_amount_base": "300.0",
                            "tax_amount": "63.0",
                            "tax_amount_base": "63.0"
                          }
                        ]
                      },
                      {
                        "id": "502689229534397855",
                        "administration_id": 123,
                        "contact_id": "502689229505037722",
                        "contact": {
                          "id": "502689229505037722",
                          "administration_id": 123,
                          "company_name": "Foobar Holding B.V.",
                          "firstname": null,
                          "lastname": null,
                          "address1": "Hoofdstraat 12",
                          "address2": null,
                          "zipcode": "1234AB",
                          "city": "Amsterdam",
                          "country": "NL",
                          "phone": null,
                          "delivery_method": "Email",
                          "customer_id": "customer-1",
                          "tax_number": null,
                          "chamber_of_commerce": null,
                          "bank_account": null,
                          "is_trusted": false,
                          "max_transfer_amount": null,
                          "attention": null,
                          "email": "info@example.com",
                          "email_ubl": true,
                          "send_invoices_to_attention": null,
                          "send_invoices_to_email": "info@example.com",
                          "send_estimates_to_attention": null,
                          "send_estimates_to_email": "info@example.com",
                          "direct_debit": false,
                          "sepa_active": false,
                          "sepa_iban": null,
                          "sepa_iban_account_name": null,
                          "sepa_bic": null,
                          "sepa_mandate_id": null,
                          "sepa_mandate_date": null,
                          "sepa_sequence_type": "RCUR",
                          "credit_card_number": null,
                          "credit_card_reference": null,
                          "credit_card_type": null,
                          "tax_number_validated_at": null,
                          "tax_number_valid": null,
                          "invoice_workflow_id": null,
                          "estimate_workflow_id": null,
                          "si_identifier": null,
                          "si_identifier_type": null,
                          "moneybird_payments_mandate": false,
                          "created_at": "2026-11-02T12:17:09.033Z",
                          "updated_at": "2026-11-02T12:17:09.033Z",
                          "version": 1793621829,
                          "sales_invoices_url": "https://moneybird.dev/123/sales_invoices/0000000000000000000000000000000000000000000000000000000000000001/all",
                          "notes": [],
                          "custom_fields": [],
                          "contact_people": [],
                          "archived": false
                        },
                        "contact_person_id": "502689229508183452",
                        "contact_person": {
                          "id": null,
                          "contact_id": "502689229505037722",
                          "administration_id": 123,
                          "firstname": "Jan",
                          "lastname": "Janssen",
                          "phone": "123-456-2346",
                          "email": "janjanssen@dev.null.moneybird.net",
                          "department": "Sales",
                          "created_at": "2026-11-02T12:17:09.037Z",
                          "updated_at": "2026-11-02T12:17:09.037Z",
                          "version": 1793621829
                        },
                        "estimate_id": "2026-0001",
                        "estimate_sequence_id": "0001",
                        "workflow_id": "502689109222884501",
                        "document_style_id": "502689109280556185",
                        "identity_id": "502689108656653419",
                        "draft_id": null,
                        "state": "open",
                        "estimate_date": "2026-11-02",
                        "due_date": "2026-11-16",
                        "reference": "Project X",
                        "language": "nl",
                        "currency": "EUR",
                        "exchange_rate": "1.0",
                        "discount": "0.0",
                        "original_estimate_id": null,
                        "show_tax": true,
                        "sign_online": true,
                        "sent_at": "2026-11-02",
                        "accepted_at": null,
                        "rejected_at": null,
                        "archived_at": null,
                        "created_at": "2026-11-02T12:17:09.061Z",
                        "updated_at": "2026-11-02T12:17:09.101Z",
                        "public_view_code": "310314",
                        "public_view_code_expires_at": "2027-02-02T12:17:09.082Z",
                        "version": 1793621829,
                        "pre_text": "Hello, here is your quote",
                        "post_text": "Please sign it",
                        "details": [
                          {
                            "id": "502689229536495008",
                            "administration_id": 123,
                            "tax_rate_id": "502689108899923082",
                            "ledger_account_id": "502689108787725434",
                            "project_id": null,
                            "product_id": null,
                            "amount": "1 x",
                            "amount_decimal": "1.0",
                            "description": "Project X",
                            "price": "300.0",
                            "period": null,
                            "row_order": 1,
                            "total_price_excl_tax_with_discount": "300.0",
                            "total_price_excl_tax_with_discount_base": "300.0",
                            "tax_report_reference": [
                              "NL/1a"
                            ],
                            "mandatory_tax_text": null,
                            "created_at": "2026-11-02T12:17:09.063Z",
                            "updated_at": "2026-11-02T12:17:09.100Z",
                            "is_optional": false,
                            "is_selected": true
                          }
                        ],
                        "prices_are_incl_tax": false,
                        "total_price_excl_tax": "300.0",
                        "total_price_excl_tax_base": "300.0",
                        "total_price_incl_tax": "363.0",
                        "total_price_incl_tax_base": "363.0",
                        "total_discount": "0.0",
                        "url": "http://moneybird.dev/123/external/0000000000000000000000000000000000000000000000000000000000000001/f7b73378a759bcde3ef882d2dcf38097e58c1346ff812dc2bd830ccc22a59683/estimate",
                        "custom_fields": [],
                        "notes": [],
                        "attachments": [],
                        "events": [
                          {
                            "administration_id": 123,
                            "user_id": "502689108256097381",
                            "action": "estimate_created",
                            "link_entity_id": null,
                            "link_entity_type": null,
                            "data": {},
                            "created_at": "2026-11-02T12:17:09.067Z",
                            "updated_at": "2026-11-02T12:17:09.067Z"
                          },
                          {
                            "administration_id": 123,
                            "user_id": "502689108256097381",
                            "action": "estimate_send_email",
                            "link_entity_id": null,
                            "link_entity_type": null,
                            "data": {
                              "email_address": "info@example.com; janjanssen@dev.null.moneybird.net",
                              "email_message": "Geachte Jan Janssen,\n\nHierbij ontvangt u van ons een prijsopgave 2026-0001 voor onze\ndiensten.\n\nMet vriendelijke groet,\n\nParkietje B.V."
                            },
                            "created_at": "2026-11-02T12:17:09.106Z",
                            "updated_at": "2026-11-02T12:17:09.106Z"
                          }
                        ],
                        "tax_totals": [
                          {
                            "tax_rate_id": "502689108899923082",
                            "taxable_amount": "300.0",
                            "taxable_amount_base": "300.0",
                            "tax_amount": "63.0",
                            "tax_amount_base": "63.0"
                          }
                        ]
                      }
                    ]
                  },
                  "ReturnsPaginatedEstimatesOnPage1": {
                    "summary": "Returns paginated estimates on page 1",
                    "value": [
                      {
                        "id": "502689230223312326",
                        "administration_id": 123,
                        "contact_id": "502689229883573684",
                        "contact": {
                          "id": "502689229883573684",
                          "administration_id": 123,
                          "company_name": "Foobar Holding B.V.",
                          "firstname": null,
                          "lastname": null,
                          "address1": "Hoofdstraat 12",
                          "address2": null,
                          "zipcode": "1234AB",
                          "city": "Amsterdam",
                          "country": "NL",
                          "phone": null,
                          "delivery_method": "Email",
                          "customer_id": "customer-1",
                          "tax_number": null,
                          "chamber_of_commerce": null,
                          "bank_account": null,
                          "is_trusted": false,
                          "max_transfer_amount": null,
                          "attention": null,
                          "email": "info@example.com",
                          "email_ubl": true,
                          "send_invoices_to_attention": null,
                          "send_invoices_to_email": "info@example.com",
                          "send_estimates_to_attention": null,
                          "send_estimates_to_email": "info@example.com",
                          "direct_debit": false,
                          "sepa_active": false,
                          "sepa_iban": null,
                          "sepa_iban_account_name": null,
                          "sepa_bic": null,
                          "sepa_mandate_id": null,
                          "sepa_mandate_date": null,
                          "sepa_sequence_type": "RCUR",
                          "credit_card_number": null,
                          "credit_card_reference": null,
                          "credit_card_type": null,
                          "tax_number_validated_at": null,
                          "tax_number_valid": null,
                          "invoice_workflow_id": null,
                          "estimate_workflow_id": null,
                          "si_identifier": null,
                          "si_identifier_type": null,
                          "moneybird_payments_mandate": false,
                          "created_at": "2026-11-02T12:17:09.394Z",
                          "updated_at": "2026-11-02T12:17:09.394Z",
                          "version": 1793621829,
                          "sales_invoices_url": "https://moneybird.dev/123/sales_invoices/0000000000000000000000000000000000000000000000000000000000000001/all",
                          "notes": [],
                          "custom_fields": [],
                          "contact_people": [],
                          "archived": false
                        },
                        "contact_person_id": null,
                        "contact_person": null,
                        "estimate_id": "2026-0004",
                        "estimate_sequence_id": "0004",
                        "workflow_id": "502689109222884501",
                        "document_style_id": "502689109280556185",
                        "identity_id": "502689108656653419",
                        "draft_id": null,
                        "state": "open",
                        "estimate_date": "2026-11-02",
                        "due_date": "2026-11-16",
                        "reference": "Project X",
                        "language": "nl",
                        "currency": "EUR",
                        "exchange_rate": "1.0",
                        "discount": "0.0",
                        "original_estimate_id": null,
                        "show_tax": true,
                        "sign_online": true,
                        "sent_at": "2026-11-02",
                        "accepted_at": null,
                        "rejected_at": null,
                        "archived_at": null,
                        "created_at": "2026-11-02T12:17:09.719Z",
                        "updated_at": "2026-11-02T12:17:09.755Z",
                        "public_view_code": "093156",
                        "public_view_code_expires_at": "2027-02-02T12:17:09.739Z",
                        "version": 1793621829,
                        "pre_text": "Hello, here is your quote",
                        "post_text": "Please sign it",
                        "details": [
                          {
                            "id": "502689230225409479",
                            "administration_id": 123,
                            "tax_rate_id": "502689108899923082",
                            "ledger_account_id": "502689108787725434",
                            "project_id": null,
                            "product_id": null,
                            "amount": "1 x",
                            "amount_decimal": "1.0",
                            "description": "Project X",
                            "price": "300.0",
                            "period": null,
                            "row_order": 1,
                            "total_price_excl_tax_with_discount": "300.0",
                            "total_price_excl_tax_with_discount_base": "300.0",
                            "tax_report_reference": [
                              "NL/1a"
                            ],
                            "mandatory_tax_text": null,
                            "created_at": "2026-11-02T12:17:09.721Z",
                            "updated_at": "2026-11-02T12:17:09.754Z",
                            "is_optional": false,
                            "is_selected": true
                          }
                        ],
                        "prices_are_incl_tax": false,
                        "total_price_excl_tax": "300.0",
                        "total_price_excl_tax_base": "300.0",
                        "total_price_incl_tax": "363.0",
                        "total_price_incl_tax_base": "363.0",
                        "total_discount": "0.0",
                        "url": "http://moneybird.dev/123/external/0000000000000000000000000000000000000000000000000000000000000001/16ff3df39ba2de90c0032126b3be4a1a44ca65a639167d68b08702b84764edce/estimate",
                        "custom_fields": [],
                        "notes": [],
                        "attachments": [],
                        "events": [
                          {
                            "administration_id": 123,
                            "user_id": "502689108256097381",
                            "action": "estimate_created",
                            "link_entity_id": null,
                            "link_entity_type": null,
                            "data": {},
                            "created_at": "2026-11-02T12:17:09.724Z",
                            "updated_at": "2026-11-02T12:17:09.724Z"
                          },
                          {
                            "administration_id": 123,
                            "user_id": "502689108256097381",
                            "action": "estimate_send_email",
                            "link_entity_id": null,
                            "link_entity_type": null,
                            "data": {
                              "email_address": "info@example.com",
                              "email_message": "Geachte Foobar Holding B.V.,\n\nHierbij ontvangt u van ons een prijsopgave 2026-0004 voor onze\ndiensten.\n\nMet vriendelijke groet,\n\nParkietje B.V."
                            },
                            "created_at": "2026-11-02T12:17:09.761Z",
                            "updated_at": "2026-11-02T12:17:09.761Z"
                          }
                        ],
                        "tax_totals": [
                          {
                            "tax_rate_id": "502689108899923082",
                            "taxable_amount": "300.0",
                            "taxable_amount_base": "300.0",
                            "tax_amount": "63.0",
                            "tax_amount_base": "63.0"
                          }
                        ]
                      }
                    ]
                  },
                  "ReturnsAllEstimatesFilteredOnState": {
                    "summary": "Returns all estimates filtered on state",
                    "value": [
                      {
                        "id": "502689230614431200",
                        "administration_id": 123,
                        "contact_id": "502689230360675790",
                        "contact": {
                          "id": "502689230360675790",
                          "administration_id": 123,
                          "company_name": "Foobar Holding B.V.",
                          "firstname": null,
                          "lastname": null,
                          "address1": "Hoofdstraat 12",
                          "address2": null,
                          "zipcode": "1234AB",
                          "city": "Amsterdam",
                          "country": "NL",
                          "phone": null,
                          "delivery_method": "Email",
                          "customer_id": "customer-1",
                          "tax_number": null,
                          "chamber_of_commerce": null,
                          "bank_account": null,
                          "is_trusted": false,
                          "max_transfer_amount": null,
                          "attention": null,
                          "email": "info@example.com",
                          "email_ubl": true,
                          "send_invoices_to_attention": null,
                          "send_invoices_to_email": "info@example.com",
                          "send_estimates_to_attention": null,
                          "send_estimates_to_email": "info@example.com",
                          "direct_debit": false,
                          "sepa_active": false,
                          "sepa_iban": null,
                          "sepa_iban_account_name": null,
                          "sepa_bic": null,
                          "sepa_mandate_id": null,
                          "sepa_mandate_date": null,
                          "sepa_sequence_type": "RCUR",
                          "credit_card_number": null,
                          "credit_card_reference": null,
                          "credit_card_type": null,
                          "tax_number_validated_at": null,
                          "tax_number_valid": null,
                          "invoice_workflow_id": null,
                          "estimate_workflow_id": null,
                          "si_identifier": null,
                          "si_identifier_type": null,
                          "moneybird_payments_mandate": false,
                          "created_at": "2026-11-02T12:17:09.849Z",
                          "updated_at": "2026-11-02T12:17:09.849Z",
                          "version": 1793621829,
                          "sales_invoices_url": "https://moneybird.dev/123/sales_invoices/0000000000000000000000000000000000000000000000000000000000000001/all",
                          "notes": [],
                          "custom_fields": [],
                          "contact_people": [],
                          "archived": false
                        },
                        "contact_person_id": null,
                        "contact_person": null,
                        "estimate_id": "2026-0004",
                        "estimate_sequence_id": "0004",
                        "workflow_id": "502689109222884501",
                        "document_style_id": "502689109280556185",
                        "identity_id": "502689108656653419",
                        "draft_id": null,
                        "state": "open",
                        "estimate_date": "2026-11-02",
                        "due_date": "2026-11-16",
                        "reference": "Project X",
                        "language": "nl",
                        "currency": "EUR",
                        "exchange_rate": "1.0",
                        "discount": "0.0",
                        "original_estimate_id": null,
                        "show_tax": true,
                        "sign_online": true,
                        "sent_at": "2026-11-02",
                        "accepted_at": null,
                        "rejected_at": null,
                        "archived_at": null,
                        "created_at": "2026-11-02T12:17:10.092Z",
                        "updated_at": "2026-11-02T12:17:10.127Z",
                        "public_view_code": "924403",
                        "public_view_code_expires_at": "2027-02-02T12:17:10.110Z",
                        "version": 1793621830,
                        "pre_text": "Hello, here is your quote",
                        "post_text": "Please sign it",
                        "details": [
                          {
                            "id": "502689230616528353",
                            "administration_id": 123,
                            "tax_rate_id": "502689108899923082",
                            "ledger_account_id": "502689108787725434",
                            "project_id": null,
                            "product_id": null,
                            "amount": "1 x",
                            "amount_decimal": "1.0",
                            "description": "Project X",
                            "price": "300.0",
                            "period": null,
                            "row_order": 1,
                            "total_price_excl_tax_with_discount": "300.0",
                            "total_price_excl_tax_with_discount_base": "300.0",
                            "tax_report_reference": [
                              "NL/1a"
                            ],
                            "mandatory_tax_text": null,
                            "created_at": "2026-11-02T12:17:10.093Z",
                            "updated_at": "2026-11-02T12:17:10.126Z",
                            "is_optional": false,
                            "is_selected": true
                          }
                        ],
                        "prices_are_incl_tax": false,
                        "total_price_excl_tax": "300.0",
                        "total_price_excl_tax_base": "300.0",
                        "total_price_incl_tax": "363.0",
                        "total_price_incl_tax_base": "363.0",
                        "total_discount": "0.0",
                        "url": "http://moneybird.dev/123/external/0000000000000000000000000000000000000000000000000000000000000001/0f3725e12ae83211211c21bb34e4f8a49dee088bae724b39c74c02b39ae4c1d8/estimate",
                        "custom_fields": [],
                        "notes": [],
                        "attachments": [],
                        "events": [
                          {
                            "administration_id": 123,
                            "user_id": "502689108256097381",
                            "action": "estimate_created",
                            "link_entity_id": null,
                            "link_entity_type": null,
                            "data": {},
                            "created_at": "2026-11-02T12:17:10.097Z",
                            "updated_at": "2026-11-02T12:17:10.097Z"
                          },
                          {
                            "administration_id": 123,
                            "user_id": "502689108256097381",
                            "action": "estimate_send_email",
                            "link_entity_id": null,
                            "link_entity_type": null,
                            "data": {
                              "email_address": "info@example.com",
                              "email_message": "Geachte Foobar Holding B.V.,\n\nHierbij ontvangt u van ons een prijsopgave 2026-0004 voor onze\ndiensten.\n\nMet vriendelijke groet,\n\nParkietje B.V."
                            },
                            "created_at": "2026-11-02T12:17:10.132Z",
                            "updated_at": "2026-11-02T12:17:10.132Z"
                          }
                        ],
                        "tax_totals": [
                          {
                            "tax_rate_id": "502689108899923082",
                            "taxable_amount": "300.0",
                            "taxable_amount_base": "300.0",
                            "tax_amount": "63.0",
                            "tax_amount_base": "63.0"
                          }
                        ]
                      },
                      {
                        "id": "502689230550468060",
                        "administration_id": 123,
                        "contact_id": "502689230360675790",
                        "contact": {
                          "id": "502689230360675790",
                          "administration_id": 123,
                          "company_name": "Foobar Holding B.V.",
                          "firstname": null,
                          "lastname": null,
                          "address1": "Hoofdstraat 12",
                          "address2": null,
                          "zipcode": "1234AB",
                          "city": "Amsterdam",
                          "country": "NL",
                          "phone": null,
                          "delivery_method": "Email",
                          "customer_id": "customer-1",
                          "tax_number": null,
                          "chamber_of_commerce": null,
                          "bank_account": null,
                          "is_trusted": false,
                          "max_transfer_amount": null,
                          "attention": null,
                          "email": "info@example.com",
                          "email_ubl": true,
                          "send_invoices_to_attention": null,
                          "send_invoices_to_email": "info@example.com",
                          "send_estimates_to_attention": null,
                          "send_estimates_to_email": "info@example.com",
                          "direct_debit": false,
                          "sepa_active": false,
                          "sepa_iban": null,
                          "sepa_iban_account_name": null,
                          "sepa_bic": null,
                          "sepa_mandate_id": null,
                          "sepa_mandate_date": null,
                          "sepa_sequence_type": "RCUR",
                          "credit_card_number": null,
                          "credit_card_reference": null,
                          "credit_card_type": null,
                          "tax_number_validated_at": null,
                          "tax_number_valid": null,
                          "invoice_workflow_id": null,
                          "estimate_workflow_id": null,
                          "si_identifier": null,
                          "si_identifier_type": null,
                          "moneybird_payments_mandate": false,
                          "created_at": "2026-11-02T12:17:09.849Z",
                          "updated_at": "2026-11-02T12:17:09.849Z",
                          "version": 1793621829,
                          "sales_invoices_url": "https://moneybird.dev/123/sales_invoices/0000000000000000000000000000000000000000000000000000000000000001/all",
                          "notes": [],
                          "custom_fields": [],
                          "contact_people": [],
                          "archived": false
                        },
                        "contact_person_id": null,
                        "contact_person": null,
                        "estimate_id": "2026-0003",
                        "estimate_sequence_id": "0003",
                        "workflow_id": "502689109222884501",
                        "document_style_id": "502689109280556185",
                        "identity_id": "502689108656653419",
                        "draft_id": null,
                        "state": "open",
                        "estimate_date": "2026-11-02",
                        "due_date": "2026-11-16",
                        "reference": "Project X",
                        "language": "nl",
                        "currency": "EUR",
                        "exchange_rate": "1.0",
                        "discount": "0.0",
                        "original_estimate_id": null,
                        "show_tax": true,
                        "sign_online": true,
                        "sent_at": "2026-11-02",
                        "accepted_at": null,
                        "rejected_at": null,
                        "archived_at": null,
                        "created_at": "2026-11-02T12:17:10.031Z",
                        "updated_at": "2026-11-02T12:17:10.064Z",
                        "public_view_code": "557588",
                        "public_view_code_expires_at": "2027-02-02T12:17:10.049Z",
                        "version": 1793621830,
                        "pre_text": "Hello, here is your quote",
                        "post_text": "Please sign it",
                        "details": [
                          {
                            "id": "502689230552565213",
                            "administration_id": 123,
                            "tax_rate_id": "502689108899923082",
                            "ledger_account_id": "502689108787725434",
                            "project_id": null,
                            "product_id": null,
                            "amount": "1 x",
                            "amount_decimal": "1.0",
                            "description": "Project X",
                            "price": "300.0",
                            "period": null,
                            "row_order": 1,
                            "total_price_excl_tax_with_discount": "300.0",
                            "total_price_excl_tax_with_discount_base": "300.0",
                            "tax_report_reference": [
                              "NL/1a"
                            ],
                            "mandatory_tax_text": null,
                            "created_at": "2026-11-02T12:17:10.032Z",
                            "updated_at": "2026-11-02T12:17:10.064Z",
                            "is_optional": false,
                            "is_selected": true
                          }
                        ],
                        "prices_are_incl_tax": false,
                        "total_price_excl_tax": "300.0",
                        "total_price_excl_tax_base": "300.0",
                        "total_price_incl_tax": "363.0",
                        "total_price_incl_tax_base": "363.0",
                        "total_discount": "0.0",
                        "url": "http://moneybird.dev/123/external/0000000000000000000000000000000000000000000000000000000000000001/2b0903406f7cf2010063519851074c04e2e35236232514c5ddb6a34975f60eac/estimate",
                        "custom_fields": [],
                        "notes": [],
                        "attachments": [],
                        "events": [
                          {
                            "administration_id": 123,
                            "user_id": "502689108256097381",
                            "action": "estimate_created",
                            "link_entity_id": null,
                            "link_entity_type": null,
                            "data": {},
                            "created_at": "2026-11-02T12:17:10.035Z",
                            "updated_at": "2026-11-02T12:17:10.035Z"
                          },
                          {
                            "administration_id": 123,
                            "user_id": "502689108256097381",
                            "action": "estimate_send_email",
                            "link_entity_id": null,
                            "link_entity_type": null,
                            "data": {
                              "email_address": "info@example.com",
                              "email_message": "Geachte Foobar Holding B.V.,\n\nHierbij ontvangt u van ons een prijsopgave 2026-0003 voor onze\ndiensten.\n\nMet vriendelijke groet,\n\nParkietje B.V."
                            },
                            "created_at": "2026-11-02T12:17:10.070Z",
                            "updated_at": "2026-11-02T12:17:10.070Z"
                          }
                        ],
                        "tax_totals": [
                          {
                            "tax_rate_id": "502689108899923082",
                            "taxable_amount": "300.0",
                            "taxable_amount_base": "300.0",
                            "tax_amount": "63.0",
                            "tax_amount_base": "63.0"
                          }
                        ]
                      },
                      {
                        "id": "502689230466581976",
                        "administration_id": 123,
                        "contact_id": "502689230360675790",
                        "contact": {
                          "id": "502689230360675790",
                          "administration_id": 123,
                          "company_name": "Foobar Holding B.V.",
                          "firstname": null,
                          "lastname": null,
                          "address1": "Hoofdstraat 12",
                          "address2": null,
                          "zipcode": "1234AB",
                          "city": "Amsterdam",
                          "country": "NL",
                          "phone": null,
                          "delivery_method": "Email",
                          "customer_id": "customer-1",
                          "tax_number": null,
                          "chamber_of_commerce": null,
                          "bank_account": null,
                          "is_trusted": false,
                          "max_transfer_amount": null,
                          "attention": null,
                          "email": "info@example.com",
                          "email_ubl": true,
                          "send_invoices_to_attention": null,
                          "send_invoices_to_email": "info@example.com",
                          "send_estimates_to_attention": null,
                          "send_estimates_to_email": "info@example.com",
                          "direct_debit": false,
                          "sepa_active": false,
                          "sepa_iban": null,
                          "sepa_iban_account_name": null,
                          "sepa_bic": null,
                          "sepa_mandate_id": null,
                          "sepa_mandate_date": null,
                          "sepa_sequence_type": "RCUR",
                          "credit_card_number": null,
                          "credit_card_reference": null,
                          "credit_card_type": null,
                          "tax_number_validated_at": null,
                          "tax_number_valid": null,
                          "invoice_workflow_id": null,
                          "estimate_workflow_id": null,
                          "si_identifier": null,
                          "si_identifier_type": null,
                          "moneybird_payments_mandate": false,
                          "created_at": "2026-11-02T12:17:09.849Z",
                          "updated_at": "2026-11-02T12:17:09.849Z",
                          "version": 1793621829,
                          "sales_invoices_url": "https://moneybird.dev/123/sales_invoices/0000000000000000000000000000000000000000000000000000000000000001/all",
                          "notes": [],
                          "custom_fields": [],
                          "contact_people": [],
                          "archived": false
                        },
                        "contact_person_id": null,
                        "contact_person": null,
                        "estimate_id": "2026-0002",
                        "estimate_sequence_id": "0002",
                        "workflow_id": "502689109222884501",
                        "document_style_id": "502689109280556185",
                        "identity_id": "502689108656653419",
                        "draft_id": null,
                        "state": "open",
                        "estimate_date": "2026-11-02",
                        "due_date": "2026-11-16",
                        "reference": "Project X",
                        "language": "nl",
                        "currency": "EUR",
                        "exchange_rate": "1.0",
                        "discount": "0.0",
                        "original_estimate_id": null,
                        "show_tax": true,
                        "sign_online": true,
                        "sent_at": "2026-11-02",
                        "accepted_at": null,
                        "rejected_at": null,
                        "archived_at": null,
                        "created_at": "2026-11-02T12:17:09.951Z",
                        "updated_at": "2026-11-02T12:17:10.001Z",
                        "public_view_code": "351548",
                        "public_view_code_expires_at": "2027-02-02T12:17:09.982Z",
                        "version": 1793621830,
                        "pre_text": "Hello, here is your quote",
                        "post_text": "Please sign it",
                        "details": [
                          {
                            "id": "502689230468679129",
                            "administration_id": 123,
                            "tax_rate_id": "502689108899923082",
                            "ledger_account_id": "502689108787725434",
                            "project_id": null,
                            "product_id": null,
                            "amount": "1 x",
                            "amount_decimal": "1.0",
                            "description": "Project X",
                            "price": "300.0",
                            "period": null,
                            "row_order": 1,
                            "total_price_excl_tax_with_discount": "300.0",
                            "total_price_excl_tax_with_discount_base": "300.0",
                            "tax_report_reference": [
                              "NL/1a"
                            ],
                            "mandatory_tax_text": null,
                            "created_at": "2026-11-02T12:17:09.952Z",
                            "updated_at": "2026-11-02T12:17:10.000Z",
                            "is_optional": false,
                            "is_selected": true
                          }
                        ],
                        "prices_are_incl_tax": false,
                        "total_price_excl_tax": "300.0",
                        "total_price_excl_tax_base": "300.0",
                        "total_price_incl_tax": "363.0",
                        "total_price_incl_tax_base": "363.0",
                        "total_discount": "0.0",
                        "url": "http://moneybird.dev/123/external/0000000000000000000000000000000000000000000000000000000000000001/658292982c29a5904fc83d87f81fda785bbd837a2562392f78784082e735ed06/estimate",
                        "custom_fields": [],
                        "notes": [],
                        "attachments": [],
                        "events": [
                          {
                            "administration_id": 123,
                            "user_id": "502689108256097381",
                            "action": "estimate_created",
                            "link_entity_id": null,
                            "link_entity_type": null,
                            "data": {},
                            "created_at": "2026-11-02T12:17:09.956Z",
                            "updated_at": "2026-11-02T12:17:09.956Z"
                          },
                          {
                            "administration_id": 123,
                            "user_id": "502689108256097381",
                            "action": "estimate_send_email",
                            "link_entity_id": null,
                            "link_entity_type": null,
                            "data": {
                              "email_address": "info@example.com",
                              "email_message": "Geachte Foobar Holding B.V.,\n\nHierbij ontvangt u van ons een prijsopgave 2026-0002 voor onze\ndiensten.\n\nMet vriendelijke groet,\n\nParkietje B.V."
                            },
                            "created_at": "2026-11-02T12:17:10.007Z",
                            "updated_at": "2026-11-02T12:17:10.007Z"
                          }
                        ],
                        "tax_totals": [
                          {
                            "tax_rate_id": "502689108899923082",
                            "taxable_amount": "300.0",
                            "taxable_amount_base": "300.0",
                            "tax_amount": "63.0",
                            "tax_amount_base": "63.0"
                          }
                        ]
                      },
                      {
                        "id": "502689230391084499",
                        "administration_id": 123,
                        "contact_id": "502689230360675790",
                        "contact": {
                          "id": "502689230360675790",
                          "administration_id": 123,
                          "company_name": "Foobar Holding B.V.",
                          "firstname": null,
                          "lastname": null,
                          "address1": "Hoofdstraat 12",
                          "address2": null,
                          "zipcode": "1234AB",
                          "city": "Amsterdam",
                          "country": "NL",
                          "phone": null,
                          "delivery_method": "Email",
                          "customer_id": "customer-1",
                          "tax_number": null,
                          "chamber_of_commerce": null,
                          "bank_account": null,
                          "is_trusted": false,
                          "max_transfer_amount": null,
                          "attention": null,
                          "email": "info@example.com",
                          "email_ubl": true,
                          "send_invoices_to_attention": null,
                          "send_invoices_to_email": "info@example.com",
                          "send_estimates_to_attention": null,
                          "send_estimates_to_email": "info@example.com",
                          "direct_debit": false,
                          "sepa_active": false,
                          "sepa_iban": null,
                          "sepa_iban_account_name": null,
                          "sepa_bic": null,
                          "sepa_mandate_id": null,
                          "sepa_mandate_date": null,
                          "sepa_sequence_type": "RCUR",
                          "credit_card_number": null,
                          "credit_card_reference": null,
                          "credit_card_type": null,
                          "tax_number_validated_at": null,
                          "tax_number_valid": null,
                          "invoice_workflow_id": null,
                          "estimate_workflow_id": null,
                          "si_identifier": null,
                          "si_identifier_type": null,
                          "moneybird_payments_mandate": false,
                          "created_at": "2026-11-02T12:17:09.849Z",
                          "updated_at": "2026-11-02T12:17:09.849Z",
                          "version": 1793621829,
                          "sales_invoices_url": "https://moneybird.dev/123/sales_invoices/0000000000000000000000000000000000000000000000000000000000000001/all",
                          "notes": [],
                          "custom_fields": [],
                          "contact_people": [],
                          "archived": false
                        },
                        "contact_person_id": "502689230364870096",
                        "contact_person": {
                          "id": null,
                          "contact_id": "502689230360675790",
                          "administration_id": 123,
                          "firstname": "Jan",
                          "lastname": "Janssen",
                          "phone": "123-456-2346",
                          "email": "janjanssen@dev.null.moneybird.net",
                          "department": "Sales",
                          "created_at": "2026-11-02T12:17:09.853Z",
                          "updated_at": "2026-11-02T12:17:09.853Z",
                          "version": 1793621829
                        },
                        "estimate_id": "2026-0001",
                        "estimate_sequence_id": "0001",
                        "workflow_id": "502689109222884501",
                        "document_style_id": "502689109280556185",
                        "identity_id": "502689108656653419",
                        "draft_id": null,
                        "state": "open",
                        "estimate_date": "2026-11-02",
                        "due_date": "2026-11-16",
                        "reference": "Project X",
                        "language": "nl",
                        "currency": "EUR",
                        "exchange_rate": "1.0",
                        "discount": "0.0",
                        "original_estimate_id": null,
                        "show_tax": true,
                        "sign_online": true,
                        "sent_at": "2026-11-02",
                        "accepted_at": null,
                        "rejected_at": null,
                        "archived_at": null,
                        "created_at": "2026-11-02T12:17:09.878Z",
                        "updated_at": "2026-11-02T12:17:09.919Z",
                        "public_view_code": "085823",
                        "public_view_code_expires_at": "2027-02-02T12:17:09.900Z",
                        "version": 1793621829,
                        "pre_text": "Hello, here is your quote",
                        "post_text": "Please sign it",
                        "details": [
                          {
                            "id": "502689230393181652",
                            "administration_id": 123,
                            "tax_rate_id": "502689108899923082",
                            "ledger_account_id": "502689108787725434",
                            "project_id": null,
                            "product_id": null,
                            "amount": "1 x",
                            "amount_decimal": "1.0",
                            "description": "Project X",
                            "price": "300.0",
                            "period": null,
                            "row_order": 1,
                            "total_price_excl_tax_with_discount": "300.0",
                            "total_price_excl_tax_with_discount_base": "300.0",
                            "tax_report_reference": [
                              "NL/1a"
                            ],
                            "mandatory_tax_text": null,
                            "created_at": "2026-11-02T12:17:09.881Z",
                            "updated_at": "2026-11-02T12:17:09.918Z",
                            "is_optional": false,
                            "is_selected": true
                          }
                        ],
                        "prices_are_incl_tax": false,
                        "total_price_excl_tax": "300.0",
                        "total_price_excl_tax_base": "300.0",
                        "total_price_incl_tax": "363.0",
                        "total_price_incl_tax_base": "363.0",
                        "total_discount": "0.0",
                        "url": "http://moneybird.dev/123/external/0000000000000000000000000000000000000000000000000000000000000001/99b26596f1733174badff8b8bdf198e893bafc7044622641272f6a3ab8ff2766/estimate",
                        "custom_fields": [],
                        "notes": [],
                        "attachments": [],
                        "events": [
                          {
                            "administration_id": 123,
                            "user_id": "502689108256097381",
                            "action": "estimate_created",
                            "link_entity_id": null,
                            "link_entity_type": null,
                            "data": {},
                            "created_at": "2026-11-02T12:17:09.885Z",
                            "updated_at": "2026-11-02T12:17:09.885Z"
                          },
                          {
                            "administration_id": 123,
                            "user_id": "502689108256097381",
                            "action": "estimate_send_email",
                            "link_entity_id": null,
                            "link_entity_type": null,
                            "data": {
                              "email_address": "info@example.com; janjanssen@dev.null.moneybird.net",
                              "email_message": "Geachte Jan Janssen,\n\nHierbij ontvangt u van ons een prijsopgave 2026-0001 voor onze\ndiensten.\n\nMet vriendelijke groet,\n\nParkietje B.V."
                            },
                            "created_at": "2026-11-02T12:17:09.924Z",
                            "updated_at": "2026-11-02T12:17:09.924Z"
                          }
                        ],
                        "tax_totals": [
                          {
                            "tax_rate_id": "502689108899923082",
                            "taxable_amount": "300.0",
                            "taxable_amount_base": "300.0",
                            "tax_amount": "63.0",
                            "tax_amount_base": "63.0"
                          }
                        ]
                      }
                    ]
                  }
                }
              }
            }
          },
          "400": {
            "description": "Bad request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/symbolic_error"
                },
                "examples": {
                  "ReturnsAnErrorWhenTooManyEstimatesAreRequested": {
                    "summary": "Returns an error when too many estimates are requested",
                    "value": {
                      "error": "per_page does not have a valid value"
                    }
                  }
                }
              }
            }
          }
        },
        "operationId": "get_administration_id_estimates"
      },
      "post": {
        "summary": "Creates a new estimate",
        "description": "Creates a new estimate.\n\n### Required scope(s)\n `estimates`",
        "tags": [
          "Estimates"
        ],
        "security": [
          {
            "bearerAuth": [
              "estimates"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/administration_id"
          },
          {
            "$ref": "#/components/parameters/format"
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/*": {
              "schema": {
                "unevaluatedProperties": false,
                "type": "object",
                "properties": {
                  "estimate": {
                    "type": "object",
                    "unevaluatedProperties": false,
                    "properties": {
                      "contact_id": {
                        "$ref": "#/components/schemas/identifier",
                        "description": "Should be a valid contact id."
                      },
                      "contact_person_id": {
                        "$ref": "#/components/schemas/identifier",
                        "description": "Should be a valid contact person id."
                      },
                      "document_style_id": {
                        "$ref": "#/components/schemas/identifier",
                        "description": "Default document style is used when value is not provided. Should be a valid document style id."
                      },
                      "workflow_id": {
                        "$ref": "#/components/schemas/identifier",
                        "description": "If value is not provided, the workflow saved in the contact is used. If the contact doesn't have a default workflow, the administration's default workflow is used. Should be a valid workflow id."
                      },
                      "reference": {
                        "type": "string",
                        "description": "Your own reference for this estimate, e.g. a project code or PO number. Visible to the recipient."
                      },
                      "estimate_date": {
                        "type": "string",
                        "description": "The date of the estimate. Defaults to the current date.",
                        "format": "date"
                      },
                      "estimate_sequence_id": {
                        "type": [
                          "string",
                          "integer"
                        ],
                        "description": "The sequence number that is put in the estimate number template, e.g. `0042`. If not provided, the next number in the sequence is used when the estimate is sent."
                      },
                      "language": {
                        "type": "string",
                        "description": "Can be `bg`, `cs`, `da`, `de`, `el`, `en`, `es`, `fr`, `hr`, `hu`, `it`, `no`, `nl`, `nl-be`, `pl`, `pt`, `ro`, `sv`, `tr` or `uk`."
                      },
                      "currency": {
                        "type": "string",
                        "description": "ISO three-character currency code, e.g. EUR or USD. Defaults to the workflow's currency."
                      },
                      "prices_are_incl_tax": {
                        "type": [
                          "boolean",
                          "string"
                        ],
                        "description": "Whether the prices on the estimate are inclusive of tax. Defaults to the workflow's setting."
                      },
                      "show_tax": {
                        "type": [
                          "boolean",
                          "string"
                        ],
                        "description": "Whether to show tax amounts on the estimate. Useful for non-VAT registered businesses or tax-exempt clients. Defaults to the workflow's setting."
                      },
                      "first_due_interval": {
                        "type": [
                          "integer",
                          "string"
                        ],
                        "description": "The number of days after the estimate date before the estimate expires. Defaults to the first workflow step's due interval."
                      },
                      "pre_text": {
                        "type": "string",
                        "description": "Introductory text displayed above the details on the estimate document. Defaults to the workflow's pre-text."
                      },
                      "post_text": {
                        "type": "string",
                        "description": "Closing text displayed below the details on the estimate document. Defaults to the workflow's post-text."
                      },
                      "discount": {
                        "$ref": "#/components/schemas/number",
                        "description": "Discount percentage, e.g. 10,0%. Should be a number 0 <= *n* <= 100."
                      },
                      "original_sales_invoice_id": {
                        "$ref": "#/components/schemas/identifier",
                        "description": "The ID of the sales invoice this estimate was created from (e.g. for credit notes or revised estimates)."
                      },
                      "details_attributes": {
                        "$ref": "#/components/schemas/details_attributes"
                      },
                      "custom_fields_attributes": {
                        "$ref": "#/components/schemas/custom_fields_attributes"
                      }
                    },
                    "required": []
                  }
                },
                "required": []
              },
              "examples": {
                "CreatesANewEstimate": {
                  "summary": "Creates a new estimate",
                  "value": {
                    "estimate": {
                      "contact_id": 502689231597995500,
                      "reference": "Estimate Reference"
                    }
                  }
                }
              }
            }
          }
        },
        "responses": {
          "201": {
            "description": "Estimate created",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/estimate_response"
                },
                "examples": {
                  "CreatesANewEstimate": {
                    "summary": "Creates a new estimate",
                    "value": {
                      "id": "502689231713338907",
                      "administration_id": 123,
                      "contact_id": "502689231597995537",
                      "contact": {
                        "id": "502689231597995537",
                        "administration_id": 123,
                        "company_name": "Foobar Holding B.V.",
                        "firstname": null,
                        "lastname": null,
                        "address1": "Hoofdstraat 12",
                        "address2": null,
                        "zipcode": "1234AB",
                        "city": "Amsterdam",
                        "country": "NL",
                        "phone": null,
                        "delivery_method": "Email",
                        "customer_id": "customer-1",
                        "tax_number": null,
                        "chamber_of_commerce": null,
                        "bank_account": null,
                        "is_trusted": false,
                        "max_transfer_amount": null,
                        "attention": null,
                        "email": "info@example.com",
                        "email_ubl": true,
                        "send_invoices_to_attention": null,
                        "send_invoices_to_email": "info@example.com",
                        "send_estimates_to_attention": null,
                        "send_estimates_to_email": "info@example.com",
                        "direct_debit": false,
                        "sepa_active": false,
                        "sepa_iban": null,
                        "sepa_iban_account_name": null,
                        "sepa_bic": null,
                        "sepa_mandate_id": null,
                        "sepa_mandate_date": null,
                        "sepa_sequence_type": "RCUR",
                        "credit_card_number": null,
                        "credit_card_reference": null,
                        "credit_card_type": null,
                        "tax_number_validated_at": null,
                        "tax_number_valid": null,
                        "invoice_workflow_id": null,
                        "estimate_workflow_id": null,
                        "si_identifier": null,
                        "si_identifier_type": null,
                        "moneybird_payments_mandate": false,
                        "created_at": "2026-11-02T12:17:11.029Z",
                        "updated_at": "2026-11-02T12:17:11.029Z",
                        "version": 1793621831,
                        "sales_invoices_url": "https://moneybird.dev/123/sales_invoices/0000000000000000000000000000000000000000000000000000000000000001/all",
                        "notes": [],
                        "custom_fields": [],
                        "contact_people": [
                          {
                            "id": "502689231601141267",
                            "contact_id": "502689231597995537",
                            "administration_id": 123,
                            "firstname": "Jan",
                            "lastname": "Janssen",
                            "phone": "123-456-2346",
                            "email": "janjanssen@dev.null.moneybird.net",
                            "department": "Sales",
                            "created_at": "2026-11-02T12:17:11.033Z",
                            "updated_at": "2026-11-02T12:17:11.033Z",
                            "version": 1793621831
                          }
                        ],
                        "archived": false
                      },
                      "contact_person_id": null,
                      "contact_person": null,
                      "estimate_id": null,
                      "estimate_sequence_id": null,
                      "workflow_id": "502689109222884501",
                      "document_style_id": "502689109280556185",
                      "identity_id": "502689108656653419",
                      "draft_id": 2,
                      "state": "draft",
                      "estimate_date": null,
                      "due_date": "2026-11-16",
                      "reference": "Estimate Reference",
                      "language": "nl",
                      "currency": "EUR",
                      "exchange_rate": "1.0",
                      "discount": "0.0",
                      "original_estimate_id": null,
                      "show_tax": true,
                      "sign_online": true,
                      "sent_at": null,
                      "accepted_at": null,
                      "rejected_at": null,
                      "archived_at": null,
                      "created_at": "2026-11-02T12:17:11.140Z",
                      "updated_at": "2026-11-02T12:17:11.140Z",
                      "public_view_code": null,
                      "public_view_code_expires_at": null,
                      "version": 1793621831,
                      "pre_text": "Geachte {recipient.name},\n\nHierbij ontvangt u van ons de prijsopgave {document.estimate_id} voor de onderstaande diensten.",
                      "post_text": "We hopen u hiermee voldoende geïnformeerd te hebben.\n\nMet vriendelijke groet,\n\n{company.company_name}",
                      "details": [],
                      "prices_are_incl_tax": false,
                      "total_price_excl_tax": "0.0",
                      "total_price_excl_tax_base": "0.0",
                      "total_price_incl_tax": "0.0",
                      "total_price_incl_tax_base": "0.0",
                      "total_discount": 0,
                      "url": "http://moneybird.dev/123/external/0000000000000000000000000000000000000000000000000000000000000001/66bd9992fe2d2c42f355d021c0820ebb0b9128dc2827b7d2b2a0e49fd4f54981/estimate",
                      "custom_fields": [],
                      "notes": [],
                      "attachments": [],
                      "events": [
                        {
                          "administration_id": 123,
                          "user_id": "502689108256097381",
                          "action": "estimate_created",
                          "link_entity_id": null,
                          "link_entity_type": null,
                          "data": {},
                          "created_at": "2026-11-02T12:17:11.143Z",
                          "updated_at": "2026-11-02T12:17:11.143Z"
                        }
                      ],
                      "tax_totals": []
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "Bad request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/symbolic_error"
                },
                "examples": {
                  "Returns400IfTheCreationIsInvalid": {
                    "summary": "Returns 400 if the creation is invalid",
                    "value": {
                      "error": "Estimate can't be nil",
                      "symbolic": {
                        "estimate": "nils"
                      }
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "Unprocessable entity",
            "content": {
              "application/json": {
                "schema": {
                  "anyOf": [
                    {
                      "$ref": "#/components/schemas/symbolic_error"
                    },
                    {
                      "$ref": "#/components/schemas/non_symbolic_error"
                    }
                  ]
                },
                "examples": {
                  "Returns422IfTheCreationIsInvalid": {
                    "summary": "Returns 422 if the creation is invalid",
                    "value": {
                      "error": {
                        "contact_id": [
                          "can't be blank"
                        ],
                        "language": [
                          "is not included in the list"
                        ]
                      },
                      "details": {
                        "contact_id": [
                          {
                            "error": "blank"
                          }
                        ],
                        "language": [
                          {
                            "error": "inclusion",
                            "value": "abracadabra"
                          }
                        ]
                      }
                    }
                  }
                }
              }
            }
          }
        },
        "operationId": "post_administration_id_estimates"
      }
    },
    "/{administration_id}/external_sales_invoices/attachment{format}": {
      "post": {
        "summary": "Create external sales invoice from attachment",
        "description": "Creates an external sales invoice from an attachment.\n\n### Required scope(s)\n `sales_invoices`",
        "tags": [
          "External sales invoices"
        ],
        "security": [
          {
            "bearerAuth": [
              "sales_invoices"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/administration_id"
          },
          {
            "$ref": "#/components/parameters/format"
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "multipart/form-data": {
              "schema": {
                "type": "object",
                "properties": {
                  "file": {
                    "type": "string",
                    "format": "binary"
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "$ref": "#/components/responses/status_code"
          },
          "400": {
            "$ref": "#/components/responses/400_bad_request"
          }
        },
        "operationId": "post_administration_id_external_sales_invoices_attachment"
      }
    },
    "/{administration_id}/external_sales_invoices/synchronization{format}": {
      "get": {
        "summary": "List all ids and versions",
        "description": "Returns the external sales invoices that match the filter. The list contains the id and the version of the external sales invoice.\nCheck if the version of an external sales invoice is newer than the version you have stored locally, use the `POST`\nvariant for fetching external sales invoices with the given ids.\n\n### Required scope(s)\n `sales_invoices`",
        "tags": [
          "External sales invoices"
        ],
        "security": [
          {
            "bearerAuth": [
              "sales_invoices"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/administration_id"
          },
          {
            "$ref": "#/components/parameters/format"
          },
          {
            "name": "filter",
            "in": "query",
            "required": false,
            "description": "Filters are `key:value` terms separated by commas (e.g. `period:this_year,state:all`). Any filter you pass replaces the defaults below entirely, so include every key you need. Available filters:\n\n| **Filter** | **Type** | **Default** | **Description** |\n| --- | --- | --- | --- |\n| state | `String` | `all` | `all`, `new`, `open`, `late`, `paid`, or `uncollectible` |\n| period | `String` | `this_year` | This can either be the description of a period (`this_week`, `prev_week`, `next_week`, `this_month`, `prev_month`, `next_month`, `this_quarter`, `prev_quarter`, `next_quarter`, `this_year`, `prev_year`, `next_year`) or a custom period (`201301..201302`, `20130101..20130131`). A custom period must have a start and an end date. It must not be longer than 10 years and must be between `20000101` and `21000101`. For one month, use `202401..202401`, not `202401`. Without `period`, the filter does not limit the dates. The default `this_year` applies only when you send no `filter`. |\n| contact_id | `Integer` | | Select invoices belonging to a certain contact |\n\nYou can filter by multiple states at the same time as well. To do this, separate the state values by a pipe: `state:new|open`.",
            "schema": {
              "type": "string",
              "default": "period:this_year"
            },
            "examples": {
              "RetrievesTheIdsForSynchronizationWithAFilter": {
                "summary": "Retrieves the ids for synchronization with a filter",
                "value": "state:open"
              }
            }
          }
        ],
        "responses": {
          "200": {
            "description": "IDs and versions of records",
            "content": {
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "type": "object",
                    "unevaluatedProperties": false,
                    "properties": {
                      "id": {
                        "type": [
                          "integer",
                          "string"
                        ]
                      },
                      "version": {
                        "type": [
                          "integer",
                          "string"
                        ]
                      }
                    }
                  }
                },
                "examples": {
                  "RetrievesTheIdsForSynchronizationWithAFilter": {
                    "summary": "Retrieves the ids for synchronization with a filter",
                    "value": [
                      {
                        "id": "502689271291839539",
                        "version": 1793621868
                      },
                      {
                        "id": "502689271310713911",
                        "version": 1793621868
                      },
                      {
                        "id": "502689271325393979",
                        "version": 1793621868
                      }
                    ]
                  },
                  "RetrievesTheIdsForSynchronization": {
                    "summary": "Retrieves the ids for synchronization",
                    "value": [
                      {
                        "id": "502689271363142720",
                        "version": 1793621868
                      },
                      {
                        "id": "502689271375725636",
                        "version": 1793621868
                      },
                      {
                        "id": "502689271387259976",
                        "version": 1793621868
                      },
                      {
                        "id": "502689271391454282",
                        "version": 1793621868
                      }
                    ]
                  }
                }
              }
            }
          }
        },
        "operationId": "get_administration_id_external_sales_invoices_synchronization"
      },
      "post": {
        "summary": "Fetch external sales invoices with given ids",
        "x-query": true,
        "description": "Given a list of external sales invoice ids, returns the external sales invoice information belonging to the external sales invoice.\nReturns a maximum of 100 external sales invoices, even if more ids are provided.\n\n### Required scope(s)\n `sales_invoices`",
        "tags": [
          "External sales invoices"
        ],
        "security": [
          {
            "bearerAuth": [
              "sales_invoices"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/administration_id"
          },
          {
            "$ref": "#/components/parameters/format"
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/*": {
              "schema": {
                "unevaluatedProperties": false,
                "type": "object",
                "properties": {
                  "ids": {
                    "type": "array",
                    "items": {
                      "type": [
                        "integer",
                        "string"
                      ]
                    }
                  }
                },
                "required": [
                  "ids"
                ]
              },
              "examples": {
                "RetrievesSalesInvoicesGivenByIds": {
                  "summary": "Retrieves sales invoices given by ids",
                  "value": {
                    "ids": [
                      502689271086318600,
                      502689271100998660
                    ]
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "A list of external sales invoices",
            "content": {
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "$ref": "#/components/schemas/external_sales_invoice_response"
                  }
                },
                "examples": {
                  "RetrievesSalesInvoicesGivenByIds": {
                    "summary": "Retrieves sales invoices given by ids",
                    "value": [
                      {
                        "id": "502689271100998676",
                        "administration_id": 123,
                        "contact_id": "502689271094707219",
                        "contact": {
                          "id": "502689271094707219",
                          "administration_id": 123,
                          "company_name": "Relation 3",
                          "firstname": null,
                          "lastname": null,
                          "address1": null,
                          "address2": null,
                          "zipcode": null,
                          "city": null,
                          "country": "NL",
                          "phone": null,
                          "delivery_method": "Email",
                          "customer_id": "customer-3",
                          "tax_number": null,
                          "chamber_of_commerce": null,
                          "bank_account": null,
                          "is_trusted": false,
                          "max_transfer_amount": null,
                          "attention": null,
                          "email": "invoices@example.com",
                          "email_ubl": false,
                          "send_invoices_to_attention": null,
                          "send_invoices_to_email": "invoices@example.com",
                          "send_estimates_to_attention": null,
                          "send_estimates_to_email": "estimates@example.com",
                          "direct_debit": false,
                          "sepa_active": false,
                          "sepa_iban": null,
                          "sepa_iban_account_name": null,
                          "sepa_bic": null,
                          "sepa_mandate_id": null,
                          "sepa_mandate_date": null,
                          "sepa_sequence_type": "RCUR",
                          "credit_card_number": null,
                          "credit_card_reference": null,
                          "credit_card_type": null,
                          "tax_number_validated_at": null,
                          "tax_number_valid": null,
                          "invoice_workflow_id": null,
                          "estimate_workflow_id": null,
                          "si_identifier": null,
                          "si_identifier_type": null,
                          "moneybird_payments_mandate": false,
                          "created_at": "2026-11-02T12:17:48.697Z",
                          "updated_at": "2026-11-02T12:17:48.697Z",
                          "version": 1793621868,
                          "sales_invoices_url": "https://moneybird.dev/123/sales_invoices/0000000000000000000000000000000000000000000000000000000000000003/all",
                          "notes": [],
                          "custom_fields": [],
                          "contact_people": [],
                          "archived": false
                        },
                        "date": "2026-11-02",
                        "state": "open",
                        "due_date": null,
                        "reference": "Invoice 3",
                        "entry_number": 103,
                        "origin": null,
                        "source": null,
                        "source_url": null,
                        "currency": "EUR",
                        "paid_at": null,
                        "created_at": "2026-11-02T12:17:48.703Z",
                        "updated_at": "2026-11-02T12:17:48.705Z",
                        "version": 1793621868,
                        "details": [
                          {
                            "id": "502689271103095829",
                            "administration_id": 123,
                            "tax_rate_id": "502689108899923082",
                            "ledger_account_id": "502689108787725434",
                            "project_id": null,
                            "product_id": null,
                            "amount": "1 x",
                            "amount_decimal": "1.0",
                            "description": "Invoice detail description",
                            "price": "100.0",
                            "period": null,
                            "row_order": 0,
                            "total_price_excl_tax_with_discount": "100.0",
                            "total_price_excl_tax_with_discount_base": "100.0",
                            "tax_report_reference": [],
                            "mandatory_tax_text": null,
                            "created_at": "2026-11-02T12:17:48.704Z",
                            "updated_at": "2026-11-02T12:17:48.704Z"
                          }
                        ],
                        "payments": [],
                        "total_paid": "0.0",
                        "total_unpaid": "121.0",
                        "total_unpaid_base": "121.0",
                        "prices_are_incl_tax": false,
                        "total_price_excl_tax": "100.0",
                        "total_price_excl_tax_base": "100.0",
                        "total_price_incl_tax": "121.0",
                        "total_price_incl_tax_base": "121.0",
                        "marked_dubious_on": null,
                        "marked_uncollectible_on": null,
                        "notes": [],
                        "attachments": [],
                        "events": [],
                        "tax_totals": [
                          {
                            "tax_rate_id": "502689108899923082",
                            "taxable_amount": "100.0",
                            "taxable_amount_base": "100.0",
                            "tax_amount": "21.0",
                            "tax_amount_base": "21.0"
                          }
                        ]
                      },
                      {
                        "id": "502689271086318608",
                        "administration_id": 123,
                        "contact_id": "502689271077929999",
                        "contact": {
                          "id": "502689271077929999",
                          "administration_id": 123,
                          "company_name": "Relation 2",
                          "firstname": null,
                          "lastname": null,
                          "address1": null,
                          "address2": null,
                          "zipcode": null,
                          "city": null,
                          "country": "NL",
                          "phone": null,
                          "delivery_method": "Email",
                          "customer_id": "customer-2",
                          "tax_number": null,
                          "chamber_of_commerce": null,
                          "bank_account": null,
                          "is_trusted": false,
                          "max_transfer_amount": null,
                          "attention": null,
                          "email": "invoices@example.com",
                          "email_ubl": false,
                          "send_invoices_to_attention": null,
                          "send_invoices_to_email": "invoices@example.com",
                          "send_estimates_to_attention": null,
                          "send_estimates_to_email": "estimates@example.com",
                          "direct_debit": false,
                          "sepa_active": false,
                          "sepa_iban": null,
                          "sepa_iban_account_name": null,
                          "sepa_bic": null,
                          "sepa_mandate_id": null,
                          "sepa_mandate_date": null,
                          "sepa_sequence_type": "RCUR",
                          "credit_card_number": null,
                          "credit_card_reference": null,
                          "credit_card_type": null,
                          "tax_number_validated_at": null,
                          "tax_number_valid": null,
                          "invoice_workflow_id": null,
                          "estimate_workflow_id": null,
                          "si_identifier": null,
                          "si_identifier_type": null,
                          "moneybird_payments_mandate": false,
                          "created_at": "2026-11-02T12:17:48.680Z",
                          "updated_at": "2026-11-02T12:17:48.680Z",
                          "version": 1793621868,
                          "sales_invoices_url": "https://moneybird.dev/123/sales_invoices/0000000000000000000000000000000000000000000000000000000000000002/all",
                          "notes": [],
                          "custom_fields": [],
                          "contact_people": [],
                          "archived": false
                        },
                        "date": "2026-11-02",
                        "state": "open",
                        "due_date": null,
                        "reference": "Invoice 2",
                        "entry_number": 102,
                        "origin": null,
                        "source": null,
                        "source_url": null,
                        "currency": "EUR",
                        "paid_at": null,
                        "created_at": "2026-11-02T12:17:48.688Z",
                        "updated_at": "2026-11-02T12:17:48.691Z",
                        "version": 1793621868,
                        "details": [
                          {
                            "id": "502689271087367185",
                            "administration_id": 123,
                            "tax_rate_id": "502689108899923082",
                            "ledger_account_id": "502689108787725434",
                            "project_id": null,
                            "product_id": null,
                            "amount": "1 x",
                            "amount_decimal": "1.0",
                            "description": "Invoice detail description",
                            "price": "100.0",
                            "period": null,
                            "row_order": 0,
                            "total_price_excl_tax_with_discount": "100.0",
                            "total_price_excl_tax_with_discount_base": "100.0",
                            "tax_report_reference": [],
                            "mandatory_tax_text": null,
                            "created_at": "2026-11-02T12:17:48.690Z",
                            "updated_at": "2026-11-02T12:17:48.690Z"
                          }
                        ],
                        "payments": [],
                        "total_paid": "0.0",
                        "total_unpaid": "121.0",
                        "total_unpaid_base": "121.0",
                        "prices_are_incl_tax": false,
                        "total_price_excl_tax": "100.0",
                        "total_price_excl_tax_base": "100.0",
                        "total_price_incl_tax": "121.0",
                        "total_price_incl_tax_base": "121.0",
                        "marked_dubious_on": null,
                        "marked_uncollectible_on": null,
                        "notes": [],
                        "attachments": [],
                        "events": [],
                        "tax_totals": [
                          {
                            "tax_rate_id": "502689108899923082",
                            "taxable_amount": "100.0",
                            "taxable_amount_base": "100.0",
                            "tax_amount": "21.0",
                            "tax_amount_base": "21.0"
                          }
                        ]
                      }
                    ]
                  }
                }
              }
            }
          },
          "400": {
            "$ref": "#/components/responses/400_bad_request"
          }
        },
        "operationId": "post_administration_id_external_sales_invoices_synchronization"
      }
    },
    "/{administration_id}/external_sales_invoices/{external_sales_invoice_id}/attachments/{id}/download{format}": {
      "get": {
        "summary": "Download attachment",
        "description": "Download the attachment. The response will be a redirect to a temporarily available URL\nwhere the attachment can be downloaded. Use the `Location` header in the response\nto download the attachment.\n\n### Required scope(s)\n `sales_invoices`",
        "tags": [
          "External sales invoices"
        ],
        "security": [
          {
            "bearerAuth": [
              "sales_invoices"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/administration_id"
          },
          {
            "name": "external_sales_invoice_id",
            "in": "path",
            "required": true,
            "schema": {
              "$ref": "#/components/schemas/identifier"
            }
          },
          {
            "name": "id",
            "in": "path",
            "required": true,
            "schema": {
              "$ref": "#/components/schemas/identifier"
            }
          },
          {
            "$ref": "#/components/parameters/format"
          }
        ],
        "responses": {
          "302": {
            "description": "Found",
            "content": {
              "text/plain": {
                "schema": {
                  "type": "string"
                },
                "examples": {
                  "DownloadsTheAttachment": {
                    "summary": "Downloads the attachment",
                    "value": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<hash>\n  <message>Use the Location header to download the attachment</message>\n</hash>\n"
                  }
                }
              }
            }
          },
          "404": {
            "description": "Not found",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/symbolic_error"
                },
                "examples": {
                  "Returns404WhenTheAttachmentDoesNotExist": {
                    "summary": "Returns 404 when the attachment does not exist",
                    "value": {
                      "error": "Record not found for model name: Attachment"
                    }
                  }
                }
              }
            }
          }
        },
        "operationId": "get_administration_id_external_sales_invoices_external_sales_invoice_id_attachments_id_download"
      }
    },
    "/{administration_id}/external_sales_invoices/{external_sales_invoice_id}/attachments/{id}{format}": {
      "delete": {
        "summary": "Delete an attachment",
        "description": "Deletes an attachment of an attachable.\n\n### Required scope(s)\n `sales_invoices`",
        "tags": [
          "External sales invoices"
        ],
        "security": [
          {
            "bearerAuth": [
              "sales_invoices"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/administration_id"
          },
          {
            "name": "external_sales_invoice_id",
            "in": "path",
            "required": true,
            "schema": {
              "$ref": "#/components/schemas/identifier"
            }
          },
          {
            "name": "id",
            "in": "path",
            "required": true,
            "schema": {
              "$ref": "#/components/schemas/identifier"
            }
          },
          {
            "$ref": "#/components/parameters/format"
          }
        ],
        "responses": {
          "204": {
            "description": "Attachment deleted"
          },
          "404": {
            "$ref": "#/components/responses/404_not_found"
          }
        },
        "operationId": "delete_administration_id_external_sales_invoices_external_sales_invoice_id_attachments_id"
      }
    },
    "/{administration_id}/external_sales_invoices/{external_sales_invoice_id}/notes/{id}{format}": {
      "delete": {
        "summary": "Destroys note from entity",
        "description": "Deletes a note from the external sales invoice\n\n### Required scope(s)\n `sales_invoices`",
        "tags": [
          "External sales invoices"
        ],
        "security": [
          {
            "bearerAuth": [
              "sales_invoices"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/administration_id"
          },
          {
            "name": "external_sales_invoice_id",
            "in": "path",
            "required": true,
            "schema": {
              "$ref": "#/components/schemas/identifier"
            }
          },
          {
            "name": "id",
            "in": "path",
            "required": true,
            "schema": {
              "$ref": "#/components/schemas/identifier"
            }
          },
          {
            "$ref": "#/components/parameters/format"
          }
        ],
        "responses": {
          "204": {
            "description": "Note deleted"
          },
          "404": {
            "description": "Not found",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/symbolic_error"
                },
                "examples": {
                  "Returns404WhenInvoiceDoesNotExist": {
                    "summary": "Returns 404 when invoice does not exist",
                    "value": {
                      "error": "record not found",
                      "symbolic": {
                        "id": "not_found"
                      }
                    }
                  }
                }
              }
            }
          }
        },
        "operationId": "delete_administration_id_external_sales_invoices_external_sales_invoice_id_notes_id"
      }
    },
    "/{administration_id}/external_sales_invoices/{external_sales_invoice_id}/notes{format}": {
      "post": {
        "summary": "Adds note to entity",
        "description": "Adds a note to the external sales invoice.\n\n### Required scope(s)\n `sales_invoices`",
        "tags": [
          "External sales invoices"
        ],
        "security": [
          {
            "bearerAuth": [
              "sales_invoices"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/administration_id"
          },
          {
            "name": "external_sales_invoice_id",
            "in": "path",
            "required": true,
            "schema": {
              "$ref": "#/components/schemas/identifier"
            }
          },
          {
            "$ref": "#/components/parameters/format"
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/*": {
              "schema": {
                "unevaluatedProperties": false,
                "type": "object",
                "properties": {
                  "note": {
                    "type": "object",
                    "unevaluatedProperties": false,
                    "properties": {
                      "note": {
                        "type": "string",
                        "description": "**Required**. Text for the note or to-do."
                      },
                      "todo": {
                        "type": [
                          "boolean",
                          "string"
                        ],
                        "description": "If `true` the note is a to-do."
                      },
                      "assignee_id": {
                        "$ref": "#/components/schemas/identifier",
                        "description": "Assign to-do to user. Should be a valid user id. If assignee_id is provided the note will be a to-do."
                      }
                    },
                    "required": []
                  }
                },
                "required": []
              },
              "examples": {
                "CreateANote": {
                  "summary": "Create a note",
                  "value": {
                    "note": {
                      "note": "Text of the note",
                      "assignee_id": 502689273530549440,
                      "todo": true
                    }
                  }
                }
              }
            }
          }
        },
        "responses": {
          "201": {
            "description": "Note created",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/note_response"
                },
                "examples": {
                  "CreateANote": {
                    "summary": "Create a note",
                    "value": {
                      "id": "502689273548375236",
                      "administration_id": 123,
                      "entity_id": "502689273521112256",
                      "entity_type": "ExternalSalesInvoice",
                      "user_id": "502689108256097381",
                      "assignee_id": "502689273530549442",
                      "todo": true,
                      "note": "Text of the note",
                      "completed_at": null,
                      "completed_by_id": null,
                      "todo_type": null,
                      "data": {},
                      "created_at": "2026-11-02T12:17:51.036Z",
                      "updated_at": "2026-11-02T12:17:51.036Z"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "Bad request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/symbolic_error"
                },
                "examples": {
                  "Returns400WhenInvoiceDoesNotExist": {
                    "summary": "Returns 400 when invoice does not exist",
                    "value": {
                      "error": "Entity is invalid; User has no permissions to notes for ExternalSalesInvoice",
                      "symbolic": {
                        "entity": "not_found",
                        "user": "insufficient_permissions"
                      }
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "Unprocessable entity",
            "content": {
              "application/json": {
                "schema": {
                  "anyOf": [
                    {
                      "$ref": "#/components/schemas/symbolic_error"
                    },
                    {
                      "$ref": "#/components/schemas/non_symbolic_error"
                    }
                  ]
                },
                "examples": {
                  "Returns422WhenNoteParamsAreInvalid": {
                    "summary": "Returns 422 when note params are invalid",
                    "value": {
                      "error": {
                        "note": [
                          "can't be blank"
                        ],
                        "todo_type": [
                          "can't be blank"
                        ]
                      },
                      "details": {
                        "note": [
                          {
                            "error": "blank"
                          }
                        ],
                        "todo_type": [
                          {
                            "error": "blank"
                          }
                        ]
                      }
                    }
                  }
                }
              }
            }
          }
        },
        "operationId": "post_administration_id_external_sales_invoices_external_sales_invoice_id_notes"
      }
    },
    "/{administration_id}/external_sales_invoices/{external_sales_invoice_id}/payments/{id}{format}": {
      "delete": {
        "summary": "Delete a payment",
        "description": "Deletes a payment from an external sales invoice.\n\nWhen the payment is linked to a financial mutation, the token also needs the `bank` scope. Such a payment is\nunlinked from the mutation instead and stays on the invoice, unless it was created by linking it to that\nmutation.\n\n### Required scope(s)\n `sales_invoices`",
        "tags": [
          "External sales invoices"
        ],
        "security": [
          {
            "bearerAuth": [
              "sales_invoices"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/administration_id"
          },
          {
            "name": "external_sales_invoice_id",
            "in": "path",
            "required": true,
            "schema": {
              "$ref": "#/components/schemas/identifier"
            }
          },
          {
            "name": "id",
            "in": "path",
            "required": true,
            "schema": {
              "$ref": "#/components/schemas/identifier"
            }
          },
          {
            "$ref": "#/components/parameters/format"
          }
        ],
        "responses": {
          "204": {
            "description": "Payment deleted"
          },
          "404": {
            "description": "Not found",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/symbolic_error"
                },
                "examples": {
                  "Returns404WhenPaymentDoesNotExist": {
                    "summary": "Returns 404 when payment does not exist",
                    "value": {
                      "error": "record not found",
                      "symbolic": {
                        "id": "not_found"
                      }
                    }
                  }
                }
              }
            }
          }
        },
        "operationId": "delete_administration_id_external_sales_invoices_external_sales_invoice_id_payments_id"
      }
    },
    "/{administration_id}/external_sales_invoices/{external_sales_invoice_id}/payments{format}": {
      "post": {
        "summary": "Create a payment",
        "description": "Registers a payment for an external sales invoice.\n\nA `cash_payment` with `financial_account_id` and without `financial_mutation_id` also needs the `bank` scope.\nAn `invoices_settlement` against a purchase invoice also needs the `documents` scope.\n\n### Required scope(s)\n `sales_invoices`",
        "tags": [
          "External sales invoices"
        ],
        "security": [
          {
            "bearerAuth": [
              "sales_invoices"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/administration_id"
          },
          {
            "name": "external_sales_invoice_id",
            "in": "path",
            "required": true,
            "schema": {
              "$ref": "#/components/schemas/identifier"
            }
          },
          {
            "$ref": "#/components/parameters/format"
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/*": {
              "schema": {
                "unevaluatedProperties": false,
                "type": "object",
                "properties": {
                  "payment": {
                    "type": "object",
                    "unevaluatedProperties": false,
                    "properties": {
                      "payment_date": {
                        "type": "string",
                        "description": "The date on which the payment was made."
                      },
                      "price": {
                        "$ref": "#/components/schemas/money",
                        "description": "The amount paid in the document's currency."
                      },
                      "price_base": {
                        "$ref": "#/components/schemas/money",
                        "description": "Amount paid expressed in the base currency of the administration. Required when the document uses a different currency than the administration's base currency."
                      },
                      "financial_account_id": {
                        "$ref": "#/components/schemas/identifier",
                        "description": "The ID of the financial account (bank account or cash register) associated with this payment. Required for `private_payment` and `cash_payment` actions. Should be a valid financial account id."
                      },
                      "financial_mutation_id": {
                        "$ref": "#/components/schemas/identifier",
                        "description": "The ID of the bank transaction to link this payment to. Required for `bank_transfer` actions. Should be a valid financial mutation id."
                      },
                      "transaction_identifier": {
                        "type": "string",
                        "description": "An external transaction reference, e.g. a bank transaction ID or PSP reference. Used to match the payment with financial mutations."
                      },
                      "manual_payment_action": {
                        "type": "string",
                        "description": "Can be `private_payment` (needs financial_account_id), `payment_without_proof`, `cash_payment` (needs financial_account_id), `rounding_error`, `bank_transfer` (needs financial_mutation_id), `balance_settlement` (needs ledger_account_id) or `invoices_settlement` (needs invoice_id). `payment_without_proof` is only accepted when the administration allows payments without proof."
                      },
                      "ledger_account_id": {
                        "$ref": "#/components/schemas/identifier",
                        "description": "The ID of the ledger account to book this payment to. Required for `balance_settlement` actions. Should be a valid ledger account id."
                      },
                      "invoice_id": {
                        "$ref": "#/components/schemas/identifier",
                        "description": "The ID of the document to settle this payment against. Required for `invoices_settlement` actions. Should be a valid document id (sales invoice, purchase invoice, receipt, etc.)."
                      }
                    },
                    "required": [
                      "payment_date",
                      "price"
                    ]
                  }
                },
                "required": []
              },
              "examples": {
                "CreateAPayment": {
                  "summary": "Create a payment",
                  "value": {
                    "payment": {
                      "payment_date": "2026-11-02T12:17:47.660Z",
                      "price": "121.0"
                    }
                  }
                }
              }
            }
          }
        },
        "responses": {
          "201": {
            "description": "Payment created",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/payment_response"
                },
                "examples": {
                  "CreateAPayment": {
                    "summary": "Create a payment",
                    "value": {
                      "id": "502689270018869110",
                      "administration_id": 123,
                      "invoice_type": "ExternalSalesInvoice",
                      "invoice_id": "502689270001043316",
                      "financial_account_id": null,
                      "user_id": "502689108256097381",
                      "payment_transaction_id": null,
                      "transaction_identifier": null,
                      "price": "121.0",
                      "price_base": "121.0",
                      "payment_date": "2026-11-02",
                      "credit_invoice_id": null,
                      "financial_mutation_id": null,
                      "ledger_account_id": "502689108803454083",
                      "linked_payment_id": null,
                      "manual_payment_action": null,
                      "created_at": "2026-11-02T12:17:47.671Z",
                      "updated_at": "2026-11-02T12:17:47.671Z"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Not found",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/symbolic_error"
                },
                "examples": {
                  "Returns404WhenInvoiceDoesNotExist": {
                    "summary": "Returns 404 when invoice does not exist",
                    "value": {
                      "error": "record not found",
                      "symbolic": {
                        "invoice_id": "not_found"
                      }
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "Unprocessable entity",
            "content": {
              "application/json": {
                "schema": {
                  "anyOf": [
                    {
                      "$ref": "#/components/schemas/symbolic_error"
                    },
                    {
                      "$ref": "#/components/schemas/non_symbolic_error"
                    }
                  ]
                },
                "examples": {
                  "Returns422WhenPaymentParamsAreInvalid": {
                    "summary": "Returns 422 when payment params are invalid",
                    "value": {
                      "error": {
                        "payment_date": [
                          "can't be blank",
                          "is not a valid date"
                        ],
                        "price": [
                          "can't be blank",
                          "is not a number"
                        ]
                      },
                      "details": {
                        "payment_date": [
                          {
                            "error": "blank"
                          },
                          {
                            "error": "is not a valid date"
                          }
                        ],
                        "price": [
                          {
                            "error": "blank"
                          },
                          {
                            "error": "not_a_number",
                            "value": null
                          }
                        ]
                      }
                    }
                  }
                }
              }
            }
          }
        },
        "operationId": "post_administration_id_external_sales_invoices_external_sales_invoice_id_payments"
      }
    },
    "/{administration_id}/external_sales_invoices/{id}/attachment{format}": {
      "post": {
        "summary": "Add attachment to external sales invoice",
        "description": "Add an attachment to an external sales invoice.\n\n### Required scope(s)\n `sales_invoices`",
        "tags": [
          "External sales invoices"
        ],
        "security": [
          {
            "bearerAuth": [
              "sales_invoices"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/administration_id"
          },
          {
            "name": "id",
            "in": "path",
            "required": true,
            "schema": {
              "$ref": "#/components/schemas/identifier"
            }
          },
          {
            "$ref": "#/components/parameters/format"
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "multipart/form-data": {
              "schema": {
                "type": "object",
                "properties": {
                  "file": {
                    "type": "string",
                    "format": "binary"
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "$ref": "#/components/responses/status_code"
          },
          "400": {
            "$ref": "#/components/responses/400_bad_request"
          },
          "404": {
            "$ref": "#/components/responses/404_not_found"
          }
        },
        "operationId": "post_administration_id_external_sales_invoices_id_attachment"
      }
    },
    "/{administration_id}/external_sales_invoices/{id}/mark_as_dubious{format}": {
      "patch": {
        "summary": "Mark as dubious",
        "description": "This endpoint marks an external sales invoice as dubious.\n\n### Required scope(s)\n `sales_invoices`",
        "tags": [
          "External sales invoices"
        ],
        "security": [
          {
            "bearerAuth": [
              "sales_invoices"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/administration_id"
          },
          {
            "name": "id",
            "in": "path",
            "required": true,
            "schema": {
              "$ref": "#/components/schemas/identifier"
            }
          },
          {
            "$ref": "#/components/parameters/format"
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/*": {
              "schema": {
                "unevaluatedProperties": false,
                "type": "object",
                "properties": {
                  "dubious_date": {
                    "type": "string",
                    "format": "date"
                  }
                },
                "required": []
              },
              "examples": {
                "MarksTheExternalSalesInvoiceAsDubious": {
                  "summary": "Marks the external sales invoice as dubious",
                  "value": {}
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "External sales invoice updated",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/external_sales_invoice_response"
                },
                "examples": {
                  "MarksTheExternalSalesInvoiceAsDubious": {
                    "summary": "Marks the external sales invoice as dubious",
                    "value": {
                      "id": "502689271449125969",
                      "administration_id": 123,
                      "contact_id": "502689271441785936",
                      "contact": {
                        "id": "502689271441785936",
                        "administration_id": 123,
                        "company_name": "Relation 1",
                        "firstname": null,
                        "lastname": null,
                        "address1": null,
                        "address2": null,
                        "zipcode": null,
                        "city": null,
                        "country": "NL",
                        "phone": null,
                        "delivery_method": "Email",
                        "customer_id": "customer-1",
                        "tax_number": null,
                        "chamber_of_commerce": null,
                        "bank_account": null,
                        "is_trusted": false,
                        "max_transfer_amount": null,
                        "attention": null,
                        "email": "invoices@example.com",
                        "email_ubl": false,
                        "send_invoices_to_attention": null,
                        "send_invoices_to_email": "invoices@example.com",
                        "send_estimates_to_attention": null,
                        "send_estimates_to_email": "estimates@example.com",
                        "direct_debit": false,
                        "sepa_active": false,
                        "sepa_iban": null,
                        "sepa_iban_account_name": null,
                        "sepa_bic": null,
                        "sepa_mandate_id": null,
                        "sepa_mandate_date": null,
                        "sepa_sequence_type": "RCUR",
                        "credit_card_number": null,
                        "credit_card_reference": null,
                        "credit_card_type": null,
                        "tax_number_validated_at": null,
                        "tax_number_valid": null,
                        "invoice_workflow_id": null,
                        "estimate_workflow_id": null,
                        "si_identifier": null,
                        "si_identifier_type": null,
                        "moneybird_payments_mandate": false,
                        "created_at": "2026-11-02T12:17:49.027Z",
                        "updated_at": "2026-11-02T12:17:49.027Z",
                        "version": 1793621869,
                        "sales_invoices_url": "https://moneybird.dev/123/sales_invoices/0000000000000000000000000000000000000000000000000000000000000001/all",
                        "notes": [],
                        "custom_fields": [],
                        "contact_people": [],
                        "archived": false
                      },
                      "date": "2026-08-04",
                      "state": "open",
                      "due_date": null,
                      "reference": "Invoice 1",
                      "entry_number": 101,
                      "origin": null,
                      "source": null,
                      "source_url": null,
                      "currency": "EUR",
                      "paid_at": null,
                      "created_at": "2026-11-02T12:17:49.035Z",
                      "updated_at": "2026-11-02T12:17:49.048Z",
                      "version": 1793621869,
                      "details": [
                        {
                          "id": "502689271450174546",
                          "administration_id": 123,
                          "tax_rate_id": "502689108899923082",
                          "ledger_account_id": "502689108787725434",
                          "project_id": null,
                          "product_id": null,
                          "amount": "1 x",
                          "amount_decimal": "1.0",
                          "description": "Invoice detail description",
                          "price": "100.0",
                          "period": null,
                          "row_order": 0,
                          "total_price_excl_tax_with_discount": "100.0",
                          "total_price_excl_tax_with_discount_base": "100.0",
                          "tax_report_reference": [
                            "NL/1a"
                          ],
                          "mandatory_tax_text": null,
                          "created_at": "2026-11-02T12:17:49.036Z",
                          "updated_at": "2026-11-02T12:17:49.036Z"
                        }
                      ],
                      "payments": [],
                      "total_paid": "0.0",
                      "total_unpaid": "121.0",
                      "total_unpaid_base": "121.0",
                      "prices_are_incl_tax": false,
                      "total_price_excl_tax": "100.0",
                      "total_price_excl_tax_base": "100.0",
                      "total_price_incl_tax": "121.0",
                      "total_price_incl_tax_base": "121.0",
                      "marked_dubious_on": "2026-11-02",
                      "marked_uncollectible_on": null,
                      "notes": [],
                      "attachments": [],
                      "events": [
                        {
                          "administration_id": 123,
                          "user_id": "502689108256097381",
                          "action": "external_sales_invoice_marked_as_dubious",
                          "link_entity_id": null,
                          "link_entity_type": null,
                          "data": {},
                          "created_at": "2026-11-02T12:17:49.050Z",
                          "updated_at": "2026-11-02T12:17:49.050Z"
                        }
                      ],
                      "tax_totals": [
                        {
                          "tax_rate_id": "502689108899923082",
                          "taxable_amount": "100.0",
                          "taxable_amount_base": "100.0",
                          "tax_amount": "21.0",
                          "tax_amount_base": "21.0"
                        }
                      ]
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "Bad request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/symbolic_error"
                },
                "examples": {
                  "Returns400WhenInvoiceCannotBeMarkedAsDubious": {
                    "summary": "Returns 400 when invoice cannot be marked as dubious",
                    "value": {
                      "error": "Invoice should be open, late or due, not a credit invoice and cannot have an invoice date in the future",
                      "symbolic": {
                        "invoice": "not_open"
                      }
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Not found",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/symbolic_error"
                },
                "examples": {
                  "Returns404WhenInvoiceDoesNotExist": {
                    "summary": "Returns 404 when invoice does not exist",
                    "value": {
                      "error": "Record not found for model name: External invoice"
                    }
                  }
                }
              }
            }
          }
        },
        "operationId": "patch_administration_id_external_sales_invoices_id_mark_as_dubious"
      }
    },
    "/{administration_id}/external_sales_invoices/{id}/mark_as_uncollectible{format}": {
      "patch": {
        "summary": "Mark as uncollectible",
        "description": "This endpoint marks an external sales invoice as uncollectible.\n\n### Required scope(s)\n `sales_invoices`",
        "tags": [
          "External sales invoices"
        ],
        "security": [
          {
            "bearerAuth": [
              "sales_invoices"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/administration_id"
          },
          {
            "name": "id",
            "in": "path",
            "required": true,
            "schema": {
              "$ref": "#/components/schemas/identifier"
            }
          },
          {
            "$ref": "#/components/parameters/format"
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/*": {
              "schema": {
                "unevaluatedProperties": false,
                "type": "object",
                "properties": {
                  "uncollectible_date": {
                    "type": "string",
                    "format": "date"
                  },
                  "book_method": {
                    "type": "string",
                    "description": "Can be `revenue`."
                  }
                },
                "required": []
              },
              "examples": {
                "MarksTheSalesInvoiceAsUncollectibleUsingTheUncollectibleRevenue": {
                  "summary": "Marks the sales invoice as uncollectible using the uncollectible revenue",
                  "value": {}
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "External sales invoice updated",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/external_sales_invoice_response"
                },
                "examples": {
                  "MarksTheSalesInvoiceAsUncollectibleUsingTheUncollectibleRevenue": {
                    "summary": "Marks the sales invoice as uncollectible using the uncollectible revenue",
                    "value": {
                      "id": "502689273160402067",
                      "administration_id": 123,
                      "contact_id": "502689273145722002",
                      "contact": {
                        "id": "502689273145722002",
                        "administration_id": 123,
                        "company_name": "Relation 1",
                        "firstname": null,
                        "lastname": null,
                        "address1": null,
                        "address2": null,
                        "zipcode": null,
                        "city": null,
                        "country": "NL",
                        "phone": null,
                        "delivery_method": "Email",
                        "customer_id": "customer-1",
                        "tax_number": null,
                        "chamber_of_commerce": null,
                        "bank_account": null,
                        "is_trusted": false,
                        "max_transfer_amount": null,
                        "attention": null,
                        "email": "invoices@example.com",
                        "email_ubl": false,
                        "send_invoices_to_attention": null,
                        "send_invoices_to_email": "invoices@example.com",
                        "send_estimates_to_attention": null,
                        "send_estimates_to_email": "estimates@example.com",
                        "direct_debit": false,
                        "sepa_active": false,
                        "sepa_iban": null,
                        "sepa_iban_account_name": null,
                        "sepa_bic": null,
                        "sepa_mandate_id": null,
                        "sepa_mandate_date": null,
                        "sepa_sequence_type": "RCUR",
                        "credit_card_number": null,
                        "credit_card_reference": null,
                        "credit_card_type": null,
                        "tax_number_validated_at": null,
                        "tax_number_valid": null,
                        "invoice_workflow_id": null,
                        "estimate_workflow_id": null,
                        "si_identifier": null,
                        "si_identifier_type": null,
                        "moneybird_payments_mandate": false,
                        "created_at": "2026-11-02T12:17:50.652Z",
                        "updated_at": "2026-11-02T12:17:50.652Z",
                        "version": 1793621870,
                        "sales_invoices_url": "https://moneybird.dev/123/sales_invoices/0000000000000000000000000000000000000000000000000000000000000001/all",
                        "notes": [],
                        "custom_fields": [],
                        "contact_people": [],
                        "archived": false
                      },
                      "date": "2026-08-04",
                      "state": "uncollectible",
                      "due_date": null,
                      "reference": "Invoice 1",
                      "entry_number": 101,
                      "origin": null,
                      "source": null,
                      "source_url": null,
                      "currency": "EUR",
                      "paid_at": null,
                      "created_at": "2026-11-02T12:17:50.666Z",
                      "updated_at": "2026-11-02T12:17:50.753Z",
                      "version": 1793621870,
                      "details": [
                        {
                          "id": "502689273161450644",
                          "administration_id": 123,
                          "tax_rate_id": "502689108899923082",
                          "ledger_account_id": "502689108787725434",
                          "project_id": null,
                          "product_id": null,
                          "amount": "1 x",
                          "amount_decimal": "1.0",
                          "description": "Invoice detail description",
                          "price": "100.0",
                          "period": null,
                          "row_order": 0,
                          "total_price_excl_tax_with_discount": "100.0",
                          "total_price_excl_tax_with_discount_base": "100.0",
                          "tax_report_reference": [
                            "NL/1a"
                          ],
                          "mandatory_tax_text": null,
                          "created_at": "2026-11-02T12:17:50.668Z",
                          "updated_at": "2026-11-02T12:17:50.752Z"
                        }
                      ],
                      "payments": [],
                      "total_paid": "0.0",
                      "total_unpaid": "121.0",
                      "total_unpaid_base": "121.0",
                      "prices_are_incl_tax": false,
                      "total_price_excl_tax": "100.0",
                      "total_price_excl_tax_base": "100.0",
                      "total_price_incl_tax": "121.0",
                      "total_price_incl_tax_base": "121.0",
                      "marked_dubious_on": null,
                      "marked_uncollectible_on": "2026-11-02",
                      "notes": [],
                      "attachments": [],
                      "events": [
                        {
                          "administration_id": 123,
                          "user_id": "502689108256097381",
                          "action": "external_sales_invoice_state_changed_to_uncollectible",
                          "link_entity_id": null,
                          "link_entity_type": null,
                          "data": {},
                          "created_at": "2026-11-02T12:17:50.734Z",
                          "updated_at": "2026-11-02T12:17:50.734Z"
                        },
                        {
                          "administration_id": 123,
                          "user_id": "502689108256097381",
                          "action": "external_sales_invoice_marked_as_uncollectible",
                          "link_entity_id": null,
                          "link_entity_type": null,
                          "data": {},
                          "created_at": "2026-11-02T12:17:50.757Z",
                          "updated_at": "2026-11-02T12:17:50.757Z"
                        }
                      ],
                      "tax_totals": [
                        {
                          "tax_rate_id": "502689108899923082",
                          "taxable_amount": "100.0",
                          "taxable_amount_base": "100.0",
                          "tax_amount": "21.0",
                          "tax_amount_base": "21.0"
                        }
                      ]
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "Bad request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/symbolic_error"
                },
                "examples": {
                  "Returns400WhenInvoiceCannotBeMarkedAsUncollectible": {
                    "summary": "Returns 400 when invoice cannot be marked as uncollectible",
                    "value": {
                      "error": "Sales invoice should be open, late or due, not a credit invoice and cannot have a invoice date in the future",
                      "symbolic": {
                        "invoice": "not_open"
                      }
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Not found",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/symbolic_error"
                },
                "examples": {
                  "Returns404WhenInvoiceDoesNotExist": {
                    "summary": "Returns 404 when invoice does not exist",
                    "value": {
                      "error": "Record not found for model name: External invoice"
                    }
                  }
                }
              }
            }
          }
        },
        "operationId": "patch_administration_id_external_sales_invoices_id_mark_as_uncollectible"
      }
    },
    "/{administration_id}/external_sales_invoices/{id}{format}": {
      "get": {
        "summary": "Get an external sales invoice by id",
        "description": "Returns an external sales invoice in the administration.\n\n\n### Required scope(s)\n `sales_invoices`",
        "tags": [
          "External sales invoices"
        ],
        "security": [
          {
            "bearerAuth": [
              "sales_invoices"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/administration_id"
          },
          {
            "name": "id",
            "in": "path",
            "required": true,
            "schema": {
              "$ref": "#/components/schemas/identifier"
            }
          },
          {
            "$ref": "#/components/parameters/format"
          }
        ],
        "responses": {
          "200": {
            "description": "An external sales invoice",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/external_sales_invoice_response"
                },
                "examples": {
                  "ReturnsInvoiceByGivenId": {
                    "summary": "Returns invoice by given id",
                    "value": {
                      "id": "502689269347780447",
                      "administration_id": 123,
                      "contact_id": "502689269340440414",
                      "contact": {
                        "id": "502689269340440414",
                        "administration_id": 123,
                        "company_name": "Relation 1",
                        "firstname": null,
                        "lastname": null,
                        "address1": null,
                        "address2": null,
                        "zipcode": null,
                        "city": null,
                        "country": "NL",
                        "phone": null,
                        "delivery_method": "Email",
                        "customer_id": "customer-1",
                        "tax_number": null,
                        "chamber_of_commerce": null,
                        "bank_account": null,
                        "is_trusted": false,
                        "max_transfer_amount": null,
                        "attention": null,
                        "email": "invoices@example.com",
                        "email_ubl": false,
                        "send_invoices_to_attention": null,
                        "send_invoices_to_email": "invoices@example.com",
                        "send_estimates_to_attention": null,
                        "send_estimates_to_email": "estimates@example.com",
                        "direct_debit": false,
                        "sepa_active": false,
                        "sepa_iban": null,
                        "sepa_iban_account_name": null,
                        "sepa_bic": null,
                        "sepa_mandate_id": null,
                        "sepa_mandate_date": null,
                        "sepa_sequence_type": "RCUR",
                        "credit_card_number": null,
                        "credit_card_reference": null,
                        "credit_card_type": null,
                        "tax_number_validated_at": null,
                        "tax_number_valid": null,
                        "invoice_workflow_id": null,
                        "estimate_workflow_id": null,
                        "si_identifier": null,
                        "si_identifier_type": null,
                        "moneybird_payments_mandate": false,
                        "created_at": "2026-11-02T12:17:47.023Z",
                        "updated_at": "2026-11-02T12:17:47.023Z",
                        "version": 1793621867,
                        "sales_invoices_url": "https://moneybird.dev/123/sales_invoices/0000000000000000000000000000000000000000000000000000000000000001/all",
                        "notes": [],
                        "custom_fields": [],
                        "contact_people": [],
                        "archived": false
                      },
                      "date": "2026-11-02",
                      "state": "open",
                      "due_date": null,
                      "reference": "Invoice 1",
                      "entry_number": 101,
                      "origin": null,
                      "source": null,
                      "source_url": null,
                      "currency": "EUR",
                      "paid_at": null,
                      "created_at": "2026-11-02T12:17:47.031Z",
                      "updated_at": "2026-11-02T12:17:47.033Z",
                      "version": 1793621867,
                      "details": [
                        {
                          "id": "502689269348829024",
                          "administration_id": 123,
                          "tax_rate_id": "502689108899923082",
                          "ledger_account_id": "502689108787725434",
                          "project_id": null,
                          "product_id": null,
                          "amount": "1 x",
                          "amount_decimal": "1.0",
                          "description": "Invoice detail description",
                          "price": "100.0",
                          "period": null,
                          "row_order": 0,
                          "total_price_excl_tax_with_discount": "100.0",
                          "total_price_excl_tax_with_discount_base": "100.0",
                          "tax_report_reference": [],
                          "mandatory_tax_text": null,
                          "created_at": "2026-11-02T12:17:47.032Z",
                          "updated_at": "2026-11-02T12:17:47.032Z"
                        }
                      ],
                      "payments": [],
                      "total_paid": "0.0",
                      "total_unpaid": "121.0",
                      "total_unpaid_base": "121.0",
                      "prices_are_incl_tax": false,
                      "total_price_excl_tax": "100.0",
                      "total_price_excl_tax_base": "100.0",
                      "total_price_incl_tax": "121.0",
                      "total_price_incl_tax_base": "121.0",
                      "marked_dubious_on": null,
                      "marked_uncollectible_on": null,
                      "notes": [],
                      "attachments": [],
                      "events": [],
                      "tax_totals": [
                        {
                          "tax_rate_id": "502689108899923082",
                          "taxable_amount": "100.0",
                          "taxable_amount_base": "100.0",
                          "tax_amount": "21.0",
                          "tax_amount_base": "21.0"
                        }
                      ]
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Not found",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/symbolic_error"
                },
                "examples": {
                  "Returns404WhenInvoiceDoesNotExist": {
                    "summary": "Returns 404 when invoice does not exist",
                    "value": {
                      "error": "Record not found for model name: External invoice"
                    }
                  }
                }
              }
            }
          }
        },
        "operationId": "get_administration_id_external_sales_invoices_id"
      },
      "patch": {
        "summary": "Update an external sales invoice",
        "description": "When updating an external sales invoice, provide only the attributes you want to update. The other attributes will not be changed.\n\n### Required scope(s)\n `sales_invoices`",
        "tags": [
          "External sales invoices"
        ],
        "security": [
          {
            "bearerAuth": [
              "sales_invoices"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/administration_id"
          },
          {
            "name": "id",
            "in": "path",
            "required": true,
            "schema": {
              "$ref": "#/components/schemas/identifier"
            }
          },
          {
            "$ref": "#/components/parameters/format"
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/*": {
              "schema": {
                "unevaluatedProperties": false,
                "type": "object",
                "properties": {
                  "external_sales_invoice": {
                    "type": "object",
                    "unevaluatedProperties": false,
                    "properties": {
                      "contact_id": {
                        "$ref": "#/components/schemas/identifier",
                        "description": "Should be a valid contact id."
                      },
                      "reference": {
                        "type": "string",
                        "description": "The invoice number or reference from the external system that created this invoice, e.g. a webshop order ID."
                      },
                      "date": {
                        "type": "string",
                        "description": "The date of the invoice.",
                        "format": "date"
                      },
                      "due_date": {
                        "type": "string",
                        "description": "The date by which the invoice should be paid.",
                        "format": "date"
                      },
                      "currency": {
                        "type": "string",
                        "description": "ISO three-character currency code, e.g. EUR or USD."
                      },
                      "prices_are_incl_tax": {
                        "type": [
                          "boolean",
                          "string"
                        ],
                        "description": "Whether the prices on the invoice are inclusive of tax."
                      },
                      "source": {
                        "type": "string",
                        "description": "The name of the external system that created this invoice."
                      },
                      "source_url": {
                        "type": "string",
                        "description": "A URL linking back to the invoice in the external system."
                      },
                      "details_attributes": {
                        "$ref": "#/components/schemas/details_attributes"
                      }
                    },
                    "required": []
                  }
                },
                "required": []
              },
              "examples": {
                "AddingAndRemovingAnInvoiceDetail": {
                  "summary": "Adding and removing an invoice detail",
                  "value": {
                    "external_sales_invoice": {
                      "details_attributes": [
                        {
                          "description": "Sofa",
                          "price": 199.99
                        },
                        {
                          "id": 502689270803204100,
                          "_destroy": true
                        }
                      ]
                    }
                  }
                },
                "UpdatingTheInvoiceReference": {
                  "summary": "Updating the invoice reference",
                  "value": {
                    "external_sales_invoice": {
                      "reference": "30053"
                    }
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "External sales invoice updated",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/external_sales_invoice_response"
                },
                "examples": {
                  "AddingAndRemovingAnInvoiceDetail": {
                    "summary": "Adding and removing an invoice detail",
                    "value": {
                      "id": "502689270802155492",
                      "administration_id": 123,
                      "contact_id": "502689270794815459",
                      "contact": {
                        "id": "502689270794815459",
                        "administration_id": 123,
                        "company_name": "Relation 1",
                        "firstname": null,
                        "lastname": null,
                        "address1": null,
                        "address2": null,
                        "zipcode": null,
                        "city": null,
                        "country": "NL",
                        "phone": null,
                        "delivery_method": "Email",
                        "customer_id": "customer-1",
                        "tax_number": null,
                        "chamber_of_commerce": null,
                        "bank_account": null,
                        "is_trusted": false,
                        "max_transfer_amount": null,
                        "attention": null,
                        "email": "invoices@example.com",
                        "email_ubl": false,
                        "send_invoices_to_attention": null,
                        "send_invoices_to_email": "invoices@example.com",
                        "send_estimates_to_attention": null,
                        "send_estimates_to_email": "estimates@example.com",
                        "direct_debit": false,
                        "sepa_active": false,
                        "sepa_iban": null,
                        "sepa_iban_account_name": null,
                        "sepa_bic": null,
                        "sepa_mandate_id": null,
                        "sepa_mandate_date": null,
                        "sepa_sequence_type": "RCUR",
                        "credit_card_number": null,
                        "credit_card_reference": null,
                        "credit_card_type": null,
                        "tax_number_validated_at": null,
                        "tax_number_valid": null,
                        "invoice_workflow_id": null,
                        "estimate_workflow_id": null,
                        "si_identifier": null,
                        "si_identifier_type": null,
                        "moneybird_payments_mandate": false,
                        "created_at": "2026-11-02T12:17:48.410Z",
                        "updated_at": "2026-11-02T12:17:48.410Z",
                        "version": 1793621868,
                        "sales_invoices_url": "https://moneybird.dev/123/sales_invoices/0000000000000000000000000000000000000000000000000000000000000001/all",
                        "notes": [],
                        "custom_fields": [],
                        "contact_people": [],
                        "archived": false
                      },
                      "date": "2026-11-02",
                      "state": "open",
                      "due_date": null,
                      "reference": "Invoice 1",
                      "entry_number": 1,
                      "origin": null,
                      "source": null,
                      "source_url": null,
                      "currency": "EUR",
                      "paid_at": null,
                      "created_at": "2026-11-02T12:17:48.417Z",
                      "updated_at": "2026-11-02T12:17:48.447Z",
                      "version": 1793621868,
                      "details": [
                        {
                          "id": "502689270832564199",
                          "administration_id": 123,
                          "tax_rate_id": "502689108899923082",
                          "ledger_account_id": "502689108787725434",
                          "project_id": null,
                          "product_id": null,
                          "amount": null,
                          "amount_decimal": "1.0",
                          "description": "Sofa",
                          "price": "199.99",
                          "period": null,
                          "row_order": 0,
                          "total_price_excl_tax_with_discount": "199.99",
                          "total_price_excl_tax_with_discount_base": "199.99",
                          "tax_report_reference": [
                            "NL/1a"
                          ],
                          "mandatory_tax_text": null,
                          "created_at": "2026-11-02T12:17:48.446Z",
                          "updated_at": "2026-11-02T12:17:48.446Z"
                        }
                      ],
                      "payments": [],
                      "total_paid": "0.0",
                      "total_unpaid": "241.99",
                      "total_unpaid_base": "241.99",
                      "prices_are_incl_tax": false,
                      "total_price_excl_tax": "199.99",
                      "total_price_excl_tax_base": "199.99",
                      "total_price_incl_tax": "241.99",
                      "total_price_incl_tax_base": "241.99",
                      "marked_dubious_on": null,
                      "marked_uncollectible_on": null,
                      "notes": [],
                      "attachments": [],
                      "events": [
                        {
                          "administration_id": 123,
                          "user_id": "502689108256097381",
                          "action": "external_sales_invoice_updated",
                          "link_entity_id": null,
                          "link_entity_type": null,
                          "data": {},
                          "created_at": "2026-11-02T12:17:48.449Z",
                          "updated_at": "2026-11-02T12:17:48.449Z"
                        }
                      ],
                      "tax_totals": [
                        {
                          "tax_rate_id": "502689108899923082",
                          "taxable_amount": "199.99",
                          "taxable_amount_base": "199.99",
                          "tax_amount": "42.0",
                          "tax_amount_base": "42.0"
                        }
                      ]
                    }
                  },
                  "UpdatingTheInvoiceReference": {
                    "summary": "Updating the invoice reference",
                    "value": {
                      "id": "502689270893381620",
                      "administration_id": 123,
                      "contact_id": "502689270884993011",
                      "contact": {
                        "id": "502689270884993011",
                        "administration_id": 123,
                        "company_name": "Relation 1",
                        "firstname": null,
                        "lastname": null,
                        "address1": null,
                        "address2": null,
                        "zipcode": null,
                        "city": null,
                        "country": "NL",
                        "phone": null,
                        "delivery_method": "Email",
                        "customer_id": "customer-1",
                        "tax_number": null,
                        "chamber_of_commerce": null,
                        "bank_account": null,
                        "is_trusted": false,
                        "max_transfer_amount": null,
                        "attention": null,
                        "email": "invoices@example.com",
                        "email_ubl": false,
                        "send_invoices_to_attention": null,
                        "send_invoices_to_email": "invoices@example.com",
                        "send_estimates_to_attention": null,
                        "send_estimates_to_email": "estimates@example.com",
                        "direct_debit": false,
                        "sepa_active": false,
                        "sepa_iban": null,
                        "sepa_iban_account_name": null,
                        "sepa_bic": null,
                        "sepa_mandate_id": null,
                        "sepa_mandate_date": null,
                        "sepa_sequence_type": "RCUR",
                        "credit_card_number": null,
                        "credit_card_reference": null,
                        "credit_card_type": null,
                        "tax_number_validated_at": null,
                        "tax_number_valid": null,
                        "invoice_workflow_id": null,
                        "estimate_workflow_id": null,
                        "si_identifier": null,
                        "si_identifier_type": null,
                        "moneybird_payments_mandate": false,
                        "created_at": "2026-11-02T12:17:48.497Z",
                        "updated_at": "2026-11-02T12:17:48.497Z",
                        "version": 1793621868,
                        "sales_invoices_url": "https://moneybird.dev/123/sales_invoices/0000000000000000000000000000000000000000000000000000000000000001/all",
                        "notes": [],
                        "custom_fields": [],
                        "contact_people": [],
                        "archived": false
                      },
                      "date": "2026-11-02",
                      "state": "open",
                      "due_date": null,
                      "reference": "30053",
                      "entry_number": 1,
                      "origin": null,
                      "source": null,
                      "source_url": null,
                      "currency": "EUR",
                      "paid_at": null,
                      "created_at": "2026-11-02T12:17:48.504Z",
                      "updated_at": "2026-11-02T12:17:48.529Z",
                      "version": 1793621868,
                      "details": [
                        {
                          "id": "502689270895478773",
                          "administration_id": 123,
                          "tax_rate_id": "502689108899923082",
                          "ledger_account_id": "502689108787725434",
                          "project_id": null,
                          "product_id": null,
                          "amount": "1 x",
                          "amount_decimal": "1.0",
                          "description": "Invoice detail description",
                          "price": "100.0",
                          "period": null,
                          "row_order": 0,
                          "total_price_excl_tax_with_discount": "100.0",
                          "total_price_excl_tax_with_discount_base": "100.0",
                          "tax_report_reference": [
                            "NL/1a"
                          ],
                          "mandatory_tax_text": null,
                          "created_at": "2026-11-02T12:17:48.506Z",
                          "updated_at": "2026-11-02T12:17:48.528Z"
                        }
                      ],
                      "payments": [],
                      "total_paid": "0.0",
                      "total_unpaid": "121.0",
                      "total_unpaid_base": "121.0",
                      "prices_are_incl_tax": false,
                      "total_price_excl_tax": "100.0",
                      "total_price_excl_tax_base": "100.0",
                      "total_price_incl_tax": "121.0",
                      "total_price_incl_tax_base": "121.0",
                      "marked_dubious_on": null,
                      "marked_uncollectible_on": null,
                      "notes": [],
                      "attachments": [],
                      "events": [
                        {
                          "administration_id": 123,
                          "user_id": "502689108256097381",
                          "action": "external_sales_invoice_updated",
                          "link_entity_id": null,
                          "link_entity_type": null,
                          "data": {},
                          "created_at": "2026-11-02T12:17:48.531Z",
                          "updated_at": "2026-11-02T12:17:48.531Z"
                        }
                      ],
                      "tax_totals": [
                        {
                          "tax_rate_id": "502689108899923082",
                          "taxable_amount": "100.0",
                          "taxable_amount_base": "100.0",
                          "tax_amount": "21.0",
                          "tax_amount_base": "21.0"
                        }
                      ]
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Not found",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/symbolic_error"
                },
                "examples": {
                  "Returns404WhenInvoiceDoesNotExist": {
                    "summary": "Returns 404 when invoice does not exist",
                    "value": {
                      "error": "record not found",
                      "symbolic": {
                        "id": "not_found"
                      }
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "Unprocessable entity",
            "content": {
              "application/json": {
                "schema": {
                  "anyOf": [
                    {
                      "$ref": "#/components/schemas/symbolic_error"
                    },
                    {
                      "$ref": "#/components/schemas/non_symbolic_error"
                    }
                  ]
                },
                "examples": {
                  "Returns422WhenUpdateParamsAreInvalid": {
                    "summary": "Returns 422 when update params are invalid",
                    "value": {
                      "error": {
                        "reference": [
                          "can't be blank"
                        ]
                      },
                      "details": {
                        "reference": [
                          {
                            "error": "blank"
                          }
                        ]
                      }
                    }
                  }
                }
              }
            }
          }
        },
        "operationId": "patch_administration_id_external_sales_invoices_id"
      },
      "delete": {
        "summary": "Delete an external sales invoice",
        "description": "Deletes an external sales invoice.\n\n### Required scope(s)\n `sales_invoices`",
        "tags": [
          "External sales invoices"
        ],
        "security": [
          {
            "bearerAuth": [
              "sales_invoices"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/administration_id"
          },
          {
            "name": "id",
            "in": "path",
            "required": true,
            "schema": {
              "$ref": "#/components/schemas/identifier"
            }
          },
          {
            "$ref": "#/components/parameters/format"
          }
        ],
        "responses": {
          "204": {
            "description": "External sales invoice deleted"
          },
          "404": {
            "description": "Not found",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/symbolic_error"
                },
                "examples": {
                  "Returns404WhenInvoiceDoesNotExist": {
                    "summary": "Returns 404 when invoice does not exist",
                    "value": {
                      "error": "record not found",
                      "symbolic": {
                        "id": "not_found"
                      }
                    }
                  }
                }
              }
            }
          }
        },
        "operationId": "delete_administration_id_external_sales_invoices_id"
      }
    },
    "/{administration_id}/external_sales_invoices{format}": {
      "get": {
        "summary": "List all external invoices",
        "description": "Returns a paginated list of external sales invoices in the administration.\n\n### Required scope(s)\n `sales_invoices`",
        "tags": [
          "External sales invoices"
        ],
        "security": [
          {
            "bearerAuth": [
              "sales_invoices"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/administration_id"
          },
          {
            "$ref": "#/components/parameters/format"
          },
          {
            "name": "filter",
            "in": "query",
            "required": false,
            "description": "Filters are `key:value` terms separated by commas (e.g. `period:this_year,state:all`). Any filter you pass replaces the defaults below entirely, so include every key you need. Available filters:\n\n| **Filter** | **Type** | **Default** | **Description** |\n| --- | --- | --- | --- |\n| state | `String` | `all` | `all`, `new`, `open`, `late`, `paid`, or `uncollectible` |\n| period | `String` | `this_year` | Matches on the invoice date. This can either be the description of a period (`this_week`, `prev_week`, `next_week`, `this_month`, `prev_month`, `next_month`, `this_quarter`, `prev_quarter`, `next_quarter`, `this_year`, `prev_year`, `next_year`) or a custom period (`201301..201302`, `20130101..20130131`). A custom period must have a start and an end date. It must not be longer than 10 years and must be between `20000101` and `21000101`. For one month, use `202401..202401`, not `202401`. Without `period`, the filter does not limit the dates. The default `this_year` applies only when you send no `filter`. |\n| contact_id | `Integer` | | Select invoices belonging to a certain contact |\n\nThe `period` filter matches on the invoice date. It does not look at the `period` of the individual details, which says which months the expenses belong to. Read `details[].period` in the response when you need those months, or use the reports endpoints, which already spread the amounts over that period. A detail's period can fall outside the filtered range, however wide you make it, so this filter cannot tell you which periods amounts fall in. Use the reports endpoints for that.\n\nYou can filter by multiple states at the same time as well. To do this, separate the state values by a pipe: `state:new|open`.",
            "schema": {
              "type": "string",
              "default": "period:this_year"
            },
            "examples": {
              "ReturnsAllInvoicesFilteredOnPeriod": {
                "summary": "Returns all invoices filtered on period",
                "value": "period:this_month"
              },
              "ReturnsAllInvoicesFilteredOnState": {
                "summary": "Returns all invoices filtered on state",
                "value": "state:open"
              }
            }
          },
          {
            "$ref": "#/components/parameters/page"
          },
          {
            "$ref": "#/components/parameters/per_page"
          }
        ],
        "responses": {
          "200": {
            "description": "A list of external sales invoices",
            "content": {
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "$ref": "#/components/schemas/external_sales_invoice_response"
                  }
                },
                "examples": {
                  "ReturnsAllInvoicesFilteredOnPeriod": {
                    "summary": "Returns all invoices filtered on period",
                    "value": [
                      {
                        "id": "502689268407207667",
                        "administration_id": 123,
                        "contact_id": null,
                        "contact": null,
                        "date": "2026-11-02",
                        "state": "new",
                        "due_date": null,
                        "reference": "Invoice 4",
                        "entry_number": 104,
                        "origin": null,
                        "source": null,
                        "source_url": null,
                        "currency": "EUR",
                        "paid_at": null,
                        "created_at": "2026-11-02T12:17:46.134Z",
                        "updated_at": "2026-11-02T12:17:46.134Z",
                        "version": 1793621866,
                        "details": [],
                        "payments": [],
                        "total_paid": "0.0",
                        "total_unpaid": "121.0",
                        "total_unpaid_base": "121.0",
                        "prices_are_incl_tax": false,
                        "total_price_excl_tax": "100.0",
                        "total_price_excl_tax_base": "100.0",
                        "total_price_incl_tax": "121.0",
                        "total_price_incl_tax_base": "121.0",
                        "marked_dubious_on": null,
                        "marked_uncollectible_on": null,
                        "notes": [],
                        "attachments": [],
                        "events": [],
                        "tax_totals": []
                      },
                      {
                        "id": "502689268401964785",
                        "administration_id": 123,
                        "contact_id": "502689268395673328",
                        "contact": {
                          "id": "502689268395673328",
                          "administration_id": 123,
                          "company_name": "Relation 3",
                          "firstname": null,
                          "lastname": null,
                          "address1": null,
                          "address2": null,
                          "zipcode": null,
                          "city": null,
                          "country": "NL",
                          "phone": null,
                          "delivery_method": "Email",
                          "customer_id": "customer-3",
                          "tax_number": null,
                          "chamber_of_commerce": null,
                          "bank_account": null,
                          "is_trusted": false,
                          "max_transfer_amount": null,
                          "attention": null,
                          "email": "invoices@example.com",
                          "email_ubl": false,
                          "send_invoices_to_attention": null,
                          "send_invoices_to_email": "invoices@example.com",
                          "send_estimates_to_attention": null,
                          "send_estimates_to_email": "estimates@example.com",
                          "direct_debit": false,
                          "sepa_active": false,
                          "sepa_iban": null,
                          "sepa_iban_account_name": null,
                          "sepa_bic": null,
                          "sepa_mandate_id": null,
                          "sepa_mandate_date": null,
                          "sepa_sequence_type": "RCUR",
                          "credit_card_number": null,
                          "credit_card_reference": null,
                          "credit_card_type": null,
                          "tax_number_validated_at": null,
                          "tax_number_valid": null,
                          "invoice_workflow_id": null,
                          "estimate_workflow_id": null,
                          "si_identifier": null,
                          "si_identifier_type": null,
                          "moneybird_payments_mandate": false,
                          "created_at": "2026-11-02T12:17:46.122Z",
                          "updated_at": "2026-11-02T12:17:46.122Z",
                          "version": 1793621866,
                          "sales_invoices_url": "https://moneybird.dev/123/sales_invoices/0000000000000000000000000000000000000000000000000000000000000003/all",
                          "notes": [],
                          "custom_fields": [],
                          "contact_people": [],
                          "archived": false
                        },
                        "date": "2026-11-02",
                        "state": "open",
                        "due_date": null,
                        "reference": "Invoice 3",
                        "entry_number": 103,
                        "origin": null,
                        "source": null,
                        "source_url": null,
                        "currency": "EUR",
                        "paid_at": null,
                        "created_at": "2026-11-02T12:17:46.128Z",
                        "updated_at": "2026-11-02T12:17:46.131Z",
                        "version": 1793621866,
                        "details": [
                          {
                            "id": "502689268403013362",
                            "administration_id": 123,
                            "tax_rate_id": "502689108899923082",
                            "ledger_account_id": "502689108787725434",
                            "project_id": null,
                            "product_id": null,
                            "amount": "1 x",
                            "amount_decimal": "1.0",
                            "description": "Invoice detail description",
                            "price": "100.0",
                            "period": null,
                            "row_order": 0,
                            "total_price_excl_tax_with_discount": "100.0",
                            "total_price_excl_tax_with_discount_base": "100.0",
                            "tax_report_reference": [],
                            "mandatory_tax_text": null,
                            "created_at": "2026-11-02T12:17:46.130Z",
                            "updated_at": "2026-11-02T12:17:46.130Z"
                          }
                        ],
                        "payments": [],
                        "total_paid": "0.0",
                        "total_unpaid": "121.0",
                        "total_unpaid_base": "121.0",
                        "prices_are_incl_tax": false,
                        "total_price_excl_tax": "100.0",
                        "total_price_excl_tax_base": "100.0",
                        "total_price_incl_tax": "121.0",
                        "total_price_incl_tax_base": "121.0",
                        "marked_dubious_on": null,
                        "marked_uncollectible_on": null,
                        "notes": [],
                        "attachments": [],
                        "events": [],
                        "tax_totals": [
                          {
                            "tax_rate_id": "502689108899923082",
                            "taxable_amount": "100.0",
                            "taxable_amount_base": "100.0",
                            "tax_amount": "21.0",
                            "tax_amount_base": "21.0"
                          }
                        ]
                      },
                      {
                        "id": "502689268387284717",
                        "administration_id": 123,
                        "contact_id": "502689268380993260",
                        "contact": {
                          "id": "502689268380993260",
                          "administration_id": 123,
                          "company_name": "Relation 2",
                          "firstname": null,
                          "lastname": null,
                          "address1": null,
                          "address2": null,
                          "zipcode": null,
                          "city": null,
                          "country": "NL",
                          "phone": null,
                          "delivery_method": "Email",
                          "customer_id": "customer-2",
                          "tax_number": null,
                          "chamber_of_commerce": null,
                          "bank_account": null,
                          "is_trusted": false,
                          "max_transfer_amount": null,
                          "attention": null,
                          "email": "invoices@example.com",
                          "email_ubl": false,
                          "send_invoices_to_attention": null,
                          "send_invoices_to_email": "invoices@example.com",
                          "send_estimates_to_attention": null,
                          "send_estimates_to_email": "estimates@example.com",
                          "direct_debit": false,
                          "sepa_active": false,
                          "sepa_iban": null,
                          "sepa_iban_account_name": null,
                          "sepa_bic": null,
                          "sepa_mandate_id": null,
                          "sepa_mandate_date": null,
                          "sepa_sequence_type": "RCUR",
                          "credit_card_number": null,
                          "credit_card_reference": null,
                          "credit_card_type": null,
                          "tax_number_validated_at": null,
                          "tax_number_valid": null,
                          "invoice_workflow_id": null,
                          "estimate_workflow_id": null,
                          "si_identifier": null,
                          "si_identifier_type": null,
                          "moneybird_payments_mandate": false,
                          "created_at": "2026-11-02T12:17:46.108Z",
                          "updated_at": "2026-11-02T12:17:46.108Z",
                          "version": 1793621866,
                          "sales_invoices_url": "https://moneybird.dev/123/sales_invoices/0000000000000000000000000000000000000000000000000000000000000002/all",
                          "notes": [],
                          "custom_fields": [],
                          "contact_people": [],
                          "archived": false
                        },
                        "date": "2026-11-02",
                        "state": "open",
                        "due_date": null,
                        "reference": "Invoice 2",
                        "entry_number": 102,
                        "origin": null,
                        "source": null,
                        "source_url": null,
                        "currency": "EUR",
                        "paid_at": null,
                        "created_at": "2026-11-02T12:17:46.114Z",
                        "updated_at": "2026-11-02T12:17:46.117Z",
                        "version": 1793621866,
                        "details": [
                          {
                            "id": "502689268388333294",
                            "administration_id": 123,
                            "tax_rate_id": "502689108899923082",
                            "ledger_account_id": "502689108787725434",
                            "project_id": null,
                            "product_id": null,
                            "amount": "1 x",
                            "amount_decimal": "1.0",
                            "description": "Invoice detail description",
                            "price": "100.0",
                            "period": null,
                            "row_order": 0,
                            "total_price_excl_tax_with_discount": "100.0",
                            "total_price_excl_tax_with_discount_base": "100.0",
                            "tax_report_reference": [],
                            "mandatory_tax_text": null,
                            "created_at": "2026-11-02T12:17:46.116Z",
                            "updated_at": "2026-11-02T12:17:46.116Z"
                          }
                        ],
                        "payments": [],
                        "total_paid": "0.0",
                        "total_unpaid": "121.0",
                        "total_unpaid_base": "121.0",
                        "prices_are_incl_tax": false,
                        "total_price_excl_tax": "100.0",
                        "total_price_excl_tax_base": "100.0",
                        "total_price_incl_tax": "121.0",
                        "total_price_incl_tax_base": "121.0",
                        "marked_dubious_on": null,
                        "marked_uncollectible_on": null,
                        "notes": [],
                        "attachments": [],
                        "events": [],
                        "tax_totals": [
                          {
                            "tax_rate_id": "502689108899923082",
                            "taxable_amount": "100.0",
                            "taxable_amount_base": "100.0",
                            "tax_amount": "21.0",
                            "tax_amount_base": "21.0"
                          }
                        ]
                      },
                      {
                        "id": "502689268372604649",
                        "administration_id": 123,
                        "contact_id": "502689268364216040",
                        "contact": {
                          "id": "502689268364216040",
                          "administration_id": 123,
                          "company_name": "Relation 1",
                          "firstname": null,
                          "lastname": null,
                          "address1": null,
                          "address2": null,
                          "zipcode": null,
                          "city": null,
                          "country": "NL",
                          "phone": null,
                          "delivery_method": "Email",
                          "customer_id": "customer-1",
                          "tax_number": null,
                          "chamber_of_commerce": null,
                          "bank_account": null,
                          "is_trusted": false,
                          "max_transfer_amount": null,
                          "attention": null,
                          "email": "invoices@example.com",
                          "email_ubl": false,
                          "send_invoices_to_attention": null,
                          "send_invoices_to_email": "invoices@example.com",
                          "send_estimates_to_attention": null,
                          "send_estimates_to_email": "estimates@example.com",
                          "direct_debit": false,
                          "sepa_active": false,
                          "sepa_iban": null,
                          "sepa_iban_account_name": null,
                          "sepa_bic": null,
                          "sepa_mandate_id": null,
                          "sepa_mandate_date": null,
                          "sepa_sequence_type": "RCUR",
                          "credit_card_number": null,
                          "credit_card_reference": null,
                          "credit_card_type": null,
                          "tax_number_validated_at": null,
                          "tax_number_valid": null,
                          "invoice_workflow_id": null,
                          "estimate_workflow_id": null,
                          "si_identifier": null,
                          "si_identifier_type": null,
                          "moneybird_payments_mandate": false,
                          "created_at": "2026-11-02T12:17:46.092Z",
                          "updated_at": "2026-11-02T12:17:46.092Z",
                          "version": 1793621866,
                          "sales_invoices_url": "https://moneybird.dev/123/sales_invoices/0000000000000000000000000000000000000000000000000000000000000001/all",
                          "notes": [],
                          "custom_fields": [],
                          "contact_people": [],
                          "archived": false
                        },
                        "date": "2026-11-02",
                        "state": "open",
                        "due_date": null,
                        "reference": "Invoice 1",
                        "entry_number": 101,
                        "origin": null,
                        "source": null,
                        "source_url": null,
                        "currency": "EUR",
                        "paid_at": null,
                        "created_at": "2026-11-02T12:17:46.100Z",
                        "updated_at": "2026-11-02T12:17:46.104Z",
                        "version": 1793621866,
                        "details": [
                          {
                            "id": "502689268374701802",
                            "administration_id": 123,
                            "tax_rate_id": "502689108899923082",
                            "ledger_account_id": "502689108787725434",
                            "project_id": null,
                            "product_id": null,
                            "amount": "1 x",
                            "amount_decimal": "1.0",
                            "description": "Invoice detail description",
                            "price": "100.0",
                            "period": null,
                            "row_order": 0,
                            "total_price_excl_tax_with_discount": "100.0",
                            "total_price_excl_tax_with_discount_base": "100.0",
                            "tax_report_reference": [],
                            "mandatory_tax_text": null,
                            "created_at": "2026-11-02T12:17:46.102Z",
                            "updated_at": "2026-11-02T12:17:46.102Z"
                          }
                        ],
                        "payments": [],
                        "total_paid": "0.0",
                        "total_unpaid": "121.0",
                        "total_unpaid_base": "121.0",
                        "prices_are_incl_tax": false,
                        "total_price_excl_tax": "100.0",
                        "total_price_excl_tax_base": "100.0",
                        "total_price_incl_tax": "121.0",
                        "total_price_incl_tax_base": "121.0",
                        "marked_dubious_on": null,
                        "marked_uncollectible_on": null,
                        "notes": [],
                        "attachments": [],
                        "events": [],
                        "tax_totals": [
                          {
                            "tax_rate_id": "502689108899923082",
                            "taxable_amount": "100.0",
                            "taxable_amount_base": "100.0",
                            "tax_amount": "21.0",
                            "tax_amount_base": "21.0"
                          }
                        ]
                      }
                    ]
                  },
                  "ReturnsPaginatedExternalSalesInvoicesOnPage2": {
                    "summary": "Returns paginated external sales invoices on page 2",
                    "value": [
                      {
                        "id": "502689268491093758",
                        "administration_id": 123,
                        "contact_id": "502689268486899453",
                        "contact": {
                          "id": "502689268486899453",
                          "administration_id": 123,
                          "company_name": "Relation 3",
                          "firstname": null,
                          "lastname": null,
                          "address1": null,
                          "address2": null,
                          "zipcode": null,
                          "city": null,
                          "country": "NL",
                          "phone": null,
                          "delivery_method": "Email",
                          "customer_id": "customer-3",
                          "tax_number": null,
                          "chamber_of_commerce": null,
                          "bank_account": null,
                          "is_trusted": false,
                          "max_transfer_amount": null,
                          "attention": null,
                          "email": "invoices@example.com",
                          "email_ubl": false,
                          "send_invoices_to_attention": null,
                          "send_invoices_to_email": "invoices@example.com",
                          "send_estimates_to_attention": null,
                          "send_estimates_to_email": "estimates@example.com",
                          "direct_debit": false,
                          "sepa_active": false,
                          "sepa_iban": null,
                          "sepa_iban_account_name": null,
                          "sepa_bic": null,
                          "sepa_mandate_id": null,
                          "sepa_mandate_date": null,
                          "sepa_sequence_type": "RCUR",
                          "credit_card_number": null,
                          "credit_card_reference": null,
                          "credit_card_type": null,
                          "tax_number_validated_at": null,
                          "tax_number_valid": null,
                          "invoice_workflow_id": null,
                          "estimate_workflow_id": null,
                          "si_identifier": null,
                          "si_identifier_type": null,
                          "moneybird_payments_mandate": false,
                          "created_at": "2026-11-02T12:17:46.209Z",
                          "updated_at": "2026-11-02T12:17:46.209Z",
                          "version": 1793621866,
                          "sales_invoices_url": "https://moneybird.dev/123/sales_invoices/0000000000000000000000000000000000000000000000000000000000000003/all",
                          "notes": [],
                          "custom_fields": [],
                          "contact_people": [],
                          "archived": false
                        },
                        "date": "2026-11-02",
                        "state": "open",
                        "due_date": null,
                        "reference": "Invoice 3",
                        "entry_number": 103,
                        "origin": null,
                        "source": null,
                        "source_url": null,
                        "currency": "EUR",
                        "paid_at": null,
                        "created_at": "2026-11-02T12:17:46.214Z",
                        "updated_at": "2026-11-02T12:17:46.216Z",
                        "version": 1793621866,
                        "details": [
                          {
                            "id": "502689268492142335",
                            "administration_id": 123,
                            "tax_rate_id": "502689108899923082",
                            "ledger_account_id": "502689108787725434",
                            "project_id": null,
                            "product_id": null,
                            "amount": "1 x",
                            "amount_decimal": "1.0",
                            "description": "Invoice detail description",
                            "price": "100.0",
                            "period": null,
                            "row_order": 0,
                            "total_price_excl_tax_with_discount": "100.0",
                            "total_price_excl_tax_with_discount_base": "100.0",
                            "tax_report_reference": [],
                            "mandatory_tax_text": null,
                            "created_at": "2026-11-02T12:17:46.215Z",
                            "updated_at": "2026-11-02T12:17:46.215Z"
                          }
                        ],
                        "payments": [],
                        "total_paid": "0.0",
                        "total_unpaid": "121.0",
                        "total_unpaid_base": "121.0",
                        "prices_are_incl_tax": false,
                        "total_price_excl_tax": "100.0",
                        "total_price_excl_tax_base": "100.0",
                        "total_price_incl_tax": "121.0",
                        "total_price_incl_tax_base": "121.0",
                        "marked_dubious_on": null,
                        "marked_uncollectible_on": null,
                        "notes": [],
                        "attachments": [],
                        "events": [],
                        "tax_totals": [
                          {
                            "tax_rate_id": "502689108899923082",
                            "taxable_amount": "100.0",
                            "taxable_amount_base": "100.0",
                            "tax_amount": "21.0",
                            "tax_amount_base": "21.0"
                          }
                        ]
                      }
                    ]
                  },
                  "ReturnsAllInvoicesFilteredOnState": {
                    "summary": "Returns all invoices filtered on state",
                    "value": [
                      {
                        "id": "502689268557154059",
                        "administration_id": 123,
                        "contact_id": "502689268552959754",
                        "contact": {
                          "id": "502689268552959754",
                          "administration_id": 123,
                          "company_name": "Relation 3",
                          "firstname": null,
                          "lastname": null,
                          "address1": null,
                          "address2": null,
                          "zipcode": null,
                          "city": null,
                          "country": "NL",
                          "phone": null,
                          "delivery_method": "Email",
                          "customer_id": "customer-3",
                          "tax_number": null,
                          "chamber_of_commerce": null,
                          "bank_account": null,
                          "is_trusted": false,
                          "max_transfer_amount": null,
                          "attention": null,
                          "email": "invoices@example.com",
                          "email_ubl": false,
                          "send_invoices_to_attention": null,
                          "send_invoices_to_email": "invoices@example.com",
                          "send_estimates_to_attention": null,
                          "send_estimates_to_email": "estimates@example.com",
                          "direct_debit": false,
                          "sepa_active": false,
                          "sepa_iban": null,
                          "sepa_iban_account_name": null,
                          "sepa_bic": null,
                          "sepa_mandate_id": null,
                          "sepa_mandate_date": null,
                          "sepa_sequence_type": "RCUR",
                          "credit_card_number": null,
                          "credit_card_reference": null,
                          "credit_card_type": null,
                          "tax_number_validated_at": null,
                          "tax_number_valid": null,
                          "invoice_workflow_id": null,
                          "estimate_workflow_id": null,
                          "si_identifier": null,
                          "si_identifier_type": null,
                          "moneybird_payments_mandate": false,
                          "created_at": "2026-11-02T12:17:46.272Z",
                          "updated_at": "2026-11-02T12:17:46.272Z",
                          "version": 1793621866,
                          "sales_invoices_url": "https://moneybird.dev/123/sales_invoices/0000000000000000000000000000000000000000000000000000000000000003/all",
                          "notes": [],
                          "custom_fields": [],
                          "contact_people": [],
                          "archived": false
                        },
                        "date": "2026-11-02",
                        "state": "open",
                        "due_date": null,
                        "reference": "Invoice 3",
                        "entry_number": 103,
                        "origin": null,
                        "source": null,
                        "source_url": null,
                        "currency": "EUR",
                        "paid_at": null,
                        "created_at": "2026-11-02T12:17:46.277Z",
                        "updated_at": "2026-11-02T12:17:46.279Z",
                        "version": 1793621866,
                        "details": [
                          {
                            "id": "502689268558202636",
                            "administration_id": 123,
                            "tax_rate_id": "502689108899923082",
                            "ledger_account_id": "502689108787725434",
                            "project_id": null,
                            "product_id": null,
                            "amount": "1 x",
                            "amount_decimal": "1.0",
                            "description": "Invoice detail description",
                            "price": "100.0",
                            "period": null,
                            "row_order": 0,
                            "total_price_excl_tax_with_discount": "100.0",
                            "total_price_excl_tax_with_discount_base": "100.0",
                            "tax_report_reference": [],
                            "mandatory_tax_text": null,
                            "created_at": "2026-11-02T12:17:46.278Z",
                            "updated_at": "2026-11-02T12:17:46.278Z"
                          }
                        ],
                        "payments": [],
                        "total_paid": "0.0",
                        "total_unpaid": "121.0",
                        "total_unpaid_base": "121.0",
                        "prices_are_incl_tax": false,
                        "total_price_excl_tax": "100.0",
                        "total_price_excl_tax_base": "100.0",
                        "total_price_incl_tax": "121.0",
                        "total_price_incl_tax_base": "121.0",
                        "marked_dubious_on": null,
                        "marked_uncollectible_on": null,
                        "notes": [],
                        "attachments": [],
                        "events": [],
                        "tax_totals": [
                          {
                            "tax_rate_id": "502689108899923082",
                            "taxable_amount": "100.0",
                            "taxable_amount_base": "100.0",
                            "tax_amount": "21.0",
                            "tax_amount_base": "21.0"
                          }
                        ]
                      },
                      {
                        "id": "502689268546668295",
                        "administration_id": 123,
                        "contact_id": "502689268541425414",
                        "contact": {
                          "id": "502689268541425414",
                          "administration_id": 123,
                          "company_name": "Relation 2",
                          "firstname": null,
                          "lastname": null,
                          "address1": null,
                          "address2": null,
                          "zipcode": null,
                          "city": null,
                          "country": "NL",
                          "phone": null,
                          "delivery_method": "Email",
                          "customer_id": "customer-2",
                          "tax_number": null,
                          "chamber_of_commerce": null,
                          "bank_account": null,
                          "is_trusted": false,
                          "max_transfer_amount": null,
                          "attention": null,
                          "email": "invoices@example.com",
                          "email_ubl": false,
                          "send_invoices_to_attention": null,
                          "send_invoices_to_email": "invoices@example.com",
                          "send_estimates_to_attention": null,
                          "send_estimates_to_email": "estimates@example.com",
                          "direct_debit": false,
                          "sepa_active": false,
                          "sepa_iban": null,
                          "sepa_iban_account_name": null,
                          "sepa_bic": null,
                          "sepa_mandate_id": null,
                          "sepa_mandate_date": null,
                          "sepa_sequence_type": "RCUR",
                          "credit_card_number": null,
                          "credit_card_reference": null,
                          "credit_card_type": null,
                          "tax_number_validated_at": null,
                          "tax_number_valid": null,
                          "invoice_workflow_id": null,
                          "estimate_workflow_id": null,
                          "si_identifier": null,
                          "si_identifier_type": null,
                          "moneybird_payments_mandate": false,
                          "created_at": "2026-11-02T12:17:46.262Z",
                          "updated_at": "2026-11-02T12:17:46.262Z",
                          "version": 1793621866,
                          "sales_invoices_url": "https://moneybird.dev/123/sales_invoices/0000000000000000000000000000000000000000000000000000000000000002/all",
                          "notes": [],
                          "custom_fields": [],
                          "contact_people": [],
                          "archived": false
                        },
                        "date": "2026-11-02",
                        "state": "open",
                        "due_date": null,
                        "reference": "Invoice 2",
                        "entry_number": 102,
                        "origin": null,
                        "source": null,
                        "source_url": null,
                        "currency": "EUR",
                        "paid_at": null,
                        "created_at": "2026-11-02T12:17:46.267Z",
                        "updated_at": "2026-11-02T12:17:46.269Z",
                        "version": 1793621866,
                        "details": [
                          {
                            "id": "502689268547716872",
                            "administration_id": 123,
                            "tax_rate_id": "502689108899923082",
                            "ledger_account_id": "502689108787725434",
                            "project_id": null,
                            "product_id": null,
                            "amount": "1 x",
                            "amount_decimal": "1.0",
                            "description": "Invoice detail description",
                            "price": "100.0",
                            "period": null,
                            "row_order": 0,
                            "total_price_excl_tax_with_discount": "100.0",
                            "total_price_excl_tax_with_discount_base": "100.0",
                            "tax_report_reference": [],
                            "mandatory_tax_text": null,
                            "created_at": "2026-11-02T12:17:46.268Z",
                            "updated_at": "2026-11-02T12:17:46.268Z"
                          }
                        ],
                        "payments": [],
                        "total_paid": "0.0",
                        "total_unpaid": "121.0",
                        "total_unpaid_base": "121.0",
                        "prices_are_incl_tax": false,
                        "total_price_excl_tax": "100.0",
                        "total_price_excl_tax_base": "100.0",
                        "total_price_incl_tax": "121.0",
                        "total_price_incl_tax_base": "121.0",
                        "marked_dubious_on": null,
                        "marked_uncollectible_on": null,
                        "notes": [],
                        "attachments": [],
                        "events": [],
                        "tax_totals": [
                          {
                            "tax_rate_id": "502689108899923082",
                            "taxable_amount": "100.0",
                            "taxable_amount_base": "100.0",
                            "tax_amount": "21.0",
                            "tax_amount_base": "21.0"
                          }
                        ]
                      },
                      {
                        "id": "502689268534085379",
                        "administration_id": 123,
                        "contact_id": "502689268528842498",
                        "contact": {
                          "id": "502689268528842498",
                          "administration_id": 123,
                          "company_name": "Relation 1",
                          "firstname": null,
                          "lastname": null,
                          "address1": null,
                          "address2": null,
                          "zipcode": null,
                          "city": null,
                          "country": "NL",
                          "phone": null,
                          "delivery_method": "Email",
                          "customer_id": "customer-1",
                          "tax_number": null,
                          "chamber_of_commerce": null,
                          "bank_account": null,
                          "is_trusted": false,
                          "max_transfer_amount": null,
                          "attention": null,
                          "email": "invoices@example.com",
                          "email_ubl": false,
                          "send_invoices_to_attention": null,
                          "send_invoices_to_email": "invoices@example.com",
                          "send_estimates_to_attention": null,
                          "send_estimates_to_email": "estimates@example.com",
                          "direct_debit": false,
                          "sepa_active": false,
                          "sepa_iban": null,
                          "sepa_iban_account_name": null,
                          "sepa_bic": null,
                          "sepa_mandate_id": null,
                          "sepa_mandate_date": null,
                          "sepa_sequence_type": "RCUR",
                          "credit_card_number": null,
                          "credit_card_reference": null,
                          "credit_card_type": null,
                          "tax_number_validated_at": null,
                          "tax_number_valid": null,
                          "invoice_workflow_id": null,
                          "estimate_workflow_id": null,
                          "si_identifier": null,
                          "si_identifier_type": null,
                          "moneybird_payments_mandate": false,
                          "created_at": "2026-11-02T12:17:46.249Z",
                          "updated_at": "2026-11-02T12:17:46.249Z",
                          "version": 1793621866,
                          "sales_invoices_url": "https://moneybird.dev/123/sales_invoices/0000000000000000000000000000000000000000000000000000000000000001/all",
                          "notes": [],
                          "custom_fields": [],
                          "contact_people": [],
                          "archived": false
                        },
                        "date": "2026-11-02",
                        "state": "open",
                        "due_date": null,
                        "reference": "Invoice 1",
                        "entry_number": 101,
                        "origin": null,
                        "source": null,
                        "source_url": null,
                        "currency": "EUR",
                        "paid_at": null,
                        "created_at": "2026-11-02T12:17:46.255Z",
                        "updated_at": "2026-11-02T12:17:46.257Z",
                        "version": 1793621866,
                        "details": [
                          {
                            "id": "502689268536182532",
                            "administration_id": 123,
                            "tax_rate_id": "502689108899923082",
                            "ledger_account_id": "502689108787725434",
                            "project_id": null,
                            "product_id": null,
                            "amount": "1 x",
                            "amount_decimal": "1.0",
                            "description": "Invoice detail description",
                            "price": "100.0",
                            "period": null,
                            "row_order": 0,
                            "total_price_excl_tax_with_discount": "100.0",
                            "total_price_excl_tax_with_discount_base": "100.0",
                            "tax_report_reference": [],
                            "mandatory_tax_text": null,
                            "created_at": "2026-11-02T12:17:46.256Z",
                            "updated_at": "2026-11-02T12:17:46.256Z"
                          }
                        ],
                        "payments": [],
                        "total_paid": "0.0",
                        "total_unpaid": "121.0",
                        "total_unpaid_base": "121.0",
                        "prices_are_incl_tax": false,
                        "total_price_excl_tax": "100.0",
                        "total_price_excl_tax_base": "100.0",
                        "total_price_incl_tax": "121.0",
                        "total_price_incl_tax_base": "121.0",
                        "marked_dubious_on": null,
                        "marked_uncollectible_on": null,
                        "notes": [],
                        "attachments": [],
                        "events": [],
                        "tax_totals": [
                          {
                            "tax_rate_id": "502689108899923082",
                            "taxable_amount": "100.0",
                            "taxable_amount_base": "100.0",
                            "tax_amount": "21.0",
                            "tax_amount_base": "21.0"
                          }
                        ]
                      }
                    ]
                  },
                  "ReturnsAllExternalSalesInvoicesOfAnAdministration": {
                    "summary": "Returns all external sales invoices of an administration",
                    "value": [
                      {
                        "id": "502689268646283034",
                        "administration_id": 123,
                        "contact_id": null,
                        "contact": null,
                        "date": "2026-11-02",
                        "state": "new",
                        "due_date": null,
                        "reference": "Invoice 4",
                        "entry_number": 104,
                        "origin": null,
                        "source": null,
                        "source_url": null,
                        "currency": "EUR",
                        "paid_at": null,
                        "created_at": "2026-11-02T12:17:46.361Z",
                        "updated_at": "2026-11-02T12:17:46.361Z",
                        "version": 1793621866,
                        "details": [],
                        "payments": [],
                        "total_paid": "0.0",
                        "total_unpaid": "121.0",
                        "total_unpaid_base": "121.0",
                        "prices_are_incl_tax": false,
                        "total_price_excl_tax": "100.0",
                        "total_price_excl_tax_base": "100.0",
                        "total_price_incl_tax": "121.0",
                        "total_price_incl_tax_base": "121.0",
                        "marked_dubious_on": null,
                        "marked_uncollectible_on": null,
                        "notes": [],
                        "attachments": [],
                        "events": [],
                        "tax_totals": []
                      },
                      {
                        "id": "502689268639991576",
                        "administration_id": 123,
                        "contact_id": "502689268634748695",
                        "contact": {
                          "id": "502689268634748695",
                          "administration_id": 123,
                          "company_name": "Relation 3",
                          "firstname": null,
                          "lastname": null,
                          "address1": null,
                          "address2": null,
                          "zipcode": null,
                          "city": null,
                          "country": "NL",
                          "phone": null,
                          "delivery_method": "Email",
                          "customer_id": "customer-3",
                          "tax_number": null,
                          "chamber_of_commerce": null,
                          "bank_account": null,
                          "is_trusted": false,
                          "max_transfer_amount": null,
                          "attention": null,
                          "email": "invoices@example.com",
                          "email_ubl": false,
                          "send_invoices_to_attention": null,
                          "send_invoices_to_email": "invoices@example.com",
                          "send_estimates_to_attention": null,
                          "send_estimates_to_email": "estimates@example.com",
                          "direct_debit": false,
                          "sepa_active": false,
                          "sepa_iban": null,
                          "sepa_iban_account_name": null,
                          "sepa_bic": null,
                          "sepa_mandate_id": null,
                          "sepa_mandate_date": null,
                          "sepa_sequence_type": "RCUR",
                          "credit_card_number": null,
                          "credit_card_reference": null,
                          "credit_card_type": null,
                          "tax_number_validated_at": null,
                          "tax_number_valid": null,
                          "invoice_workflow_id": null,
                          "estimate_workflow_id": null,
                          "si_identifier": null,
                          "si_identifier_type": null,
                          "moneybird_payments_mandate": false,
                          "created_at": "2026-11-02T12:17:46.350Z",
                          "updated_at": "2026-11-02T12:17:46.350Z",
                          "version": 1793621866,
                          "sales_invoices_url": "https://moneybird.dev/123/sales_invoices/0000000000000000000000000000000000000000000000000000000000000003/all",
                          "notes": [],
                          "custom_fields": [],
                          "contact_people": [],
                          "archived": false
                        },
                        "date": "2026-11-02",
                        "state": "open",
                        "due_date": null,
                        "reference": "Invoice 3",
                        "entry_number": 103,
                        "origin": null,
                        "source": null,
                        "source_url": null,
                        "currency": "EUR",
                        "paid_at": null,
                        "created_at": "2026-11-02T12:17:46.356Z",
                        "updated_at": "2026-11-02T12:17:46.358Z",
                        "version": 1793621866,
                        "details": [
                          {
                            "id": "502689268641040153",
                            "administration_id": 123,
                            "tax_rate_id": "502689108899923082",
                            "ledger_account_id": "502689108787725434",
                            "project_id": null,
                            "product_id": null,
                            "amount": "1 x",
                            "amount_decimal": "1.0",
                            "description": "Invoice detail description",
                            "price": "100.0",
                            "period": null,
                            "row_order": 0,
                            "total_price_excl_tax_with_discount": "100.0",
                            "total_price_excl_tax_with_discount_base": "100.0",
                            "tax_report_reference": [],
                            "mandatory_tax_text": null,
                            "created_at": "2026-11-02T12:17:46.357Z",
                            "updated_at": "2026-11-02T12:17:46.357Z"
                          }
                        ],
                        "payments": [],
                        "total_paid": "0.0",
                        "total_unpaid": "121.0",
                        "total_unpaid_base": "121.0",
                        "prices_are_incl_tax": false,
                        "total_price_excl_tax": "100.0",
                        "total_price_excl_tax_base": "100.0",
                        "total_price_incl_tax": "121.0",
                        "total_price_incl_tax_base": "121.0",
                        "marked_dubious_on": null,
                        "marked_uncollectible_on": null,
                        "notes": [],
                        "attachments": [],
                        "events": [],
                        "tax_totals": [
                          {
                            "tax_rate_id": "502689108899923082",
                            "taxable_amount": "100.0",
                            "taxable_amount_base": "100.0",
                            "tax_amount": "21.0",
                            "tax_amount_base": "21.0"
                          }
                        ]
                      },
                      {
                        "id": "502689268627408660",
                        "administration_id": 123,
                        "contact_id": "502689268621117203",
                        "contact": {
                          "id": "502689268621117203",
                          "administration_id": 123,
                          "company_name": "Relation 2",
                          "firstname": null,
                          "lastname": null,
                          "address1": null,
                          "address2": null,
                          "zipcode": null,
                          "city": null,
                          "country": "NL",
                          "phone": null,
                          "delivery_method": "Email",
                          "customer_id": "customer-2",
                          "tax_number": null,
                          "chamber_of_commerce": null,
                          "bank_account": null,
                          "is_trusted": false,
                          "max_transfer_amount": null,
                          "attention": null,
                          "email": "invoices@example.com",
                          "email_ubl": false,
                          "send_invoices_to_attention": null,
                          "send_invoices_to_email": "invoices@example.com",
                          "send_estimates_to_attention": null,
                          "send_estimates_to_email": "estimates@example.com",
                          "direct_debit": false,
                          "sepa_active": false,
                          "sepa_iban": null,
                          "sepa_iban_account_name": null,
                          "sepa_bic": null,
                          "sepa_mandate_id": null,
                          "sepa_mandate_date": null,
                          "sepa_sequence_type": "RCUR",
                          "credit_card_number": null,
                          "credit_card_reference": null,
                          "credit_card_type": null,
                          "tax_number_validated_at": null,
                          "tax_number_valid": null,
                          "invoice_workflow_id": null,
                          "estimate_workflow_id": null,
                          "si_identifier": null,
                          "si_identifier_type": null,
                          "moneybird_payments_mandate": false,
                          "created_at": "2026-11-02T12:17:46.338Z",
                          "updated_at": "2026-11-02T12:17:46.338Z",
                          "version": 1793621866,
                          "sales_invoices_url": "https://moneybird.dev/123/sales_invoices/0000000000000000000000000000000000000000000000000000000000000002/all",
                          "notes": [],
                          "custom_fields": [],
                          "contact_people": [],
                          "archived": false
                        },
                        "date": "2026-11-02",
                        "state": "open",
                        "due_date": null,
                        "reference": "Invoice 2",
                        "entry_number": 102,
                        "origin": null,
                        "source": null,
                        "source_url": null,
                        "currency": "EUR",
                        "paid_at": null,
                        "created_at": "2026-11-02T12:17:46.343Z",
                        "updated_at": "2026-11-02T12:17:46.346Z",
                        "version": 1793621866,
                        "details": [
                          {
                            "id": "502689268628457237",
                            "administration_id": 123,
                            "tax_rate_id": "502689108899923082",
                            "ledger_account_id": "502689108787725434",
                            "project_id": null,
                            "product_id": null,
                            "amount": "1 x",
                            "amount_decimal": "1.0",
                            "description": "Invoice detail description",
                            "price": "100.0",
                            "period": null,
                            "row_order": 0,
                            "total_price_excl_tax_with_discount": "100.0",
                            "total_price_excl_tax_with_discount_base": "100.0",
                            "tax_report_reference": [],
                            "mandatory_tax_text": null,
                            "created_at": "2026-11-02T12:17:46.344Z",
                            "updated_at": "2026-11-02T12:17:46.344Z"
                          }
                        ],
                        "payments": [],
                        "total_paid": "0.0",
                        "total_unpaid": "121.0",
                        "total_unpaid_base": "121.0",
                        "prices_are_incl_tax": false,
                        "total_price_excl_tax": "100.0",
                        "total_price_excl_tax_base": "100.0",
                        "total_price_incl_tax": "121.0",
                        "total_price_incl_tax_base": "121.0",
                        "marked_dubious_on": null,
                        "marked_uncollectible_on": null,
                        "notes": [],
                        "attachments": [],
                        "events": [],
                        "tax_totals": [
                          {
                            "tax_rate_id": "502689108899923082",
                            "taxable_amount": "100.0",
                            "taxable_amount_base": "100.0",
                            "tax_amount": "21.0",
                            "tax_amount_base": "21.0"
                          }
                        ]
                      },
                      {
                        "id": "502689268614825744",
                        "administration_id": 123,
                        "contact_id": "502689268607485711",
                        "contact": {
                          "id": "502689268607485711",
                          "administration_id": 123,
                          "company_name": "Relation 1",
                          "firstname": null,
                          "lastname": null,
                          "address1": null,
                          "address2": null,
                          "zipcode": null,
                          "city": null,
                          "country": "NL",
                          "phone": null,
                          "delivery_method": "Email",
                          "customer_id": "customer-1",
                          "tax_number": null,
                          "chamber_of_commerce": null,
                          "bank_account": null,
                          "is_trusted": false,
                          "max_transfer_amount": null,
                          "attention": null,
                          "email": "invoices@example.com",
                          "email_ubl": false,
                          "send_invoices_to_attention": null,
                          "send_invoices_to_email": "invoices@example.com",
                          "send_estimates_to_attention": null,
                          "send_estimates_to_email": "estimates@example.com",
                          "direct_debit": false,
                          "sepa_active": false,
                          "sepa_iban": null,
                          "sepa_iban_account_name": null,
                          "sepa_bic": null,
                          "sepa_mandate_id": null,
                          "sepa_mandate_date": null,
                          "sepa_sequence_type": "RCUR",
                          "credit_card_number": null,
                          "credit_card_reference": null,
                          "credit_card_type": null,
                          "tax_number_validated_at": null,
                          "tax_number_valid": null,
                          "invoice_workflow_id": null,
                          "estimate_workflow_id": null,
                          "si_identifier": null,
                          "si_identifier_type": null,
                          "moneybird_payments_mandate": false,
                          "created_at": "2026-11-02T12:17:46.325Z",
                          "updated_at": "2026-11-02T12:17:46.325Z",
                          "version": 1793621866,
                          "sales_invoices_url": "https://moneybird.dev/123/sales_invoices/0000000000000000000000000000000000000000000000000000000000000001/all",
                          "notes": [],
                          "custom_fields": [],
                          "contact_people": [],
                          "archived": false
                        },
                        "date": "2026-11-02",
                        "state": "open",
                        "due_date": null,
                        "reference": "Invoice 1",
                        "entry_number": 101,
                        "origin": null,
                        "source": null,
                        "source_url": null,
                        "currency": "EUR",
                        "paid_at": null,
                        "created_at": "2026-11-02T12:17:46.331Z",
                        "updated_at": "2026-11-02T12:17:46.333Z",
                        "version": 1793621866,
                        "details": [
                          {
                            "id": "502689268615874321",
                            "administration_id": 123,
                            "tax_rate_id": "502689108899923082",
                            "ledger_account_id": "502689108787725434",
                            "project_id": null,
                            "product_id": null,
                            "amount": "1 x",
                            "amount_decimal": "1.0",
                            "description": "Invoice detail description",
                            "price": "100.0",
                            "period": null,
                            "row_order": 0,
                            "total_price_excl_tax_with_discount": "100.0",
                            "total_price_excl_tax_with_discount_base": "100.0",
                            "tax_report_reference": [],
                            "mandatory_tax_text": null,
                            "created_at": "2026-11-02T12:17:46.332Z",
                            "updated_at": "2026-11-02T12:17:46.332Z"
                          }
                        ],
                        "payments": [],
                        "total_paid": "0.0",
                        "total_unpaid": "121.0",
                        "total_unpaid_base": "121.0",
                        "prices_are_incl_tax": false,
                        "total_price_excl_tax": "100.0",
                        "total_price_excl_tax_base": "100.0",
                        "total_price_incl_tax": "121.0",
                        "total_price_incl_tax_base": "121.0",
                        "marked_dubious_on": null,
                        "marked_uncollectible_on": null,
                        "notes": [],
                        "attachments": [],
                        "events": [],
                        "tax_totals": [
                          {
                            "tax_rate_id": "502689108899923082",
                            "taxable_amount": "100.0",
                            "taxable_amount_base": "100.0",
                            "tax_amount": "21.0",
                            "tax_amount_base": "21.0"
                          }
                        ]
                      }
                    ]
                  },
                  "ReturnsPaginatedExternalSalesInvoicesOnPage1": {
                    "summary": "Returns paginated external sales invoices on page 1",
                    "value": [
                      {
                        "id": "502689268787840820",
                        "administration_id": 123,
                        "contact_id": null,
                        "contact": null,
                        "date": "2026-11-02",
                        "state": "new",
                        "due_date": null,
                        "reference": "Invoice 4",
                        "entry_number": 104,
                        "origin": null,
                        "source": null,
                        "source_url": null,
                        "currency": "EUR",
                        "paid_at": null,
                        "created_at": "2026-11-02T12:17:46.496Z",
                        "updated_at": "2026-11-02T12:17:46.496Z",
                        "version": 1793621866,
                        "details": [],
                        "payments": [],
                        "total_paid": "0.0",
                        "total_unpaid": "121.0",
                        "total_unpaid_base": "121.0",
                        "prices_are_incl_tax": false,
                        "total_price_excl_tax": "100.0",
                        "total_price_excl_tax_base": "100.0",
                        "total_price_incl_tax": "121.0",
                        "total_price_incl_tax_base": "121.0",
                        "marked_dubious_on": null,
                        "marked_uncollectible_on": null,
                        "notes": [],
                        "attachments": [],
                        "events": [],
                        "tax_totals": []
                      }
                    ]
                  }
                }
              }
            }
          },
          "400": {
            "description": "Bad request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/symbolic_error"
                },
                "examples": {
                  "ReturnsAnErrorWhenTooManyExternalSalesInvoicesAreRequested": {
                    "summary": "Returns an error when too many external sales invoices are requested",
                    "value": {
                      "error": "per_page does not have a valid value"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Not found",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/symbolic_error"
                },
                "examples": {
                  "ReturnsAnErrorMessageIfFilterContactIdIsNotFound": {
                    "summary": "Returns an error message if filter contact id is not found",
                    "value": {
                      "error": "record not found",
                      "symbolic": {
                        "contact_id": "not_found"
                      }
                    }
                  }
                }
              }
            }
          }
        },
        "operationId": "get_administration_id_external_sales_invoices"
      },
      "post": {
        "summary": "Create an external sales invoice",
        "description": "Creates a new external sales invoice.\n\n### Required scope(s)\n `sales_invoices`",
        "tags": [
          "External sales invoices"
        ],
        "security": [
          {
            "bearerAuth": [
              "sales_invoices"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/administration_id"
          },
          {
            "$ref": "#/components/parameters/format"
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/*": {
              "schema": {
                "unevaluatedProperties": false,
                "type": "object",
                "properties": {
                  "external_sales_invoice": {
                    "type": "object",
                    "unevaluatedProperties": false,
                    "properties": {
                      "contact_id": {
                        "$ref": "#/components/schemas/identifier",
                        "description": "Should be a valid contact id."
                      },
                      "reference": {
                        "type": "string",
                        "description": "The invoice number or reference from the external system that created this invoice, e.g. a webshop order ID."
                      },
                      "date": {
                        "type": "string",
                        "description": "The date of the invoice.",
                        "format": "date"
                      },
                      "due_date": {
                        "type": "string",
                        "description": "The date by which the invoice should be paid.",
                        "format": "date"
                      },
                      "currency": {
                        "type": "string",
                        "description": "ISO three-character currency code, e.g. EUR or USD."
                      },
                      "prices_are_incl_tax": {
                        "type": [
                          "boolean",
                          "string"
                        ],
                        "description": "Whether the prices on the invoice are inclusive of tax. Defaults to the administration setting."
                      },
                      "source": {
                        "type": "string",
                        "description": "The name of the external system that created this invoice, e.g. your webshop or POS system name."
                      },
                      "source_url": {
                        "type": "string",
                        "description": "A URL linking back to the invoice in the external system."
                      },
                      "details_attributes": {
                        "$ref": "#/components/schemas/details_attributes"
                      }
                    },
                    "required": []
                  }
                },
                "required": []
              },
              "examples": {
                "CreateAnExternalSalesInvoiceInAForeignCurrency": {
                  "summary": "Create an external sales invoice in a foreign currency",
                  "value": {
                    "external_sales_invoice": {
                      "reference": "30052",
                      "contact_id": 502689270549448640,
                      "currency": "USD",
                      "details_attributes": [
                        {
                          "description": "Rocking Chair",
                          "price": 159.99,
                          "tax_rate_id": 502689270545254340
                        }
                      ]
                    }
                  }
                },
                "CreateABasicExternalSalesInvoice": {
                  "summary": "Create a basic external sales invoice",
                  "value": {
                    "external_sales_invoice": {
                      "reference": "30052",
                      "contact_id": 502689270630189000,
                      "details_attributes": [
                        {
                          "description": "Rocking Chair",
                          "price": 129.95
                        }
                      ]
                    }
                  }
                }
              }
            }
          }
        },
        "responses": {
          "201": {
            "description": "External sales invoice created",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/external_sales_invoice_response"
                },
                "examples": {
                  "CreateAnExternalSalesInvoiceInAForeignCurrency": {
                    "summary": "Create an external sales invoice in a foreign currency",
                    "value": {
                      "id": "502689270571468729",
                      "administration_id": 123,
                      "contact_id": "502689270549448631",
                      "contact": {
                        "id": "502689270549448631",
                        "administration_id": 123,
                        "company_name": "Relation 2",
                        "firstname": null,
                        "lastname": null,
                        "address1": null,
                        "address2": null,
                        "zipcode": null,
                        "city": null,
                        "country": "NL",
                        "phone": null,
                        "delivery_method": "Email",
                        "customer_id": "customer-2",
                        "tax_number": "BE0123456789",
                        "chamber_of_commerce": null,
                        "bank_account": null,
                        "is_trusted": false,
                        "max_transfer_amount": null,
                        "attention": null,
                        "email": "invoices@example.com",
                        "email_ubl": false,
                        "send_invoices_to_attention": null,
                        "send_invoices_to_email": "invoices@example.com",
                        "send_estimates_to_attention": null,
                        "send_estimates_to_email": "estimates@example.com",
                        "direct_debit": false,
                        "sepa_active": false,
                        "sepa_iban": null,
                        "sepa_iban_account_name": null,
                        "sepa_bic": null,
                        "sepa_mandate_id": null,
                        "sepa_mandate_date": null,
                        "sepa_sequence_type": "RCUR",
                        "credit_card_number": null,
                        "credit_card_reference": null,
                        "credit_card_type": null,
                        "tax_number_validated_at": "2026-11-02T12:17:48.174Z",
                        "tax_number_valid": true,
                        "invoice_workflow_id": null,
                        "estimate_workflow_id": null,
                        "si_identifier": null,
                        "si_identifier_type": null,
                        "moneybird_payments_mandate": false,
                        "created_at": "2026-11-02T12:17:48.176Z",
                        "updated_at": "2026-11-02T12:17:48.176Z",
                        "version": 1793621868,
                        "sales_invoices_url": "https://moneybird.dev/123/sales_invoices/0000000000000000000000000000000000000000000000000000000000000002/all",
                        "notes": [],
                        "custom_fields": [],
                        "contact_people": [],
                        "archived": false
                      },
                      "date": "2026-11-02",
                      "state": "open",
                      "due_date": null,
                      "reference": "30052",
                      "entry_number": 1,
                      "origin": "api",
                      "source": null,
                      "source_url": null,
                      "currency": "USD",
                      "paid_at": null,
                      "created_at": "2026-11-02T12:17:48.197Z",
                      "updated_at": "2026-11-02T12:17:48.201Z",
                      "version": 1793621868,
                      "details": [
                        {
                          "id": "502689270573565882",
                          "administration_id": 123,
                          "tax_rate_id": "502689270545254325",
                          "ledger_account_id": "502689108787725434",
                          "project_id": null,
                          "product_id": null,
                          "amount": null,
                          "amount_decimal": "1.0",
                          "description": "Rocking Chair",
                          "price": "159.99",
                          "period": null,
                          "row_order": 0,
                          "total_price_excl_tax_with_discount": "159.99",
                          "total_price_excl_tax_with_discount_base": "127.99",
                          "tax_report_reference": [
                            "NL/3a"
                          ],
                          "mandatory_tax_text": "Intracommunautaire levering, artikel 138, lid 1, Richtlijn 2006/112",
                          "created_at": "2026-11-02T12:17:48.199Z",
                          "updated_at": "2026-11-02T12:17:48.199Z"
                        }
                      ],
                      "payments": [],
                      "total_paid": "0.0",
                      "total_unpaid": "159.99",
                      "total_unpaid_base": "127.99",
                      "prices_are_incl_tax": false,
                      "total_price_excl_tax": "159.99",
                      "total_price_excl_tax_base": "127.99",
                      "total_price_incl_tax": "159.99",
                      "total_price_incl_tax_base": "127.99",
                      "marked_dubious_on": null,
                      "marked_uncollectible_on": null,
                      "notes": [],
                      "attachments": [],
                      "events": [
                        {
                          "administration_id": 123,
                          "user_id": "502689108256097381",
                          "action": "external_sales_invoice_created",
                          "link_entity_id": null,
                          "link_entity_type": null,
                          "data": {},
                          "created_at": "2026-11-02T12:17:48.202Z",
                          "updated_at": "2026-11-02T12:17:48.202Z"
                        },
                        {
                          "administration_id": 123,
                          "user_id": "502689108256097381",
                          "action": "external_sales_invoice_saved",
                          "link_entity_id": null,
                          "link_entity_type": null,
                          "data": {},
                          "created_at": "2026-11-02T12:17:48.204Z",
                          "updated_at": "2026-11-02T12:17:48.204Z"
                        }
                      ],
                      "tax_totals": []
                    }
                  },
                  "CreateABasicExternalSalesInvoice": {
                    "summary": "Create a basic external sales invoice",
                    "value": {
                      "id": "502689270649063370",
                      "administration_id": 123,
                      "contact_id": "502689270630189000",
                      "contact": {
                        "id": "502689270630189000",
                        "administration_id": 123,
                        "company_name": "Relation 2",
                        "firstname": null,
                        "lastname": null,
                        "address1": null,
                        "address2": null,
                        "zipcode": null,
                        "city": null,
                        "country": "NL",
                        "phone": null,
                        "delivery_method": "Email",
                        "customer_id": "customer-2",
                        "tax_number": "BE0123456789",
                        "chamber_of_commerce": null,
                        "bank_account": null,
                        "is_trusted": false,
                        "max_transfer_amount": null,
                        "attention": null,
                        "email": "invoices@example.com",
                        "email_ubl": false,
                        "send_invoices_to_attention": null,
                        "send_invoices_to_email": "invoices@example.com",
                        "send_estimates_to_attention": null,
                        "send_estimates_to_email": "estimates@example.com",
                        "direct_debit": false,
                        "sepa_active": false,
                        "sepa_iban": null,
                        "sepa_iban_account_name": null,
                        "sepa_bic": null,
                        "sepa_mandate_id": null,
                        "sepa_mandate_date": null,
                        "sepa_sequence_type": "RCUR",
                        "credit_card_number": null,
                        "credit_card_reference": null,
                        "credit_card_type": null,
                        "tax_number_validated_at": "2026-11-02T12:17:48.252Z",
                        "tax_number_valid": true,
                        "invoice_workflow_id": null,
                        "estimate_workflow_id": null,
                        "si_identifier": null,
                        "si_identifier_type": null,
                        "moneybird_payments_mandate": false,
                        "created_at": "2026-11-02T12:17:48.254Z",
                        "updated_at": "2026-11-02T12:17:48.254Z",
                        "version": 1793621868,
                        "sales_invoices_url": "https://moneybird.dev/123/sales_invoices/0000000000000000000000000000000000000000000000000000000000000002/all",
                        "notes": [],
                        "custom_fields": [],
                        "contact_people": [],
                        "archived": false
                      },
                      "date": "2026-11-02",
                      "state": "open",
                      "due_date": null,
                      "reference": "30052",
                      "entry_number": 1,
                      "origin": "api",
                      "source": null,
                      "source_url": null,
                      "currency": "EUR",
                      "paid_at": null,
                      "created_at": "2026-11-02T12:17:48.271Z",
                      "updated_at": "2026-11-02T12:17:48.274Z",
                      "version": 1793621868,
                      "details": [
                        {
                          "id": "502689270650111947",
                          "administration_id": 123,
                          "tax_rate_id": "502689108899923082",
                          "ledger_account_id": "502689108787725434",
                          "project_id": null,
                          "product_id": null,
                          "amount": null,
                          "amount_decimal": "1.0",
                          "description": "Rocking Chair",
                          "price": "129.95",
                          "period": null,
                          "row_order": 0,
                          "total_price_excl_tax_with_discount": "129.95",
                          "total_price_excl_tax_with_discount_base": "129.95",
                          "tax_report_reference": [
                            "NL/1a"
                          ],
                          "mandatory_tax_text": null,
                          "created_at": "2026-11-02T12:17:48.273Z",
                          "updated_at": "2026-11-02T12:17:48.273Z"
                        }
                      ],
                      "payments": [],
                      "total_paid": "0.0",
                      "total_unpaid": "157.24",
                      "total_unpaid_base": "157.24",
                      "prices_are_incl_tax": false,
                      "total_price_excl_tax": "129.95",
                      "total_price_excl_tax_base": "129.95",
                      "total_price_incl_tax": "157.24",
                      "total_price_incl_tax_base": "157.24",
                      "marked_dubious_on": null,
                      "marked_uncollectible_on": null,
                      "notes": [],
                      "attachments": [],
                      "events": [
                        {
                          "administration_id": 123,
                          "user_id": "502689108256097381",
                          "action": "external_sales_invoice_created",
                          "link_entity_id": null,
                          "link_entity_type": null,
                          "data": {},
                          "created_at": "2026-11-02T12:17:48.275Z",
                          "updated_at": "2026-11-02T12:17:48.275Z"
                        },
                        {
                          "administration_id": 123,
                          "user_id": "502689108256097381",
                          "action": "external_sales_invoice_saved",
                          "link_entity_id": null,
                          "link_entity_type": null,
                          "data": {},
                          "created_at": "2026-11-02T12:17:48.276Z",
                          "updated_at": "2026-11-02T12:17:48.276Z"
                        }
                      ],
                      "tax_totals": [
                        {
                          "tax_rate_id": "502689108899923082",
                          "taxable_amount": "129.95",
                          "taxable_amount_base": "129.95",
                          "tax_amount": "27.29",
                          "tax_amount_base": "27.29"
                        }
                      ]
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "Bad request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/symbolic_error"
                },
                "examples": {
                  "Returns400WhenRequiredParamsAreIncorrect": {
                    "summary": "Returns 400 when required params are incorrect",
                    "value": {
                      "error": "Contact ID is invalid",
                      "symbolic": {
                        "external_sales_invoice": {
                          "contact_id": "contact_invalid"
                        }
                      }
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "Unprocessable entity",
            "content": {
              "application/json": {
                "schema": {
                  "anyOf": [
                    {
                      "$ref": "#/components/schemas/symbolic_error"
                    },
                    {
                      "$ref": "#/components/schemas/non_symbolic_error"
                    }
                  ]
                },
                "examples": {
                  "Returns422WhenADetailReferencesAUnknownProjectIdForThisAdministration": {
                    "summary": "Returns 422 when a detail references a unknown project id for this administration",
                    "value": {
                      "error": {
                        "details.project_id": [
                          "is not found"
                        ],
                        "reference": [
                          "can't be blank"
                        ]
                      },
                      "details": {
                        "details.project_id": [
                          {
                            "error": "invalid"
                          }
                        ],
                        "reference": [
                          {
                            "error": "blank"
                          }
                        ]
                      }
                    }
                  },
                  "Returns422WhenDateIsNotAValidDateString": {
                    "summary": "Returns 422 when date is not a valid date string",
                    "value": {
                      "error": {
                        "date": [
                          "is not a valid date"
                        ],
                        "reference": [
                          "can't be blank"
                        ]
                      },
                      "details": {
                        "date": [
                          {
                            "error": "is not a valid date"
                          }
                        ],
                        "reference": [
                          {
                            "error": "blank"
                          }
                        ]
                      }
                    }
                  }
                }
              }
            }
          }
        },
        "operationId": "post_administration_id_external_sales_invoices"
      }
    },
    "/{administration_id}/financial_accounts{format}": {
      "get": {
        "summary": "Retrieve all available financial accounts for the administration",
        "description": "Retrieve the financial accounts for the administration. Only active financial accounts are returned; inactive (archived) accounts are omitted.\n\n### Required scope(s)\n `settings`",
        "tags": [
          "Financial accounts"
        ],
        "security": [
          {
            "bearerAuth": [
              "settings"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/administration_id"
          },
          {
            "$ref": "#/components/parameters/format"
          }
        ],
        "responses": {
          "200": {
            "description": "A list of financial accounts",
            "content": {
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "$ref": "#/components/schemas/financial_account_response"
                  }
                },
                "examples": {
                  "ReturnsAllFinancialAccountsOfAnAdministration": {
                    "summary": "Returns all financial accounts of an administration",
                    "value": [
                      {
                        "id": "502689174687581372",
                        "administration_id": 123,
                        "type": "CreditCardAccount",
                        "name": "Creditcard 0001",
                        "identifier": "0001",
                        "currency": "EUR",
                        "provider": null,
                        "moneybird_account": false,
                        "active": true,
                        "created_at": "2026-11-02T12:16:16.756Z",
                        "updated_at": "2026-11-02T12:16:16.756Z"
                      },
                      {
                        "id": "502689174700164287",
                        "administration_id": 123,
                        "type": "BankAccount",
                        "name": "Moneybird NL91ADYB2006011082",
                        "identifier": "NL91ADYB2006011082",
                        "currency": "EUR",
                        "provider": null,
                        "moneybird_account": true,
                        "active": true,
                        "created_at": "2026-11-02T12:16:16.767Z",
                        "updated_at": "2026-11-02T12:16:16.767Z"
                      }
                    ]
                  }
                }
              }
            }
          }
        },
        "operationId": "get_administration_id_financial_accounts"
      }
    },
    "/{administration_id}/financial_mutations/synchronization{format}": {
      "get": {
        "summary": "List all ids and versions",
        "description": "Returns the financial mutations that match the filter. The list contains the id and the version of the financial mutation.\nCheck if the version of the financial mutation is newer than the version you have stored locally, use the `POST`\nvariant for fetching financial mutations with the given ids.\n\n### Required scope(s)\n `bank`",
        "tags": [
          "Financial mutations"
        ],
        "security": [
          {
            "bearerAuth": [
              "bank"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/administration_id"
          },
          {
            "$ref": "#/components/parameters/format"
          },
          {
            "name": "filter",
            "in": "query",
            "required": false,
            "description": "Filters are `key:value` terms separated by commas (e.g. `period:this_year,state:all`). Any filter you pass replaces the defaults below entirely, so include every key you need. Available filters:\n\n| **Filter** | **Type** | **Default** | **Description** |\n| - | - | - | - |\n| period | `String` | `this_year` | This can either be the description of a period (`this_week`, `prev_week`, `next_week`, `this_month`, `prev_month`, `next_month`, `this_quarter`, `prev_quarter`, `next_quarter`, `this_year`, `prev_year`, `next_year`) or a custom period (`201301..201302`, `20130101..20130131`). A custom period must have a start and an end date. It must not be longer than 10 years and must be between `20000101` and `21000101`. For one month, use `202401..202401`, not `202401`. Without `period`, the filter does not limit the dates. The default `this_year` applies only when you send no `filter`. |\n| state | `String` | | Can be `all`, `unprocessed` or `processed`|\n| mutation_type | `String` | | Can be `all`, `debit` or `credit` |\n| financial_account_id | `String` | |",
            "schema": {
              "type": "string",
              "default": "period:this_year"
            },
            "examples": {
              "RetrievesTheIdSForSynchronizationWithAFilter": {
                "summary": "Retrieves the id's for synchronization with a filter",
                "value": "period:this_month"
              }
            }
          }
        ],
        "responses": {
          "200": {
            "description": "IDs and versions of records",
            "content": {
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "type": "object",
                    "unevaluatedProperties": false,
                    "properties": {
                      "id": {
                        "type": [
                          "integer",
                          "string"
                        ]
                      },
                      "version": {
                        "type": [
                          "integer",
                          "string"
                        ]
                      }
                    }
                  }
                },
                "examples": {
                  "RetrievesTheIdSForSynchronization": {
                    "summary": "Retrieves the id's for synchronization",
                    "value": [
                      {
                        "id": "502689240657692210",
                        "version": 1793621839
                      },
                      {
                        "id": "502689240672372283",
                        "version": 1793621839
                      },
                      {
                        "id": "502689240689149508",
                        "version": 1793621839
                      }
                    ]
                  },
                  "RetrievesTheIdSForSynchronizationWithAFilter": {
                    "summary": "Retrieves the id's for synchronization with a filter",
                    "value": [
                      {
                        "id": "502689240736335440",
                        "version": 1793621839
                      },
                      {
                        "id": "502689240752064089",
                        "version": 1793621839
                      },
                      {
                        "id": "502689240770938466",
                        "version": 1793621839
                      }
                    ]
                  }
                }
              }
            }
          }
        },
        "operationId": "get_administration_id_financial_mutations_synchronization"
      },
      "post": {
        "summary": "Fetch financial mutations with given ids",
        "x-query": true,
        "description": "Given a list of financial mutation ids, returns the financial mutation information belonging to the financial mutation.\nReturns a maximum of 100 financial mutations, even if more ids are provided.\n\n### Required scope(s)\n `bank`",
        "tags": [
          "Financial mutations"
        ],
        "security": [
          {
            "bearerAuth": [
              "bank"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/administration_id"
          },
          {
            "$ref": "#/components/parameters/format"
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/*": {
              "schema": {
                "unevaluatedProperties": false,
                "type": "object",
                "properties": {
                  "ids": {
                    "type": "array",
                    "items": {
                      "type": [
                        "integer",
                        "string"
                      ]
                    }
                  }
                },
                "required": [
                  "ids"
                ]
              },
              "examples": {
                "RetrievesFinancialMutationsGivenByIds": {
                  "summary": "Retrieves financial mutations given by ids",
                  "value": {
                    "ids": [
                      502689237248771100,
                      502689237264499700
                    ]
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "A financial mutation",
            "content": {
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "$ref": "#/components/schemas/financial_mutation_response"
                  }
                },
                "examples": {
                  "RetrievesFinancialMutationsGivenByIds": {
                    "summary": "Retrieves financial mutations given by ids",
                    "value": [
                      {
                        "id": "502689237264499724",
                        "administration_id": 123,
                        "amount": "100.0",
                        "code": null,
                        "date": "2026-11-02",
                        "message": "Factuur",
                        "contra_account_name": null,
                        "contra_account_number": "",
                        "state": "unprocessed",
                        "settlement_state": "settled",
                        "amount_open": "100.0",
                        "sepa_fields": null,
                        "batch_reference": null,
                        "financial_account_id": "502689237215217654",
                        "currency": "EUR",
                        "original_amount": null,
                        "created_at": "2026-11-02T12:17:16.434Z",
                        "updated_at": "2026-11-02T12:17:16.434Z",
                        "version": 1793621836,
                        "financial_statement_id": "502689237263451147",
                        "processed_at": null,
                        "account_servicer_transaction_id": null,
                        "payments": [],
                        "ledger_account_bookings": []
                      },
                      {
                        "id": "502689237248771075",
                        "administration_id": 123,
                        "amount": "100.0",
                        "code": null,
                        "date": "2026-11-02",
                        "message": "Factuur",
                        "contra_account_name": null,
                        "contra_account_number": "",
                        "state": "unprocessed",
                        "settlement_state": "settled",
                        "amount_open": "100.0",
                        "sepa_fields": null,
                        "batch_reference": null,
                        "financial_account_id": "502689237215217654",
                        "currency": "EUR",
                        "original_amount": null,
                        "created_at": "2026-11-02T12:17:16.418Z",
                        "updated_at": "2026-11-02T12:17:16.418Z",
                        "version": 1793621836,
                        "financial_statement_id": "502689237247722498",
                        "processed_at": null,
                        "account_servicer_transaction_id": null,
                        "payments": [],
                        "ledger_account_bookings": []
                      }
                    ]
                  }
                }
              }
            }
          },
          "400": {
            "$ref": "#/components/responses/400_bad_request"
          }
        },
        "operationId": "post_administration_id_financial_mutations_synchronization"
      }
    },
    "/{administration_id}/financial_mutations/{id}/link_booking{format}": {
      "patch": {
        "summary": "Links a financial mutation to a booking",
        "description": "Linking a booking to a financial mutation allows you to process financial mutations. Financial mutations can be\nlinked to invoices, documents, ledger accounts and payment batches.\n\nDepending on `booking_type`, the token also needs the `sales_invoices` scope (`SalesInvoice`,\n`ExternalSalesInvoice`, `PaymentTransaction`, `PaymentTransactionBatch`), the `documents` scope (`Document`,\n`NewPurchaseInvoice`, `NewReceipt`, `PurchaseTransactionBatch`), the `sales_invoices`, `documents` and\n`settings` scopes (`VatDocument`), or the scope of the invoice the payment belongs to (`Payment`).\n`LedgerAccount` needs only `bank`. For a `PurchaseTransaction` that is not paid yet, and for each such\ntransaction in a `PurchaseTransactionBatch`, the token also needs the scope of the invoice the transaction\npays.\n\nOnly a financial mutation with `settlement_state` `settled`, `authorised` or `pending` can be linked. Any other\n`settlement_state` answers 400.\n\n### Required scope(s)\n `bank`",
        "tags": [
          "Financial mutations"
        ],
        "security": [
          {
            "bearerAuth": [
              "bank"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/administration_id"
          },
          {
            "name": "id",
            "in": "path",
            "required": true,
            "schema": {
              "$ref": "#/components/schemas/identifier"
            }
          },
          {
            "$ref": "#/components/parameters/format"
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/*": {
              "schema": {
                "unevaluatedProperties": false,
                "type": "object",
                "properties": {
                  "booking_type": {
                    "type": "string",
                    "description": "The type of record to link the mutation to.",
                    "enum": [
                      "SalesInvoice",
                      "Document",
                      "LedgerAccount",
                      "PaymentTransactionBatch",
                      "PurchaseTransaction",
                      "NewPurchaseInvoice",
                      "NewReceipt",
                      "PaymentTransaction",
                      "PurchaseTransactionBatch",
                      "ExternalSalesInvoice",
                      "Payment",
                      "VatDocument"
                    ]
                  },
                  "booking_id": {
                    "$ref": "#/components/schemas/identifier",
                    "description": "The id of the record to link, of the type set in `booking_type` (e.g. the ledger account id when `booking_type` is `LedgerAccount`). Not allowed for `NewPurchaseInvoice` and `NewReceipt` — those create a new record instead of linking an existing one. To link an existing purchase invoice or receipt, use `booking_type` `Document` with the document's id."
                  },
                  "price_base": {
                    "$ref": "#/components/schemas/money",
                    "description": "The booking amount, in the administration's base currency. This is\nthe field that carries the amount for most booking types; when\nlinking a payment to an invoice it is the base-currency counterpart\nof `price`. For `booking_type` `LedgerAccount` send the amount\nhere — `price` is ignored.\n\nWhether to send a positive or a negative amount depends on\n`booking_type`:\n\n| **`booking_type`** | **Amount** |\n| --- | --- |\n| `SalesInvoice`, `ExternalSalesInvoice`, `Document` | Always positive. The payment direction is taken from the financial mutation, so refunds and credit notes also take a positive amount, whichever way the money moved |\n| `LedgerAccount` | Positive books in the same direction as the mutation, negative against it. Splitting a mutation over several bookings takes one request per part: an outgoing mutation of -95 consisting of 100 in costs and 5 received back takes one request with `100` and one with `-5`. One exception: once an incoming mutation has more booked than its own amount (its open amount went negative), positive and negative swap — a positive amount then books against the mutation |\n| `VatDocument` | The amount as it appears on the VAT return: positive when VAT is payable, negative for a refund |\n| `NewPurchaseInvoice`, `NewReceipt` | Positive when the mutation is outgoing (a purchase you paid), negative when it is incoming (money received back) |\n| `Payment`, `PaymentTransaction`, `PaymentTransactionBatch`, `PurchaseTransactionBatch`, `PurchaseTransaction` | Ignored — the amount comes from the record being linked |"
                  },
                  "price": {
                    "$ref": "#/components/schemas/money",
                    "description": "Amount in the booking's own currency, used when linking a payment to\nan invoice. The same positive/negative rules apply as for\n`price_base` (see the table there). For a foreign-currency invoice both `price` and `price_base`\nare required; otherwise `price_base` alone is enough. Only used when\n`booking_type` is `SalesInvoice`, `ExternalSalesInvoice`, `Document`\nor `VatDocument`; every other booking type takes its amount from\n`price_base` or ignores it."
                  },
                  "description": {
                    "type": "string"
                  },
                  "payment_batch_identifier": {
                    "type": "string"
                  },
                  "project_id": {
                    "$ref": "#/components/schemas/identifier",
                    "description": "Should be a valid project id."
                  },
                  "mark_open_sepa_transaction_as_paid": {
                    "type": [
                      "boolean",
                      "string"
                    ]
                  }
                },
                "required": [
                  "booking_type"
                ]
              },
              "examples": {
                "CreatesANewPurchaseInvoice": {
                  "summary": "Creates a new purchase invoice",
                  "value": {
                    "booking_type": "NewPurchaseInvoice",
                    "price_base": -100
                  }
                },
                "LinksASalesInvoiceToTheFinancialMutation": {
                  "summary": "Links a sales invoice to the financial mutation",
                  "value": {
                    "booking_type": "SalesInvoice",
                    "booking_id": 502689237667153000,
                    "price_base": "363.0"
                  }
                },
                "CreatesABookingForAForeignInvoiceWithAnExchangeRateDifference": {
                  "summary": "Creates a booking for a foreign invoice with an exchange rate difference",
                  "value": {
                    "booking_type": "LedgerAccount",
                    "booking_id": 502689238164178100,
                    "price_base": 1.48
                  }
                },
                "LinksAPurchaseInvoiceToTheFinancialMutation": {
                  "summary": "Links a purchase invoice to the financial mutation",
                  "value": {
                    "booking_type": "Document",
                    "booking_id": 502689238461973700,
                    "price_base": -100
                  }
                },
                "CreatesALedgerAccountBookingForAPositiveAmount": {
                  "summary": "Creates a ledger account booking for a positive amount",
                  "value": {
                    "booking_type": "LedgerAccount",
                    "booking_id": 502689238804858200,
                    "price_base": 100
                  }
                },
                "CreatesANewReceipt": {
                  "summary": "Creates a new receipt",
                  "value": {
                    "booking_type": "NewReceipt",
                    "price_base": -100
                  }
                },
                "CreatesALedgerAccountBookingForANegativeAmount": {
                  "summary": "Creates a ledger account booking for a negative amount",
                  "value": {
                    "booking_type": "LedgerAccount",
                    "booking_id": 502689239147742500,
                    "price_base": 100
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "The financial mutation from the request, with its `payments` and\n`ledger_account_bookings`. Linking to a cash-control ledger account can\nalso book a second mutation; that mutation is not in the response.\n\nFor `booking_type` `PaymentTransactionBatch` the link is made in the\nbackground, so the response shows the mutation before the link.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/financial_mutation_response"
                },
                "examples": {
                  "CreatesANewPurchaseInvoice": {
                    "summary": "Creates a new purchase invoice",
                    "value": {
                      "id": "502689237479457864",
                      "administration_id": 123,
                      "amount": "100.0",
                      "code": null,
                      "date": "2026-11-02",
                      "message": "Factuur",
                      "contra_account_name": null,
                      "contra_account_number": "",
                      "state": "processed",
                      "settlement_state": "settled",
                      "amount_open": "0.0",
                      "sepa_fields": null,
                      "batch_reference": null,
                      "financial_account_id": "502689237464777796",
                      "currency": "EUR",
                      "original_amount": null,
                      "created_at": "2026-11-02T12:17:16.638Z",
                      "updated_at": "2026-11-02T12:17:16.693Z",
                      "version": 1793621836,
                      "financial_statement_id": "502689237478409287",
                      "processed_at": "2026-11-02T12:17:16.691Z",
                      "account_servicer_transaction_id": null,
                      "payments": [
                        {
                          "id": "502689237524546643",
                          "administration_id": 123,
                          "invoice_type": "Document",
                          "invoice_id": "502689237508818001",
                          "financial_account_id": "502689237464777796",
                          "user_id": "502689108256097381",
                          "payment_transaction_id": null,
                          "transaction_identifier": null,
                          "price": "-100.0",
                          "price_base": "-100.0",
                          "payment_date": "2026-11-02",
                          "credit_invoice_id": null,
                          "financial_mutation_id": "502689237479457864",
                          "ledger_account_id": "502689237470020677",
                          "linked_payment_id": null,
                          "manual_payment_action": null,
                          "created_at": "2026-11-02T12:17:16.682Z",
                          "updated_at": "2026-11-02T12:17:16.682Z"
                        }
                      ],
                      "ledger_account_bookings": []
                    }
                  },
                  "LinksASalesInvoiceToTheFinancialMutation": {
                    "summary": "Links a sales invoice to the financial mutation",
                    "value": {
                      "id": "502689237593752665",
                      "administration_id": 123,
                      "amount": "100.0",
                      "code": null,
                      "date": "2026-11-02",
                      "message": "Factuur",
                      "contra_account_name": null,
                      "contra_account_number": "",
                      "state": "unprocessed",
                      "settlement_state": "settled",
                      "amount_open": "-263.0",
                      "sepa_fields": null,
                      "batch_reference": null,
                      "financial_account_id": "502689237573829717",
                      "currency": "EUR",
                      "original_amount": null,
                      "created_at": "2026-11-02T12:17:16.747Z",
                      "updated_at": "2026-11-02T12:17:16.998Z",
                      "version": 1793621836,
                      "financial_statement_id": "502689237592704088",
                      "processed_at": null,
                      "account_servicer_transaction_id": null,
                      "payments": [
                        {
                          "id": "502689237834925174",
                          "administration_id": 123,
                          "invoice_type": "SalesInvoice",
                          "invoice_id": "502689237667152998",
                          "financial_account_id": "502689237573829717",
                          "user_id": "502689108256097381",
                          "payment_transaction_id": null,
                          "transaction_identifier": null,
                          "price": "363.0",
                          "price_base": "363.0",
                          "payment_date": "2026-11-02",
                          "credit_invoice_id": null,
                          "financial_mutation_id": "502689237593752665",
                          "ledger_account_id": "502689237581169750",
                          "linked_payment_id": null,
                          "manual_payment_action": null,
                          "created_at": "2026-11-02T12:17:16.977Z",
                          "updated_at": "2026-11-02T12:17:16.977Z"
                        }
                      ],
                      "ledger_account_bookings": []
                    }
                  },
                  "CreatesABookingForAForeignInvoiceWithAnExchangeRateDifference": {
                    "summary": "Creates a booking for a foreign invoice with an exchange rate difference",
                    "value": {
                      "id": "502689237935588486",
                      "administration_id": 123,
                      "amount": "40.89",
                      "code": null,
                      "date": "2026-11-02",
                      "message": "Factuur",
                      "contra_account_name": null,
                      "contra_account_number": "",
                      "state": "processed",
                      "settlement_state": "settled",
                      "amount_open": "0.0",
                      "sepa_fields": null,
                      "batch_reference": null,
                      "financial_account_id": "502689237895742585",
                      "currency": "EUR",
                      "original_amount": null,
                      "created_at": "2026-11-02T12:17:17.073Z",
                      "updated_at": "2026-11-02T12:17:17.311Z",
                      "version": 1793621837,
                      "financial_statement_id": "502689237933491333",
                      "processed_at": "2026-11-02T12:17:17.309Z",
                      "account_servicer_transaction_id": null,
                      "payments": [
                        {
                          "id": "502689238131672227",
                          "administration_id": 123,
                          "invoice_type": "SalesInvoice",
                          "invoice_id": "502689238007940243",
                          "financial_account_id": "502689237895742585",
                          "user_id": "502689108256097381",
                          "payment_transaction_id": null,
                          "transaction_identifier": null,
                          "price": "49.01",
                          "price_base": "42.37",
                          "payment_date": "2026-11-02",
                          "credit_invoice_id": null,
                          "financial_mutation_id": "502689237935588486",
                          "ledger_account_id": "502689237900985466",
                          "linked_payment_id": null,
                          "manual_payment_action": null,
                          "created_at": "2026-11-02T12:17:17.260Z",
                          "updated_at": "2026-11-02T12:17:17.260Z"
                        }
                      ],
                      "ledger_account_bookings": [
                        {
                          "id": "502689238178858152",
                          "administration_id": 123,
                          "financial_mutation_id": "502689237935588486",
                          "ledger_account_id": "502689238164178086",
                          "project_id": null,
                          "description": null,
                          "price": "-1.48",
                          "created_at": "2026-11-02T12:17:17.305Z",
                          "updated_at": "2026-11-02T12:17:17.305Z"
                        }
                      ]
                    }
                  },
                  "LinksAPurchaseInvoiceToTheFinancialMutation": {
                    "summary": "Links a purchase invoice to the financial mutation",
                    "value": {
                      "id": "502689238416884942",
                      "administration_id": 123,
                      "amount": "100.0",
                      "code": null,
                      "date": "2026-11-02",
                      "message": "Factuur",
                      "contra_account_name": null,
                      "contra_account_number": "",
                      "state": "unprocessed",
                      "settlement_state": "settled",
                      "amount_open": "200.0",
                      "sepa_fields": null,
                      "batch_reference": null,
                      "financial_account_id": "502689238401156298",
                      "currency": "EUR",
                      "original_amount": null,
                      "created_at": "2026-11-02T12:17:17.533Z",
                      "updated_at": "2026-11-02T12:17:17.625Z",
                      "version": 1793621837,
                      "financial_statement_id": "502689238415836365",
                      "processed_at": null,
                      "account_servicer_transaction_id": null,
                      "payments": [
                        {
                          "id": "502689238500771047",
                          "administration_id": 123,
                          "invoice_type": "Document",
                          "invoice_id": "502689238461973723",
                          "financial_account_id": "502689238401156298",
                          "user_id": "502689108256097381",
                          "payment_transaction_id": null,
                          "transaction_identifier": null,
                          "price": "100.0",
                          "price_base": "100.0",
                          "payment_date": "2026-11-02",
                          "credit_invoice_id": null,
                          "financial_mutation_id": "502689238416884942",
                          "ledger_account_id": "502689238406399179",
                          "linked_payment_id": null,
                          "manual_payment_action": null,
                          "created_at": "2026-11-02T12:17:17.613Z",
                          "updated_at": "2026-11-02T12:17:17.613Z"
                        }
                      ],
                      "ledger_account_bookings": []
                    }
                  },
                  "CreatesALedgerAccountBookingForAPositiveAmount": {
                    "summary": "Creates a ledger account booking for a positive amount",
                    "value": {
                      "id": "502689238772352283",
                      "administration_id": 123,
                      "amount": "100.0",
                      "code": null,
                      "date": "2026-11-02",
                      "message": "Factuur",
                      "contra_account_name": null,
                      "contra_account_number": "",
                      "state": "processed",
                      "settlement_state": "settled",
                      "amount_open": "0.0",
                      "sepa_fields": null,
                      "batch_reference": null,
                      "financial_account_id": "502689238751380759",
                      "currency": "EUR",
                      "original_amount": null,
                      "created_at": "2026-11-02T12:17:17.871Z",
                      "updated_at": "2026-11-02T12:17:17.970Z",
                      "version": 1793621837,
                      "financial_statement_id": "502689238770255130",
                      "processed_at": "2026-11-02T12:17:17.968Z",
                      "account_servicer_transaction_id": null,
                      "payments": [],
                      "ledger_account_bookings": [
                        {
                          "id": "502689238868821285",
                          "administration_id": 123,
                          "financial_mutation_id": "502689238772352283",
                          "ledger_account_id": "502689238804858147",
                          "project_id": null,
                          "description": null,
                          "price": "100.0",
                          "created_at": "2026-11-02T12:17:17.962Z",
                          "updated_at": "2026-11-02T12:17:17.962Z"
                        }
                      ]
                    }
                  },
                  "CreatesANewReceipt": {
                    "summary": "Creates a new receipt",
                    "value": {
                      "id": "502689238993601849",
                      "administration_id": 123,
                      "amount": "100.0",
                      "code": null,
                      "date": "2026-11-02",
                      "message": "Factuur",
                      "contra_account_name": null,
                      "contra_account_number": "",
                      "state": "processed",
                      "settlement_state": "settled",
                      "amount_open": "0.0",
                      "sepa_fields": null,
                      "batch_reference": null,
                      "financial_account_id": "502689238979970357",
                      "currency": "EUR",
                      "original_amount": null,
                      "created_at": "2026-11-02T12:17:18.083Z",
                      "updated_at": "2026-11-02T12:17:18.129Z",
                      "version": 1793621838,
                      "financial_statement_id": "502689238992553272",
                      "processed_at": "2026-11-02T12:17:18.127Z",
                      "account_servicer_transaction_id": null,
                      "payments": [
                        {
                          "id": "502689239030302020",
                          "administration_id": 123,
                          "invoice_type": "Document",
                          "invoice_id": "502689239016670530",
                          "financial_account_id": "502689238979970357",
                          "user_id": "502689108256097381",
                          "payment_transaction_id": null,
                          "transaction_identifier": null,
                          "price": "-100.0",
                          "price_base": "-100.0",
                          "payment_date": "2026-11-02",
                          "credit_invoice_id": null,
                          "financial_mutation_id": "502689238993601849",
                          "ledger_account_id": "502689238985213238",
                          "linked_payment_id": null,
                          "manual_payment_action": null,
                          "created_at": "2026-11-02T12:17:18.118Z",
                          "updated_at": "2026-11-02T12:17:18.118Z"
                        }
                      ],
                      "ledger_account_bookings": []
                    }
                  },
                  "CreatesALedgerAccountBookingForANegativeAmount": {
                    "summary": "Creates a ledger account booking for a negative amount",
                    "value": {
                      "id": "502689239127819603",
                      "administration_id": 123,
                      "amount": "-100.0",
                      "code": null,
                      "date": "2026-11-02",
                      "message": "Factuur",
                      "contra_account_name": null,
                      "contra_account_number": "",
                      "state": "processed",
                      "settlement_state": "settled",
                      "amount_open": "0.0",
                      "sepa_fields": null,
                      "batch_reference": null,
                      "financial_account_id": "502689239095313734",
                      "currency": "EUR",
                      "original_amount": null,
                      "created_at": "2026-11-02T12:17:18.210Z",
                      "updated_at": "2026-11-02T12:17:18.249Z",
                      "version": 1793621838,
                      "financial_statement_id": "502689239126771026",
                      "processed_at": "2026-11-02T12:17:18.247Z",
                      "account_servicer_transaction_id": null,
                      "payments": [],
                      "ledger_account_bookings": [
                        {
                          "id": "502689239163471197",
                          "administration_id": 123,
                          "financial_mutation_id": "502689239127819603",
                          "ledger_account_id": "502689239147742555",
                          "project_id": null,
                          "description": null,
                          "price": "-100.0",
                          "created_at": "2026-11-02T12:17:18.244Z",
                          "updated_at": "2026-11-02T12:17:18.244Z"
                        }
                      ]
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "Bad request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/symbolic_error"
                },
                "examples": {
                  "ReturnsA400InsteadOfCrashingWhenPriceBaseIsOmittedForANegativeMutation": {
                    "summary": "Returns a 400 instead of crashing when price base is omitted for a negative mutation",
                    "value": {
                      "error": "Price can't be nil",
                      "symbolic": {
                        "price": "nils"
                      }
                    }
                  }
                }
              }
            }
          },
          "404": {
            "$ref": "#/components/responses/404_not_found"
          },
          "422": {
            "$ref": "#/components/responses/422_unprocessable_entity"
          }
        },
        "operationId": "patch_administration_id_financial_mutations_id_link_booking"
      }
    },
    "/{administration_id}/financial_mutations/{id}/unlink_booking{format}": {
      "delete": {
        "summary": "Unlinks a booking from a financial mutation",
        "description": "Unlinks a booking from a financial mutation.\n\nTo unlink a `Payment`, the token also needs the scope of the invoice the payment belongs to: `sales_invoices`\nfor (external) sales invoices, `documents` for purchase invoices and receipts, or `sales_invoices`,\n`documents` and `settings` for VAT documents.\n\n### Required scope(s)\n `bank`",
        "tags": [
          "Financial mutations"
        ],
        "security": [
          {
            "bearerAuth": [
              "bank"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/administration_id"
          },
          {
            "name": "id",
            "in": "path",
            "required": true,
            "schema": {
              "$ref": "#/components/schemas/identifier"
            }
          },
          {
            "$ref": "#/components/parameters/format"
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/*": {
              "schema": {
                "unevaluatedProperties": false,
                "type": "object",
                "properties": {
                  "booking_type": {
                    "type": "string",
                    "enum": [
                      "Payment",
                      "LedgerAccountBooking"
                    ],
                    "description": "Can be `Payment` or `LedgerAccountBooking`."
                  },
                  "booking_id": {
                    "$ref": "#/components/schemas/identifier"
                  }
                },
                "required": [
                  "booking_type",
                  "booking_id"
                ]
              },
              "examples": {
                "UnlinksAPaymentBooking": {
                  "summary": "Unlinks a payment booking",
                  "value": {
                    "booking_type": "Payment",
                    "booking_id": 502689240366188000
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "A financial mutation",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/financial_mutation_response"
                },
                "examples": {
                  "UnlinksAPaymentBooking": {
                    "summary": "Unlinks a payment booking",
                    "value": {
                      "id": "502689240206804459",
                      "administration_id": 123,
                      "amount": "100.0",
                      "code": null,
                      "date": "2026-11-02",
                      "message": "Factuur",
                      "contra_account_name": null,
                      "contra_account_number": "",
                      "state": "unprocessed",
                      "settlement_state": "settled",
                      "amount_open": "100.0",
                      "sepa_fields": null,
                      "batch_reference": null,
                      "financial_account_id": "502689240185832935",
                      "currency": "EUR",
                      "original_amount": null,
                      "created_at": "2026-11-02T12:17:19.239Z",
                      "updated_at": "2026-11-02T12:17:19.442Z",
                      "version": 1793621839,
                      "financial_statement_id": "502689240205755882",
                      "processed_at": null,
                      "account_servicer_transaction_id": null,
                      "payments": [],
                      "ledger_account_bookings": []
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "Bad request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/symbolic_error"
                },
                "examples": {
                  "ReturnsAnErrorIfBookingTypeIsInvalid": {
                    "summary": "Returns an error if booking type is invalid",
                    "value": {
                      "error": "Booking Type isn't an option",
                      "symbolic": {
                        "booking_type": "in"
                      }
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Not found",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/symbolic_error"
                },
                "examples": {
                  "ReturnsAnErrorIfBookingIdIsNotFound": {
                    "summary": "Returns an error if booking id is not found",
                    "value": {
                      "error": "record not found",
                      "symbolic": {
                        "booking_id": "not_found"
                      }
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "Unprocessable entity",
            "content": {
              "application/json": {
                "schema": {
                  "anyOf": [
                    {
                      "$ref": "#/components/schemas/symbolic_error"
                    },
                    {
                      "$ref": "#/components/schemas/non_symbolic_error"
                    }
                  ]
                },
                "examples": {
                  "ReturnsA422WhenTheFinancialMutationIsLocked": {
                    "summary": "Returns a 422 when the financial mutation is locked",
                    "value": {
                      "error": "in locked period",
                      "symbolic": {
                        "id": "in_locked_period"
                      }
                    }
                  }
                }
              }
            }
          }
        },
        "operationId": "delete_administration_id_financial_mutations_id_unlink_booking"
      }
    },
    "/{administration_id}/financial_mutations/{id}{format}": {
      "get": {
        "summary": "Get a financial mutation by id",
        "description": "Returns a single financial mutation in the administration.\n\n### Required scope(s)\n `bank`",
        "tags": [
          "Financial mutations"
        ],
        "security": [
          {
            "bearerAuth": [
              "bank"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/administration_id"
          },
          {
            "name": "id",
            "in": "path",
            "required": true,
            "schema": {
              "$ref": "#/components/schemas/identifier"
            }
          },
          {
            "$ref": "#/components/parameters/format"
          }
        ],
        "responses": {
          "200": {
            "description": "A financial mutation",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/financial_mutation_response"
                },
                "examples": {
                  "ReturnsFinancialMutationByTheGivenId": {
                    "summary": "Returns financial mutation by the given id",
                    "value": {
                      "id": "502689237109311460",
                      "administration_id": 123,
                      "amount": "100.0",
                      "code": null,
                      "date": "2026-11-02",
                      "message": "Factuur",
                      "contra_account_name": null,
                      "contra_account_number": "",
                      "state": "unprocessed",
                      "settlement_state": "settled",
                      "amount_open": "100.0",
                      "sepa_fields": null,
                      "batch_reference": null,
                      "financial_account_id": "502689237088339936",
                      "currency": "EUR",
                      "original_amount": null,
                      "created_at": "2026-11-02T12:17:16.286Z",
                      "updated_at": "2026-11-02T12:17:16.286Z",
                      "version": 1793621836,
                      "financial_statement_id": "502689237108262883",
                      "processed_at": null,
                      "account_servicer_transaction_id": null,
                      "payments": [
                        {
                          "id": "502689237166983157",
                          "administration_id": 123,
                          "invoice_type": "SalesInvoice",
                          "invoice_id": "502689237148108785",
                          "financial_account_id": "502689237088339936",
                          "user_id": 1,
                          "payment_transaction_id": null,
                          "transaction_identifier": null,
                          "price": "80.0",
                          "price_base": "80.0",
                          "payment_date": "2026-11-02",
                          "credit_invoice_id": null,
                          "financial_mutation_id": "502689237109311460",
                          "ledger_account_id": "502689237164886004",
                          "linked_payment_id": null,
                          "manual_payment_action": null,
                          "created_at": "2026-11-02T12:17:16.340Z",
                          "updated_at": "2026-11-02T12:17:16.340Z"
                        }
                      ],
                      "ledger_account_bookings": [
                        {
                          "id": "502689237126088685",
                          "administration_id": 123,
                          "financial_mutation_id": "502689237109311460",
                          "ledger_account_id": "502689237125040108",
                          "project_id": null,
                          "description": "Ledger account booking",
                          "price": "20.0",
                          "created_at": "2026-11-02T12:17:16.302Z",
                          "updated_at": "2026-11-02T12:17:16.302Z"
                        }
                      ]
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Not found",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/symbolic_error"
                },
                "examples": {
                  "Returns404WhenTheFinancialMutationDoesNotExist": {
                    "summary": "Returns 404 when the financial mutation does not exist",
                    "value": {
                      "error": "record not found",
                      "symbolic": {
                        "id": "not_found"
                      }
                    }
                  }
                }
              }
            }
          }
        },
        "operationId": "get_administration_id_financial_mutations_id"
      }
    },
    "/{administration_id}/financial_mutations{format}": {
      "get": {
        "summary": "List all financial mutations",
        "description": "Returns the financial mutations that match the filter. When more than 100 financial mutations match, the\nrequest fails with a 400 response. Use a smaller `period` or the\n[synchronize](#get_financial_mutations_synchronization) API to get more.\n\n### Required scope(s)\n `bank`",
        "x-mcp-description": "Returns the financial mutations that match the filter. Fails with a 400 response when more than 100 match; make the `period` filter smaller and call again.",
        "tags": [
          "Financial mutations"
        ],
        "security": [
          {
            "bearerAuth": [
              "bank"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/administration_id"
          },
          {
            "$ref": "#/components/parameters/format"
          },
          {
            "name": "filter",
            "in": "query",
            "required": false,
            "description": "Filters are `key:value` terms separated by commas (e.g. `period:this_year,state:unprocessed`). Any filter you pass replaces the defaults below entirely, so include every key you need. Available filters:\n\n| **Filter** | **Type** | **Default** | **Description** |\n| - | - | - | - |\n| period | `String` | `this_year` | A named period (`this_week`, `prev_week`, `next_week`, `this_month`, `prev_month`, `next_month`, `this_quarter`, `prev_quarter`, `next_quarter`, `this_year`, `prev_year`, `next_year`) or a custom range (`201301..201302`, `20130101..20130131`). A custom period must have a start and an end date. It must not be longer than 10 years and must be between `20000101` and `21000101`. For one month, use `202401..202401`, not `202401`. Without `period`, the filter does not limit the dates. The default `this_year` applies only when you send no `filter`. |\n| state | `String` | `all` | `all`, `unprocessed`, `processed` or `auto_booked` |\n| mutation_type | `String` | `all` | `all`, `debit` or `credit` |\n| financial_account_id | `Integer` | | Restrict to a single financial account |\n| amount_from | `String` | | Lower bound on the absolute mutation amount (negative input is treated as positive) |\n| amount_to | `String` | | Upper bound on the absolute mutation amount |\n\nMultiple values for `state` and `mutation_type` can be combined with a pipe, e.g. `state:unprocessed|processed`.",
            "schema": {
              "type": "string",
              "default": "period:this_year"
            },
            "examples": {
              "ReturnsAllMutationsFilteredOnPeriod": {
                "summary": "Returns all mutations filtered on period",
                "value": "period:this_month"
              }
            }
          }
        ],
        "responses": {
          "200": {
            "description": "A list of financial mutations",
            "content": {
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "$ref": "#/components/schemas/financial_mutation_response"
                  }
                },
                "examples": {
                  "ReturnsAllFinancialMutationsOfAnAdministration": {
                    "summary": "Returns all financial mutations of an administration",
                    "value": [
                      {
                        "id": "502689239214851427",
                        "administration_id": 123,
                        "amount": "100.0",
                        "code": null,
                        "date": "2026-11-02",
                        "message": "Factuur",
                        "contra_account_name": null,
                        "contra_account_number": "",
                        "state": "unprocessed",
                        "settlement_state": "settled",
                        "amount_open": "100.0",
                        "sepa_fields": null,
                        "batch_reference": null,
                        "financial_account_id": "502689239201219935",
                        "currency": "EUR",
                        "original_amount": null,
                        "created_at": "2026-11-02T12:17:18.294Z",
                        "updated_at": "2026-11-02T12:17:18.294Z",
                        "version": 1793621838,
                        "financial_statement_id": "502689239213802850",
                        "processed_at": null,
                        "account_servicer_transaction_id": null,
                        "payments": [
                          {
                            "id": "502689239276717428",
                            "administration_id": 123,
                            "invoice_type": "SalesInvoice",
                            "invoice_id": "502689239253648752",
                            "financial_account_id": "502689239201219935",
                            "user_id": 1,
                            "payment_transaction_id": null,
                            "transaction_identifier": null,
                            "price": "80.0",
                            "price_base": "80.0",
                            "payment_date": "2026-11-02",
                            "credit_invoice_id": null,
                            "financial_mutation_id": "502689239214851427",
                            "ledger_account_id": "502689239273571699",
                            "linked_payment_id": null,
                            "manual_payment_action": null,
                            "created_at": "2026-11-02T12:17:18.352Z",
                            "updated_at": "2026-11-02T12:17:18.352Z"
                          }
                        ],
                        "ledger_account_bookings": [
                          {
                            "id": "502689239231628652",
                            "administration_id": 123,
                            "financial_mutation_id": "502689239214851427",
                            "ledger_account_id": "502689239229531499",
                            "project_id": null,
                            "description": "Ledger account booking",
                            "price": "20.0",
                            "created_at": "2026-11-02T12:17:18.309Z",
                            "updated_at": "2026-11-02T12:17:18.309Z"
                          }
                        ]
                      }
                    ]
                  },
                  "ReturnsAllMutationsFilteredOnPeriod": {
                    "summary": "Returns all mutations filtered on period",
                    "value": [
                      {
                        "id": "502689239409886585",
                        "administration_id": 123,
                        "amount": "100.0",
                        "code": null,
                        "date": "2026-11-02",
                        "message": "Factuur",
                        "contra_account_name": null,
                        "contra_account_number": "",
                        "state": "unprocessed",
                        "settlement_state": "settled",
                        "amount_open": "100.0",
                        "sepa_fields": null,
                        "batch_reference": null,
                        "financial_account_id": "502689239319709045",
                        "currency": "EUR",
                        "original_amount": null,
                        "created_at": "2026-11-02T12:17:18.477Z",
                        "updated_at": "2026-11-02T12:17:18.477Z",
                        "version": 1793621838,
                        "financial_statement_id": "502689239405692280",
                        "processed_at": null,
                        "account_servicer_transaction_id": null,
                        "payments": [
                          {
                            "id": "502689239487481226",
                            "administration_id": 123,
                            "invoice_type": "SalesInvoice",
                            "invoice_id": "502689239464412550",
                            "financial_account_id": "502689239319709045",
                            "user_id": 1,
                            "payment_transaction_id": null,
                            "transaction_identifier": null,
                            "price": "80.0",
                            "price_base": "80.0",
                            "payment_date": "2026-11-02",
                            "credit_invoice_id": null,
                            "financial_mutation_id": "502689239409886585",
                            "ledger_account_id": "502689239485384073",
                            "linked_payment_id": null,
                            "manual_payment_action": null,
                            "created_at": "2026-11-02T12:17:18.554Z",
                            "updated_at": "2026-11-02T12:17:18.554Z"
                          }
                        ],
                        "ledger_account_bookings": [
                          {
                            "id": "502689239432955266",
                            "administration_id": 123,
                            "financial_mutation_id": "502689239409886585",
                            "ledger_account_id": "502689239430858113",
                            "project_id": null,
                            "description": "Ledger account booking",
                            "price": "20.0",
                            "created_at": "2026-11-02T12:17:18.501Z",
                            "updated_at": "2026-11-02T12:17:18.501Z"
                          }
                        ]
                      }
                    ]
                  }
                }
              }
            }
          },
          "400": {
            "description": "Bad request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/symbolic_error"
                },
                "examples": {
                  "RaisesAnErrorWhenThereAreTooManyMutationsToReturn": {
                    "summary": "Raises an error when there are too many mutations to return",
                    "value": {
                      "error": "Too many financial mutations to return, please use sync API"
                    }
                  }
                }
              }
            }
          }
        },
        "operationId": "get_administration_id_financial_mutations"
      }
    },
    "/{administration_id}/financial_statements/{id}{format}": {
      "delete": {
        "summary": "Delete a financial statement",
        "description": "Deletes a financial statement.\n\n### Required scope(s)\n `bank`",
        "tags": [
          "Financial statements"
        ],
        "security": [
          {
            "bearerAuth": [
              "bank"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/administration_id"
          },
          {
            "name": "id",
            "in": "path",
            "required": true,
            "schema": {
              "$ref": "#/components/schemas/identifier"
            }
          },
          {
            "$ref": "#/components/parameters/format"
          }
        ],
        "responses": {
          "204": {
            "description": "Financial statement deleted"
          },
          "404": {
            "description": "Not found",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/symbolic_error"
                },
                "examples": {
                  "ReturnsA404StatusWhenTheFinancialStatementIsNotFound": {
                    "summary": "Returns a 404 status when the financial statement is not found",
                    "value": {
                      "error": "record not found",
                      "symbolic": {
                        "id": "not_found"
                      }
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "Unprocessable entity",
            "content": {
              "application/json": {
                "schema": {
                  "anyOf": [
                    {
                      "$ref": "#/components/schemas/symbolic_error"
                    },
                    {
                      "$ref": "#/components/schemas/non_symbolic_error"
                    }
                  ]
                },
                "examples": {
                  "ReturnsA422StatusWhenTheFinancialStatementCannotBeDeleted": {
                    "summary": "Returns a 422 status when the financial statement cannot be deleted",
                    "value": {
                      "error": "ID is invalid",
                      "symbolic": {
                        "id": "cannot_be_deleted"
                      }
                    }
                  }
                }
              }
            }
          }
        },
        "operationId": "delete_administration_id_financial_statements_id"
      },
      "patch": {
        "summary": "Update a financial statement",
        "description": "When updating a financial statement, you only need to provide the information you want to change. Attributes you don't\nprovide in the request will not be updated.\n\n### Required scope(s)\n `bank`",
        "tags": [
          "Financial statements"
        ],
        "security": [
          {
            "bearerAuth": [
              "bank"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/administration_id"
          },
          {
            "name": "id",
            "in": "path",
            "required": true,
            "schema": {
              "$ref": "#/components/schemas/identifier"
            }
          },
          {
            "$ref": "#/components/parameters/format"
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/*": {
              "schema": {
                "unevaluatedProperties": false,
                "type": "object",
                "properties": {
                  "financial_statement": {
                    "type": "object",
                    "unevaluatedProperties": false,
                    "properties": {
                      "reference": {
                        "type": "string",
                        "description": "A unique reference for this financial statement, e.g. the bank statement number."
                      },
                      "official_date": {
                        "type": "string",
                        "description": "The date of the official bank balance.",
                        "format": "date"
                      },
                      "official_balance": {
                        "$ref": "#/components/schemas/money"
                      },
                      "financial_mutations_attributes": {
                        "oneOf": [
                          {
                            "type": "array",
                            "items": {
                              "type": "object",
                              "unevaluatedProperties": false,
                              "properties": {
                                "id": {
                                  "type": "integer",
                                  "description": "The ID of an existing financial mutation to update. Omit when adding a new mutation."
                                },
                                "date": {
                                  "type": "string",
                                  "format": "date",
                                  "description": "The transaction date."
                                },
                                "message": {
                                  "type": "string",
                                  "description": "The description or narrative of the bank transaction."
                                },
                                "amount": {
                                  "$ref": "#/components/schemas/money"
                                },
                                "code": {
                                  "type": "string",
                                  "description": "The bank transaction type code. Primarily used internally for bank statement imports and automatic booking; most API users can omit this."
                                },
                                "contra_account_name": {
                                  "type": "string",
                                  "description": "The name of the counterparty's account holder."
                                },
                                "contra_account_number": {
                                  "type": "string",
                                  "description": "The account number (IBAN) of the counterparty."
                                },
                                "batch_reference": {
                                  "type": "string",
                                  "description": "A reference identifying a batch of transactions."
                                },
                                "offset": {
                                  "type": "integer",
                                  "description": "The position offset of this mutation within the statement."
                                },
                                "account_servicer_transaction_id": {
                                  "type": "string",
                                  "description": "A unique transaction ID assigned by the bank. Used internally for deduplication when importing bank statements."
                                },
                                "adyen_payment_instrument_id": {
                                  "$ref": "#/components/schemas/identifier",
                                  "description": "Should be a valid adyen payment instrument id."
                                },
                                "_destroy": {
                                  "type": [
                                    "boolean",
                                    "string"
                                  ],
                                  "description": "Set to `true` to remove this financial mutation from the statement."
                                }
                              },
                              "required": []
                            }
                          },
                          {
                            "type": "object",
                            "additionalProperties": {
                              "type": "object",
                              "properties": {
                                "id": {
                                  "type": "integer",
                                  "description": "The ID of an existing financial mutation to update. Omit when adding a new mutation."
                                },
                                "date": {
                                  "type": "string",
                                  "format": "date",
                                  "description": "The transaction date."
                                },
                                "message": {
                                  "type": "string",
                                  "description": "The description or narrative of the bank transaction."
                                },
                                "amount": {
                                  "$ref": "#/components/schemas/money"
                                },
                                "code": {
                                  "type": "string",
                                  "description": "The bank transaction type code. Primarily used internally for bank statement imports and automatic booking; most API users can omit this."
                                },
                                "contra_account_name": {
                                  "type": "string",
                                  "description": "The name of the counterparty's account holder."
                                },
                                "contra_account_number": {
                                  "type": "string",
                                  "description": "The account number (IBAN) of the counterparty."
                                },
                                "batch_reference": {
                                  "type": "string",
                                  "description": "A reference identifying a batch of transactions."
                                },
                                "offset": {
                                  "type": "integer",
                                  "description": "The position offset of this mutation within the statement."
                                },
                                "account_servicer_transaction_id": {
                                  "type": "string",
                                  "description": "A unique transaction ID assigned by the bank. Used internally for deduplication when importing bank statements."
                                },
                                "adyen_payment_instrument_id": {
                                  "$ref": "#/components/schemas/identifier",
                                  "description": "Should be a valid adyen payment instrument id."
                                },
                                "_destroy": {
                                  "type": [
                                    "boolean",
                                    "string"
                                  ],
                                  "description": "Set to `true` to remove this financial mutation from the statement."
                                }
                              },
                              "required": []
                            }
                          }
                        ]
                      }
                    },
                    "required": []
                  }
                },
                "required": []
              },
              "examples": {
                "UpdatesAFinancialStatement": {
                  "summary": "Updates a financial statement",
                  "value": {
                    "financial_statement": {
                      "reference": "new_reference",
                      "financial_mutations_attributes": {
                        "0": {
                          "message": "Foobar 1",
                          "date": "2026-11-02",
                          "amount": 100
                        }
                      }
                    }
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Financial statement updated",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/financial_statement_response"
                },
                "examples": {
                  "UpdatesAFinancialStatement": {
                    "summary": "Updates a financial statement",
                    "value": {
                      "id": "502689172860962724",
                      "financial_account_id": "502689172784416673",
                      "reference": "new_reference",
                      "official_date": null,
                      "official_balance": null,
                      "importer_service": null,
                      "financial_mutations": [
                        {
                          "id": "502689172865157030",
                          "administration_id": 123,
                          "amount": "-20.0",
                          "code": null,
                          "date": "2026-11-01",
                          "message": "Afboeking",
                          "contra_account_name": "Krant",
                          "contra_account_number": "CH3608387000001080173",
                          "state": "unprocessed",
                          "settlement_state": "settled",
                          "amount_open": "-20.0",
                          "sepa_fields": null,
                          "batch_reference": null,
                          "financial_account_id": "502689172784416673",
                          "currency": "EUR",
                          "original_amount": null,
                          "created_at": "2026-11-02T12:16:15.017Z",
                          "updated_at": "2026-11-02T12:16:15.017Z",
                          "version": 1793621775,
                          "financial_statement_id": "502689172860962724",
                          "processed_at": null,
                          "account_servicer_transaction_id": null,
                          "payments": [],
                          "ledger_account_bookings": []
                        },
                        {
                          "id": "502689172863059877",
                          "administration_id": 123,
                          "amount": "322.78",
                          "code": null,
                          "date": "2026-11-02",
                          "message": "637034759 B & S CARD SERVICE GMBH\n0001234567EINREICH ABR.280000000\n321 / 333,60 -SERV 10,82 +0%MWST\n0,00 REF VU0251478",
                          "contra_account_name": "Internetprovider",
                          "contra_account_number": "BE68539007547034",
                          "state": "unprocessed",
                          "settlement_state": "settled",
                          "amount_open": "322.78",
                          "sepa_fields": null,
                          "batch_reference": null,
                          "financial_account_id": "502689172784416673",
                          "currency": "EUR",
                          "original_amount": null,
                          "created_at": "2026-11-02T12:16:15.015Z",
                          "updated_at": "2026-11-02T12:16:15.015Z",
                          "version": 1793621775,
                          "financial_statement_id": "502689172860962724",
                          "processed_at": null,
                          "account_servicer_transaction_id": null,
                          "payments": [],
                          "ledger_account_bookings": []
                        },
                        {
                          "id": "502689172933314485",
                          "administration_id": 123,
                          "amount": "100.0",
                          "code": null,
                          "date": "2026-11-02",
                          "message": "Foobar 1",
                          "contra_account_name": null,
                          "contra_account_number": "",
                          "state": "unprocessed",
                          "settlement_state": "settled",
                          "amount_open": "100.0",
                          "sepa_fields": null,
                          "batch_reference": null,
                          "financial_account_id": "502689172784416673",
                          "currency": "EUR",
                          "original_amount": null,
                          "created_at": "2026-11-02T12:16:15.082Z",
                          "updated_at": "2026-11-02T12:16:15.082Z",
                          "version": 1793621775,
                          "financial_statement_id": "502689172860962724",
                          "processed_at": null,
                          "account_servicer_transaction_id": null,
                          "payments": [],
                          "ledger_account_bookings": []
                        }
                      ]
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Not found",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/symbolic_error"
                },
                "examples": {
                  "ReturnsA404StatusWhenTheStatementIsNotFound": {
                    "summary": "Returns a 404 status when the statement is not found",
                    "value": {
                      "error": "Record not found for model name: Financial statement"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "Unprocessable entity",
            "content": {
              "application/json": {
                "schema": {
                  "anyOf": [
                    {
                      "$ref": "#/components/schemas/symbolic_error"
                    },
                    {
                      "$ref": "#/components/schemas/non_symbolic_error"
                    }
                  ]
                },
                "examples": {
                  "ReturnsAnErrorWhenInvalidInputIsGiven": {
                    "summary": "Returns an error when invalid input is given",
                    "value": {
                      "error": {
                        "reference": [
                          "can't be blank"
                        ]
                      },
                      "details": {
                        "reference": [
                          {
                            "error": "blank"
                          }
                        ]
                      }
                    }
                  }
                }
              }
            }
          }
        },
        "operationId": "patch_administration_id_financial_statements_id"
      }
    },
    "/{administration_id}/financial_statements{format}": {
      "post": {
        "summary": "Create a new financial statement",
        "description": "Creates a new financial statement. Provided financial mutations will be grouped in the statement.\n\n### Required scope(s)\n `bank`",
        "tags": [
          "Financial statements"
        ],
        "security": [
          {
            "bearerAuth": [
              "bank"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/administration_id"
          },
          {
            "$ref": "#/components/parameters/format"
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/*": {
              "schema": {
                "unevaluatedProperties": false,
                "type": "object",
                "properties": {
                  "financial_statement": {
                    "type": "object",
                    "unevaluatedProperties": false,
                    "properties": {
                      "financial_account_id": {
                        "$ref": "#/components/schemas/identifier",
                        "description": "Should be a valid financial account id."
                      },
                      "reference": {
                        "type": "string",
                        "description": "A unique reference for this financial statement, e.g. the bank statement number."
                      },
                      "official_date": {
                        "type": "string",
                        "format": "date",
                        "description": "The date of the official bank balance."
                      },
                      "official_balance": {
                        "$ref": "#/components/schemas/money"
                      },
                      "importer_key": {
                        "type": "string",
                        "description": "An identifier for the import source or batch, e.g. a bank feed provider reference."
                      },
                      "financial_mutations_attributes": {
                        "oneOf": [
                          {
                            "type": "array",
                            "items": {
                              "type": "object",
                              "unevaluatedProperties": false,
                              "properties": {
                                "date": {
                                  "type": "string",
                                  "format": "date",
                                  "description": "The transaction date."
                                },
                                "valutation_date": {
                                  "type": "string",
                                  "format": "date",
                                  "description": "The value date of the transaction, i.e. when the funds are actually credited or debited. May differ from the transaction date."
                                },
                                "message": {
                                  "type": "string",
                                  "description": "The description or narrative of the bank transaction as provided by the bank."
                                },
                                "amount": {
                                  "$ref": "#/components/schemas/money"
                                },
                                "code": {
                                  "type": "string",
                                  "description": "The bank transaction type code, e.g. a SWIFT transaction code. Primarily used internally for bank statement imports and automatic booking; most API users can omit this."
                                },
                                "contra_account_name": {
                                  "type": "string",
                                  "description": "The name of the counterparty's account holder."
                                },
                                "contra_account_number": {
                                  "type": "string",
                                  "description": "The account number (IBAN) of the counterparty."
                                },
                                "batch_reference": {
                                  "type": "string",
                                  "description": "A reference identifying a batch of transactions, e.g. for grouped SEPA payments."
                                },
                                "offset": {
                                  "type": "integer",
                                  "description": "The position offset of this mutation within the statement. Used for ordering."
                                },
                                "account_servicer_transaction_id": {
                                  "type": "string",
                                  "description": "A unique transaction ID assigned by the bank. Used for deduplication."
                                },
                                "account_servicer_metadata": {
                                  "type": "object",
                                  "description": "Additional metadata provided by the bank for this transaction."
                                },
                                "adyen_payment_instrument_id": {
                                  "$ref": "#/components/schemas/identifier",
                                  "description": "Should be a valid adyen payment instrument id."
                                },
                                "_destroy": {
                                  "type": [
                                    "boolean",
                                    "string"
                                  ],
                                  "description": "Set to `true` to remove this financial mutation from the statement."
                                },
                                "smart_transfer": {
                                  "type": [
                                    "boolean",
                                    "string"
                                  ],
                                  "description": "Indicates that this financial mutation was created by a smart transfer rule."
                                }
                              },
                              "required": []
                            }
                          },
                          {
                            "type": "object",
                            "additionalProperties": {
                              "type": "object",
                              "properties": {
                                "date": {
                                  "type": "string",
                                  "format": "date",
                                  "description": "The transaction date."
                                },
                                "valutation_date": {
                                  "type": "string",
                                  "format": "date",
                                  "description": "The value date of the transaction, i.e. when the funds are actually credited or debited. May differ from the transaction date."
                                },
                                "message": {
                                  "type": "string",
                                  "description": "The description or narrative of the bank transaction as provided by the bank."
                                },
                                "amount": {
                                  "$ref": "#/components/schemas/money"
                                },
                                "code": {
                                  "type": "string",
                                  "description": "The bank transaction type code, e.g. a SWIFT transaction code. Primarily used internally for bank statement imports and automatic booking; most API users can omit this."
                                },
                                "contra_account_name": {
                                  "type": "string",
                                  "description": "The name of the counterparty's account holder."
                                },
                                "contra_account_number": {
                                  "type": "string",
                                  "description": "The account number (IBAN) of the counterparty."
                                },
                                "batch_reference": {
                                  "type": "string",
                                  "description": "A reference identifying a batch of transactions, e.g. for grouped SEPA payments."
                                },
                                "offset": {
                                  "type": "integer",
                                  "description": "The position offset of this mutation within the statement. Used for ordering."
                                },
                                "account_servicer_transaction_id": {
                                  "type": "string",
                                  "description": "A unique transaction ID assigned by the bank. Used for deduplication."
                                },
                                "account_servicer_metadata": {
                                  "type": "object",
                                  "description": "Additional metadata provided by the bank for this transaction."
                                },
                                "adyen_payment_instrument_id": {
                                  "$ref": "#/components/schemas/identifier",
                                  "description": "Should be a valid adyen payment instrument id."
                                },
                                "_destroy": {
                                  "type": [
                                    "boolean",
                                    "string"
                                  ],
                                  "description": "Set to `true` to remove this financial mutation from the statement."
                                },
                                "smart_transfer": {
                                  "type": [
                                    "boolean",
                                    "string"
                                  ],
                                  "description": "Indicates that this financial mutation was created by a smart transfer rule."
                                }
                              },
                              "required": []
                            }
                          }
                        ]
                      }
                    },
                    "required": [
                      "reference"
                    ]
                  }
                },
                "required": []
              },
              "examples": {
                "CreatesAFinancialStatement": {
                  "summary": "Creates a financial statement",
                  "value": {
                    "financial_statement": {
                      "reference": "31012014_ABNAMRO",
                      "financial_account_id": 502689172447823740,
                      "financial_mutations_attributes": {
                        "1": {
                          "date": "2026-11-02",
                          "message": "Foobar 1",
                          "amount": 100
                        },
                        "2": {
                          "date": "2026-11-02",
                          "message": "Foobar 2",
                          "amount": 200
                        }
                      }
                    }
                  }
                }
              }
            }
          }
        },
        "responses": {
          "201": {
            "description": "Financial statement created",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/financial_statement_response"
                },
                "examples": {
                  "CreatesAFinancialStatement": {
                    "summary": "Creates a financial statement",
                    "value": {
                      "id": "502689172465649533",
                      "financial_account_id": "502689172447823738",
                      "reference": "31012014_ABNAMRO",
                      "official_date": null,
                      "official_balance": null,
                      "importer_service": null,
                      "financial_mutations": [
                        {
                          "id": "502689172466698110",
                          "administration_id": 123,
                          "amount": "100.0",
                          "code": null,
                          "date": "2026-11-02",
                          "message": "Foobar 1",
                          "contra_account_name": null,
                          "contra_account_number": "",
                          "state": "unprocessed",
                          "settlement_state": "settled",
                          "amount_open": "100.0",
                          "sepa_fields": null,
                          "batch_reference": null,
                          "financial_account_id": "502689172447823738",
                          "currency": "EUR",
                          "original_amount": null,
                          "created_at": "2026-11-02T12:16:14.638Z",
                          "updated_at": "2026-11-02T12:16:14.638Z",
                          "version": 1793621774,
                          "financial_statement_id": "502689172465649533",
                          "processed_at": null,
                          "account_servicer_transaction_id": null,
                          "payments": [],
                          "ledger_account_bookings": []
                        },
                        {
                          "id": "502689172468795263",
                          "administration_id": 123,
                          "amount": "200.0",
                          "code": null,
                          "date": "2026-11-02",
                          "message": "Foobar 2",
                          "contra_account_name": null,
                          "contra_account_number": "",
                          "state": "unprocessed",
                          "settlement_state": "settled",
                          "amount_open": "200.0",
                          "sepa_fields": null,
                          "batch_reference": null,
                          "financial_account_id": "502689172447823738",
                          "currency": "EUR",
                          "original_amount": null,
                          "created_at": "2026-11-02T12:16:14.639Z",
                          "updated_at": "2026-11-02T12:16:14.639Z",
                          "version": 1793621774,
                          "financial_statement_id": "502689172465649533",
                          "processed_at": null,
                          "account_servicer_transaction_id": null,
                          "payments": [],
                          "ledger_account_bookings": []
                        }
                      ]
                    }
                  }
                }
              }
            }
          },
          "400": {
            "$ref": "#/components/responses/400_bad_request"
          },
          "422": {
            "$ref": "#/components/responses/422_unprocessable_entity"
          }
        },
        "operationId": "post_administration_id_financial_statements"
      }
    },
    "/{administration_id}/identities/default{format}": {
      "get": {
        "summary": "Retrieve the default identity",
        "description": "Returns the default identity of this administration.\n\n### Required scope(s)\n `settings`",
        "tags": [
          "Identities"
        ],
        "security": [
          {
            "bearerAuth": [
              "settings"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/administration_id"
          },
          {
            "$ref": "#/components/parameters/format"
          }
        ],
        "responses": {
          "200": {
            "description": "A list of identities",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/identity_response"
                },
                "examples": {
                  "ReturnsTheDefaultIdentity": {
                    "summary": "Returns the default identity",
                    "value": {
                      "id": "502689108656653419",
                      "administration_id": 123,
                      "company_name": "Parkietje B.V.",
                      "city": "Enschede",
                      "country": "NL",
                      "zipcode": "7523XD",
                      "address1": "Brouwerijstraat 26",
                      "address2": null,
                      "email": "info@dev.null.moneybird.net",
                      "phone": "0612345678",
                      "bank_account_name": null,
                      "bank_account_number": "NL50TEST0166567191",
                      "bank_account_bic": null,
                      "custom_fields": [],
                      "updated_at": "2026-11-02T12:15:13.782Z",
                      "created_at": "2026-11-02T12:15:13.782Z",
                      "chamber_of_commerce": "08155914",
                      "tax_number": "NL817575546B01"
                    }
                  }
                }
              }
            }
          }
        },
        "operationId": "get_administration_id_identities_default"
      },
      "patch": {
        "summary": "Updates the default identity",
        "description": "Updates the default identity.\n\n### Required scope(s)\n `settings`",
        "tags": [
          "Identities"
        ],
        "security": [
          {
            "bearerAuth": [
              "settings"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/administration_id"
          },
          {
            "$ref": "#/components/parameters/format"
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/*": {
              "schema": {
                "unevaluatedProperties": false,
                "type": "object",
                "properties": {
                  "identity": {
                    "type": "object",
                    "unevaluatedProperties": false,
                    "properties": {
                      "company_name": {
                        "type": "string"
                      },
                      "legal_entity_type": {
                        "type": "string",
                        "enum": [
                          "eenmanszaak",
                          "maatschap",
                          "vof",
                          "bv",
                          "cv",
                          "nv",
                          "stichting",
                          "vereniging",
                          "coöperatie",
                          "geen_kvk_inschrijving"
                        ]
                      },
                      "country": {
                        "type": "string",
                        "description": "ISO two-character country code, e.g. NL or DE."
                      },
                      "city": {
                        "type": "string"
                      },
                      "zipcode": {
                        "type": "string"
                      },
                      "address1": {
                        "type": "string"
                      },
                      "address2": {
                        "type": "string"
                      },
                      "email": {
                        "type": "string",
                        "description": "Should be a valid email addresses."
                      },
                      "phone": {
                        "type": "string"
                      },
                      "bank_account_name": {
                        "type": "string"
                      },
                      "bank_account_number": {
                        "type": "string"
                      },
                      "bank_account_bic": {
                        "type": "string"
                      },
                      "chamber_of_commerce": {
                        "type": "string"
                      },
                      "tax_number": {
                        "type": "string"
                      },
                      "tax_number_absence_reason": {
                        "type": "string",
                        "description": "Can be `below_tax_threshold` or `industry_exemption`."
                      },
                      "custom_fields_attributes": {
                        "$ref": "#/components/schemas/custom_fields_attributes"
                      },
                      "administration_attributes": {
                        "unevaluatedProperties": false,
                        "properties": {
                          "legal_entity_type": {
                            "type": "string",
                            "enum": [
                              "eenmanszaak",
                              "maatschap",
                              "vof",
                              "bv",
                              "cv",
                              "nv",
                              "stichting",
                              "vereniging",
                              "coöperatie",
                              "geen_kvk_inschrijving"
                            ]
                          }
                        },
                        "required": []
                      }
                    },
                    "required": []
                  }
                },
                "required": []
              },
              "examples": {
                "UpdatesTheDefaultIdentity": {
                  "summary": "Updates the default identity",
                  "value": {
                    "identity": {
                      "company_name": "Second B.V."
                    }
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "A list of identities",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/identity_response"
                },
                "examples": {
                  "UpdatesTheDefaultIdentity": {
                    "summary": "Updates the default identity",
                    "value": {
                      "id": "502689108656653419",
                      "administration_id": 123,
                      "company_name": "Second B.V.",
                      "city": "Enschede",
                      "country": "NL",
                      "zipcode": "7523XD",
                      "address1": "Brouwerijstraat 26",
                      "address2": null,
                      "email": "info@dev.null.moneybird.net",
                      "phone": "0612345678",
                      "bank_account_name": null,
                      "bank_account_number": "NL50TEST0166567191",
                      "bank_account_bic": null,
                      "custom_fields": [],
                      "updated_at": "2026-11-02T12:18:03.618Z",
                      "created_at": "2026-11-02T12:15:13.782Z",
                      "chamber_of_commerce": "08155914",
                      "tax_number": "NL817575546B01"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "Unprocessable entity",
            "content": {
              "application/json": {
                "schema": {
                  "anyOf": [
                    {
                      "$ref": "#/components/schemas/symbolic_error"
                    },
                    {
                      "$ref": "#/components/schemas/non_symbolic_error"
                    }
                  ]
                },
                "examples": {
                  "Returns422WhenUpdatingTheDefaultIdentityWithInvalidParams": {
                    "summary": "Returns 422 when updating the default identity with invalid params",
                    "value": {
                      "error": {
                        "company_name": [
                          "can't be blank"
                        ]
                      },
                      "details": {
                        "company_name": [
                          {
                            "error": "blank"
                          }
                        ]
                      }
                    }
                  }
                }
              }
            }
          }
        },
        "operationId": "patch_administration_id_identities_default"
      }
    },
    "/{administration_id}/identities/{id}{format}": {
      "get": {
        "summary": "Retrieve identity by given id",
        "description": "Returns the identity with the given id.\n\n### Required scope(s)\n `settings`",
        "tags": [
          "Identities"
        ],
        "security": [
          {
            "bearerAuth": [
              "settings"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/administration_id"
          },
          {
            "name": "id",
            "in": "path",
            "required": true,
            "schema": {
              "$ref": "#/components/schemas/identifier"
            }
          },
          {
            "$ref": "#/components/parameters/format"
          }
        ],
        "responses": {
          "200": {
            "description": "A identity",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/identity_response"
                },
                "examples": {
                  "ReturnsASingleIdentity": {
                    "summary": "Returns a single identity",
                    "value": {
                      "id": "502689287014188267",
                      "administration_id": 123,
                      "company_name": "Parkietje B.V.",
                      "city": "Den Haag",
                      "country": "NL",
                      "zipcode": "4321XY",
                      "address1": "Brouwersplein 62",
                      "address2": null,
                      "email": "info@dev.null.moneybird.net",
                      "phone": "1234-5678900",
                      "bank_account_name": "Foobar B.V.",
                      "bank_account_number": "NL80TEST0252789466",
                      "bank_account_bic": null,
                      "custom_fields": [],
                      "updated_at": "2026-11-02T12:18:03.878Z",
                      "created_at": "2026-11-02T12:18:03.878Z",
                      "chamber_of_commerce": "08155914",
                      "tax_number": "NL817575546B01"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Not found",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/symbolic_error"
                },
                "examples": {
                  "Returns404WhenIdentityDoesNotExist": {
                    "summary": "Returns 404 when identity does not exist",
                    "value": {
                      "error": "record not found",
                      "symbolic": {
                        "id": "not_found"
                      }
                    }
                  }
                }
              }
            }
          }
        },
        "operationId": "get_administration_id_identities_id"
      },
      "patch": {
        "summary": "Updates an identity",
        "description": "Updates an identity. The default identity cannot be updated here and returns a 404,\nuse `PATCH /identities/default` instead.\n\n### Required scope(s)\n `settings`",
        "tags": [
          "Identities"
        ],
        "security": [
          {
            "bearerAuth": [
              "settings"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/administration_id"
          },
          {
            "name": "id",
            "in": "path",
            "required": true,
            "schema": {
              "$ref": "#/components/schemas/identifier"
            }
          },
          {
            "$ref": "#/components/parameters/format"
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/*": {
              "schema": {
                "unevaluatedProperties": false,
                "type": "object",
                "properties": {
                  "identity": {
                    "type": "object",
                    "unevaluatedProperties": false,
                    "properties": {
                      "company_name": {
                        "type": "string"
                      },
                      "country": {
                        "type": "string",
                        "description": "ISO two-character country code, e.g. NL or DE."
                      },
                      "city": {
                        "type": "string"
                      },
                      "zipcode": {
                        "type": "string"
                      },
                      "address1": {
                        "type": "string"
                      },
                      "address2": {
                        "type": "string"
                      },
                      "email": {
                        "type": "string",
                        "description": "Should be a valid email addresses."
                      },
                      "phone": {
                        "type": "string"
                      },
                      "bank_account_name": {
                        "type": "string"
                      },
                      "bank_account_number": {
                        "type": "string"
                      },
                      "bank_account_bic": {
                        "type": "string"
                      },
                      "custom_fields_attributes": {
                        "$ref": "#/components/schemas/custom_fields_attributes"
                      }
                    },
                    "required": []
                  }
                },
                "required": []
              },
              "examples": {
                "UpdatesAIdentity": {
                  "summary": "Updates a identity",
                  "value": {
                    "identity": {
                      "company_name": "Second B.V."
                    }
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Identity updated",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/identity_response"
                },
                "examples": {
                  "UpdatesAIdentity": {
                    "summary": "Updates a identity",
                    "value": {
                      "id": "502689286768821457",
                      "administration_id": 123,
                      "company_name": "Second B.V.",
                      "city": "Den Haag",
                      "country": "NL",
                      "zipcode": "4321XY",
                      "address1": "Brouwersplein 62",
                      "address2": null,
                      "email": "info@dev.null.moneybird.net",
                      "phone": "1234-5678900",
                      "bank_account_name": "Foobar B.V.",
                      "bank_account_number": "NL80TEST0252789466",
                      "bank_account_bic": null,
                      "custom_fields": [],
                      "updated_at": "2026-11-02T12:18:03.728Z",
                      "created_at": "2026-11-02T12:18:03.644Z",
                      "chamber_of_commerce": "08155914",
                      "tax_number": "NL817575546B01"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Not found",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/symbolic_error"
                },
                "examples": {
                  "Returns404WhenUpdatingANon-existentIdentity": {
                    "summary": "Returns 404 when updating a non-existent identity",
                    "value": {
                      "error": "record not found",
                      "symbolic": {
                        "id": "not_found"
                      }
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "Unprocessable entity",
            "content": {
              "application/json": {
                "schema": {
                  "anyOf": [
                    {
                      "$ref": "#/components/schemas/symbolic_error"
                    },
                    {
                      "$ref": "#/components/schemas/non_symbolic_error"
                    }
                  ]
                },
                "examples": {
                  "Returns422WhenUpdatingAnIdentityWithInvalidParams": {
                    "summary": "Returns 422 when updating an identity with invalid params",
                    "value": {
                      "error": {
                        "company_name": [
                          "can't be blank"
                        ]
                      },
                      "details": {
                        "company_name": [
                          {
                            "error": "blank"
                          }
                        ]
                      }
                    }
                  }
                }
              }
            }
          }
        },
        "operationId": "patch_administration_id_identities_id"
      },
      "delete": {
        "summary": "Deletes an identity",
        "description": "Deletes an identity. An identity that a document style uses, or that a sales invoice or\nestimate uses that has not been sent yet, cannot be deleted and returns a 422. The default\nidentity cannot be deleted and returns a 404.\n\n### Required scope(s)\n `settings`",
        "tags": [
          "Identities"
        ],
        "security": [
          {
            "bearerAuth": [
              "settings"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/administration_id"
          },
          {
            "name": "id",
            "in": "path",
            "required": true,
            "schema": {
              "$ref": "#/components/schemas/identifier"
            }
          },
          {
            "$ref": "#/components/parameters/format"
          }
        ],
        "responses": {
          "204": {
            "description": "Identity deleted"
          },
          "404": {
            "description": "Not found",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/symbolic_error"
                },
                "examples": {
                  "CannotDeleteTheDefaultIdentity": {
                    "summary": "Cannot delete the default identity",
                    "value": {
                      "error": "record not found",
                      "symbolic": {
                        "id": "not_found"
                      }
                    }
                  }
                }
              }
            }
          },
          "422": {
            "$ref": "#/components/responses/422_unprocessable_entity"
          }
        },
        "operationId": "delete_administration_id_identities_id"
      }
    },
    "/{administration_id}/identities{format}": {
      "get": {
        "summary": "Retrieve identities",
        "description": "An administration can have multiple identities, for example to cover multiple tradenames or offices. This does not include the default identity.\n\n### Required scope(s)\n `settings`",
        "tags": [
          "Identities"
        ],
        "security": [
          {
            "bearerAuth": [
              "settings"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/administration_id"
          },
          {
            "$ref": "#/components/parameters/format"
          }
        ],
        "responses": {
          "200": {
            "description": "A list of identities",
            "content": {
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "$ref": "#/components/schemas/identity_response"
                  }
                },
                "examples": {
                  "ReturnsAllIdentitiesOfAnAdministration": {
                    "summary": "Returns all identities of an administration",
                    "value": [
                      {
                        "id": "502689287253263637",
                        "administration_id": 123,
                        "company_name": "Parkietje B.V.",
                        "city": "Den Haag",
                        "country": "NL",
                        "zipcode": "4321XY",
                        "address1": "Brouwersplein 62",
                        "address2": null,
                        "email": "info@dev.null.moneybird.net",
                        "phone": "1234-5678900",
                        "bank_account_name": "Foobar B.V.",
                        "bank_account_number": "NL80TEST0252789466",
                        "bank_account_bic": null,
                        "custom_fields": [],
                        "updated_at": "2026-11-02T12:18:04.106Z",
                        "created_at": "2026-11-02T12:18:04.106Z",
                        "chamber_of_commerce": "08155914",
                        "tax_number": "NL817575546B01"
                      }
                    ]
                  }
                }
              }
            }
          }
        },
        "operationId": "get_administration_id_identities"
      },
      "post": {
        "summary": "Creates an identity",
        "description": "Most fields for an identity are required. You can provide zero or more custom fields, for each provided\ncustom field value the `id` and `value` are required.\n\n### Required scope(s)\n `settings`",
        "tags": [
          "Identities"
        ],
        "security": [
          {
            "bearerAuth": [
              "settings"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/administration_id"
          },
          {
            "$ref": "#/components/parameters/format"
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/*": {
              "schema": {
                "unevaluatedProperties": false,
                "type": "object",
                "properties": {
                  "identity": {
                    "type": "object",
                    "unevaluatedProperties": false,
                    "properties": {
                      "company_name": {
                        "type": "string"
                      },
                      "country": {
                        "type": "string",
                        "description": "ISO two-character country code, e.g. NL or DE."
                      },
                      "city": {
                        "type": "string"
                      },
                      "zipcode": {
                        "type": "string"
                      },
                      "address1": {
                        "type": "string"
                      },
                      "address2": {
                        "type": "string"
                      },
                      "email": {
                        "type": "string",
                        "description": "Should be a valid email addresses."
                      },
                      "phone": {
                        "type": "string"
                      },
                      "bank_account_name": {
                        "type": "string"
                      },
                      "bank_account_number": {
                        "type": "string"
                      },
                      "bank_account_bic": {
                        "type": "string"
                      },
                      "custom_fields_attributes": {
                        "$ref": "#/components/schemas/custom_fields_attributes"
                      }
                    },
                    "required": [
                      "company_name",
                      "country",
                      "city",
                      "zipcode",
                      "address1",
                      "email"
                    ]
                  }
                },
                "required": []
              },
              "examples": {
                "CreatesAnIdentity": {
                  "summary": "Creates an identity",
                  "value": {
                    "identity": {
                      "company_name": "Foobar B.V.",
                      "address1": "Straat 1",
                      "zipcode": "Zipcode",
                      "city": "Enschede",
                      "country": "NL",
                      "email": "foobar@example.com"
                    }
                  }
                },
                "CreatesAnIdentityWithCustomFields": {
                  "summary": "Creates an identity with custom fields",
                  "value": {
                    "identity": {
                      "company_name": "Foobar B.V.",
                      "address1": "Straat 1",
                      "zipcode": "Zipcode",
                      "city": "Enschede",
                      "country": "NL",
                      "email": "foobar@example.com",
                      "custom_fields_attributes": {
                        "0": {
                          "id": 502689287167280400,
                          "value": "my custom value"
                        }
                      }
                    }
                  }
                }
              }
            }
          }
        },
        "responses": {
          "201": {
            "description": "Identity created",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/identity_response"
                },
                "examples": {
                  "CreatesAnIdentity": {
                    "summary": "Creates an identity",
                    "value": {
                      "id": "502689287128483073",
                      "administration_id": 123,
                      "company_name": "Foobar B.V.",
                      "city": "Enschede",
                      "country": "NL",
                      "zipcode": "Zipcode",
                      "address1": "Straat 1",
                      "address2": null,
                      "email": "foobar@example.com",
                      "phone": null,
                      "bank_account_name": null,
                      "bank_account_number": null,
                      "bank_account_bic": null,
                      "custom_fields": [],
                      "updated_at": "2026-11-02T12:18:03.987Z",
                      "created_at": "2026-11-02T12:18:03.987Z",
                      "chamber_of_commerce": "08155914",
                      "tax_number": "NL817575546B01"
                    }
                  },
                  "CreatesAnIdentityWithCustomFields": {
                    "summary": "Creates an identity with custom fields",
                    "value": {
                      "id": "502689287191397644",
                      "administration_id": 123,
                      "company_name": "Foobar B.V.",
                      "city": "Enschede",
                      "country": "NL",
                      "zipcode": "Zipcode",
                      "address1": "Straat 1",
                      "address2": null,
                      "email": "foobar@example.com",
                      "phone": null,
                      "bank_account_name": null,
                      "bank_account_number": null,
                      "bank_account_bic": null,
                      "custom_fields": [
                        {
                          "id": "502689287167280392",
                          "name": "custom_field_7d6abbe9e23eed130892",
                          "value": "my custom value"
                        }
                      ],
                      "updated_at": "2026-11-02T12:18:04.048Z",
                      "created_at": "2026-11-02T12:18:04.048Z",
                      "chamber_of_commerce": "08155914",
                      "tax_number": "NL817575546B01"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "Unprocessable entity",
            "content": {
              "application/json": {
                "schema": {
                  "anyOf": [
                    {
                      "$ref": "#/components/schemas/symbolic_error"
                    },
                    {
                      "$ref": "#/components/schemas/non_symbolic_error"
                    }
                  ]
                },
                "examples": {
                  "Returns422WhenRequiredParamsAreMissingOrInvalid": {
                    "summary": "Returns 422 when required params are missing or invalid",
                    "value": {
                      "error": {
                        "company_name": [
                          "can't be blank"
                        ],
                        "address1": [
                          "can't be blank"
                        ],
                        "zipcode": [
                          "can't be blank"
                        ],
                        "city": [
                          "can't be blank"
                        ],
                        "country": [
                          "can't be blank",
                          "is invalid"
                        ],
                        "email": [
                          "is not a valid email address"
                        ]
                      },
                      "details": {
                        "company_name": [
                          {
                            "error": "blank"
                          }
                        ],
                        "address1": [
                          {
                            "error": "blank"
                          }
                        ],
                        "zipcode": [
                          {
                            "error": "blank"
                          }
                        ],
                        "city": [
                          {
                            "error": "blank"
                          }
                        ],
                        "country": [
                          {
                            "error": "blank"
                          },
                          {
                            "error": "invalid",
                            "value": null
                          }
                        ],
                        "email": [
                          {
                            "error": "invalid_email"
                          }
                        ]
                      }
                    }
                  }
                }
              }
            }
          }
        },
        "operationId": "post_administration_id_identities"
      }
    },
    "/{administration_id}/ledger_accounts/{id}{format}": {
      "get": {
        "summary": "Returns information about a ledger account",
        "description": "Returns information about a ledger account.\n\n### Required scope(s)\n Any of: `settings`, `sales_invoices`, `documents` or `estimates`",
        "tags": [
          "Ledger accounts"
        ],
        "security": [
          {
            "bearerAuth": [
              "settings"
            ]
          },
          {
            "bearerAuth": [
              "sales_invoices"
            ]
          },
          {
            "bearerAuth": [
              "documents"
            ]
          },
          {
            "bearerAuth": [
              "estimates"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/administration_id"
          },
          {
            "name": "id",
            "in": "path",
            "required": true,
            "schema": {
              "$ref": "#/components/schemas/identifier"
            }
          },
          {
            "$ref": "#/components/parameters/format"
          }
        ],
        "responses": {
          "200": {
            "description": "A ledger account",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ledger_account_response"
                },
                "examples": {
                  "ReturnsALedgerAccount": {
                    "summary": "Returns a ledger account",
                    "value": {
                      "id": "502689208969725659",
                      "administration_id": 123,
                      "name": "Grootboekrekening 2eea8df493e4129d5cee",
                      "account_type": "revenue",
                      "account_id": "80829",
                      "parent_id": null,
                      "active": true,
                      "created_at": "2026-11-02T12:16:49.450Z",
                      "updated_at": "2026-11-02T12:16:49.450Z",
                      "allowed_document_types": [
                        "sales_invoice",
                        "financial_mutation",
                        "general_journal_document"
                      ],
                      "taxonomy_item": {
                        "taxonomy_version": "3.5",
                        "code": "WOmzAovEie",
                        "name": "Eiergeld",
                        "name_english": "Egg money",
                        "reference": "8008040"
                      },
                      "financial_account_id": null
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Not found",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/symbolic_error"
                },
                "examples": {
                  "Returns404WhenRequestingUnexistingLedgerAccount": {
                    "summary": "Returns 404 when requesting unexisting ledger account",
                    "value": {
                      "error": "Record not found for model name: Category"
                    }
                  }
                }
              }
            }
          }
        },
        "operationId": "get_administration_id_ledger_accounts_id"
      },
      "patch": {
        "summary": "Updates a ledger account",
        "description": "Updates a ledger account.\n\n### Required scope(s)\n `settings`",
        "tags": [
          "Ledger accounts"
        ],
        "security": [
          {
            "bearerAuth": [
              "settings"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/administration_id"
          },
          {
            "name": "id",
            "in": "path",
            "required": true,
            "schema": {
              "$ref": "#/components/schemas/identifier"
            }
          },
          {
            "$ref": "#/components/parameters/format"
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/*": {
              "schema": {
                "unevaluatedProperties": false,
                "type": "object",
                "properties": {
                  "ledger_account": {
                    "type": "object",
                    "unevaluatedProperties": false,
                    "properties": {
                      "name": {
                        "type": "string",
                        "description": "Should be unique for this combination of administration and account type."
                      },
                      "account_id": {
                        "type": [
                          "string",
                          "integer"
                        ],
                        "description": "Optional field, also known as general ledger code. Uniqueness is not enforced, but the auditfile export fails when a code is missing or used more than once."
                      },
                      "account_type": {
                        "type": "string",
                        "enum": [
                          "non_current_assets",
                          "current_assets",
                          "equity",
                          "provisions",
                          "non_current_liabilities",
                          "current_liabilities",
                          "revenue",
                          "direct_costs",
                          "expenses",
                          "other_income_expenses"
                        ]
                      },
                      "parent_id": {
                        "$ref": "#/components/schemas/identifier",
                        "description": "Id of the parent ledger account. Should be a valid ledger account id."
                      },
                      "allowed_document_types": {
                        "type": "array",
                        "items": {
                          "type": "string",
                          "enum": [
                            "sales_invoice",
                            "purchase_invoice",
                            "general_journal_document",
                            "financial_mutation",
                            "payment"
                          ]
                        },
                        "description": "Restricts the document types this ledger account can be used on. Defaults to a set derived from the `account_type`."
                      },
                      "description": {
                        "type": "string"
                      }
                    },
                    "required": []
                  },
                  "rgs_code": {
                    "type": "string",
                    "description": "Existing RGS version 3.5 code, e.g. 'WMfoBelMfo'"
                  }
                },
                "required": []
              },
              "examples": {
                "UpdatesTheInformationInTheLedgerAccount": {
                  "summary": "Updates the information in the ledger account",
                  "value": {
                    "ledger_account": {
                      "name": "New name"
                    }
                  }
                },
                "UpdatesALedgerAccountWithTaxonomyItemByProvidingAnExistingRgsCode": {
                  "summary": "Updates a ledger account with taxonomy item by providing an existing rgs code",
                  "value": {
                    "rgs_code": "WMfoBelMfo",
                    "ledger_account": {
                      "name": "new name"
                    }
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Ledger account updated",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ledger_account_response"
                },
                "examples": {
                  "UpdatesTheInformationInTheLedgerAccount": {
                    "summary": "Updates the information in the ledger account",
                    "value": {
                      "id": "502689208810342097",
                      "administration_id": 123,
                      "name": "New name",
                      "account_type": "revenue",
                      "account_id": "80829",
                      "parent_id": null,
                      "active": true,
                      "created_at": "2026-11-02T12:16:49.298Z",
                      "updated_at": "2026-11-02T12:16:49.328Z",
                      "allowed_document_types": [
                        "sales_invoice",
                        "financial_mutation",
                        "general_journal_document"
                      ],
                      "taxonomy_item": {
                        "taxonomy_version": "3.5",
                        "code": "WOmzAovEie",
                        "name": "Eiergeld",
                        "name_english": "Egg money",
                        "reference": "8008040"
                      },
                      "financial_account_id": null
                    }
                  },
                  "UpdatesALedgerAccountWithTaxonomyItemByProvidingAnExistingRgsCode": {
                    "summary": "Updates a ledger account with taxonomy item by providing an existing rgs code",
                    "value": {
                      "id": "502689208882693844",
                      "administration_id": 123,
                      "name": "new name",
                      "account_type": "revenue",
                      "account_id": "80829",
                      "parent_id": null,
                      "active": true,
                      "created_at": "2026-11-02T12:16:49.367Z",
                      "updated_at": "2026-11-02T12:16:49.380Z",
                      "allowed_document_types": [
                        "sales_invoice",
                        "financial_mutation",
                        "general_journal_document"
                      ],
                      "taxonomy_item": {
                        "taxonomy_version": "3.5",
                        "code": "WMfoBelMfo",
                        "name": "Mutatie fiscale oudedagsreserve",
                        "name_english": "Change in tax-deferred retirement reserve",
                        "reference": "9104010"
                      },
                      "financial_account_id": null
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Not found",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/symbolic_error"
                },
                "examples": {
                  "ReturnsA404WhenTheLedgerAccountDoesNotExist": {
                    "summary": "Returns a 404 when the ledger account does not exist",
                    "value": {
                      "error": "record not found",
                      "symbolic": {
                        "id": "not_found"
                      }
                    }
                  },
                  "ReturnsErrorWhenProvidedRgsCodeDoesNotBelongToATaxonomyItemOfVersion35": {
                    "summary": "Returns error when provided rgs code does not belong to a taxonomy item of version 3.5",
                    "value": {
                      "error": "Given RGS code does not belong to a taxonomy item of version 3.5",
                      "symbolic": {
                        "rgs_code": "not_found"
                      }
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "Unprocessable entity",
            "content": {
              "application/json": {
                "schema": {
                  "anyOf": [
                    {
                      "$ref": "#/components/schemas/symbolic_error"
                    },
                    {
                      "$ref": "#/components/schemas/non_symbolic_error"
                    }
                  ]
                },
                "examples": {
                  "ReturnsAnErrorWhenValidationsAreFailing": {
                    "summary": "Returns an error when validations are failing",
                    "value": {
                      "error": {
                        "name": [
                          "can't be blank"
                        ]
                      },
                      "details": {
                        "name": [
                          {
                            "error": "blank"
                          }
                        ]
                      }
                    }
                  }
                }
              }
            }
          }
        },
        "operationId": "patch_administration_id_ledger_accounts_id"
      },
      "delete": {
        "summary": "Deletes a ledger account",
        "description": "Deletes or deactivates a ledger account.\nFirst, an attempt is made to deactivate the ledger account.\nIf that fails, an attempt is made to delete the ledger account.\nReturns a 422 when the ledger account can be neither deactivated nor deleted, for example\na system ledger account or a ledger account with active child ledger accounts.\n\n### Required scope(s)\n `settings`",
        "tags": [
          "Ledger accounts"
        ],
        "security": [
          {
            "bearerAuth": [
              "settings"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/administration_id"
          },
          {
            "name": "id",
            "in": "path",
            "required": true,
            "schema": {
              "$ref": "#/components/schemas/identifier"
            }
          },
          {
            "$ref": "#/components/parameters/format"
          }
        ],
        "responses": {
          "204": {
            "description": "Ledger account deleted"
          },
          "404": {
            "description": "Not found",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/symbolic_error"
                },
                "examples": {
                  "Returns404WhenTheLedgerAccountDoesNotExist": {
                    "summary": "Returns 404 when the ledger account does not exist",
                    "value": {
                      "error": "record not found",
                      "symbolic": {
                        "id": "not_found"
                      }
                    }
                  }
                }
              }
            }
          },
          "422": {
            "$ref": "#/components/responses/422_unprocessable_entity"
          }
        },
        "operationId": "delete_administration_id_ledger_accounts_id"
      }
    },
    "/{administration_id}/ledger_accounts{format}": {
      "get": {
        "summary": "List all ledger accounts of an administration",
        "description": "Returns a list of all the ledger accounts in the administration.\n\nPagination is not supported for this endpoint.\n\n### Required scope(s)\n Any of: `settings`, `sales_invoices`, `documents` or `estimates`",
        "tags": [
          "Ledger accounts"
        ],
        "security": [
          {
            "bearerAuth": [
              "settings"
            ]
          },
          {
            "bearerAuth": [
              "sales_invoices"
            ]
          },
          {
            "bearerAuth": [
              "documents"
            ]
          },
          {
            "bearerAuth": [
              "estimates"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/administration_id"
          },
          {
            "$ref": "#/components/parameters/format"
          }
        ],
        "responses": {
          "200": {
            "description": "A list of ledger accounts",
            "content": {
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "$ref": "#/components/schemas/ledger_account_response"
                  }
                },
                "examples": {
                  "ReturnsAListOfLedgerAccounts": {
                    "summary": "Returns a list of ledger accounts",
                    "value": [
                      {
                        "id": "502689108787725429",
                        "administration_id": 123,
                        "name": "Algemene kosten",
                        "account_type": "expenses",
                        "account_id": "46801.01",
                        "parent_id": null,
                        "active": true,
                        "created_at": "2026-11-02T12:15:13.849Z",
                        "updated_at": "2026-11-02T12:15:13.977Z",
                        "allowed_document_types": [
                          "purchase_invoice",
                          "financial_mutation",
                          "general_journal_document"
                        ],
                        "taxonomy_item": {
                          "taxonomy_version": "3.5",
                          "code": "WBedAlkOal",
                          "name": "Algemene kosten",
                          "name_english": "General expenses",
                          "reference": "4215010"
                        },
                        "financial_account_id": null
                      },
                      {
                        "id": "502689108803454089",
                        "administration_id": 123,
                        "name": "Betaalde en/of ontvangen btw",
                        "account_type": "current_liabilities",
                        "account_id": "16221.01",
                        "parent_id": "502689108787725432",
                        "active": true,
                        "created_at": "2026-11-02T12:15:13.914Z",
                        "updated_at": "2026-11-02T12:15:13.966Z",
                        "allowed_document_types": [
                          "financial_mutation",
                          "general_journal_document"
                        ],
                        "taxonomy_item": {
                          "taxonomy_version": "3.5",
                          "code": "BSchBepBtwAfo",
                          "name": "Afgedragen omzetbelasting",
                          "name_english": "Remitted Value Added Tax",
                          "reference": "1205010.13"
                        },
                        "financial_account_id": null
                      },
                      {
                        "id": "502689108787725432",
                        "administration_id": 123,
                        "name": "Btw",
                        "account_type": "current_liabilities",
                        "account_id": "16221.02",
                        "parent_id": null,
                        "active": true,
                        "created_at": "2026-11-02T12:15:13.849Z",
                        "updated_at": "2026-11-02T12:15:13.971Z",
                        "allowed_document_types": [
                          "financial_mutation",
                          "general_journal_document"
                        ],
                        "taxonomy_item": {
                          "taxonomy_version": "3.5",
                          "code": "BSchBepBtwOvm",
                          "name": "Overige mutaties omzetbelasting",
                          "name_english": "Other Value Added Tax adjustments",
                          "reference": "1205010.15"
                        },
                        "financial_account_id": null
                      },
                      {
                        "id": "502689108787725423",
                        "administration_id": 123,
                        "name": "Crediteuren",
                        "account_type": "current_liabilities",
                        "account_id": "16011",
                        "parent_id": null,
                        "active": true,
                        "created_at": "2026-11-02T12:15:13.849Z",
                        "updated_at": "2026-11-02T12:15:13.849Z",
                        "allowed_document_types": [
                          "financial_mutation",
                          "general_journal_document"
                        ],
                        "taxonomy_item": {
                          "taxonomy_version": "3.5",
                          "code": "BSchCreHac",
                          "name": "Handelscrediteuren nominaal",
                          "name_english": "Trade creditors nominal",
                          "reference": "1203010"
                        },
                        "financial_account_id": null
                      },
                      {
                        "id": "502689108787725424",
                        "administration_id": 123,
                        "name": "Debiteuren",
                        "account_type": "current_assets",
                        "account_id": "13011",
                        "parent_id": null,
                        "active": true,
                        "created_at": "2026-11-02T12:15:13.849Z",
                        "updated_at": "2026-11-02T12:15:13.849Z",
                        "allowed_document_types": [
                          "financial_mutation",
                          "general_journal_document"
                        ],
                        "taxonomy_item": {
                          "taxonomy_version": "3.5",
                          "code": "BVorDebHad",
                          "name": "Handelsdebiteuren nominaal",
                          "name_english": "Trade debtors nominal",
                          "reference": "1101010"
                        },
                        "financial_account_id": null
                      },
                      {
                        "id": "502689109626586269",
                        "administration_id": 123,
                        "name": "Dotatie voorziening dubieuze debiteuren",
                        "account_type": "expenses",
                        "account_id": "45660",
                        "parent_id": "502689108787725431",
                        "active": true,
                        "created_at": "2026-11-02T12:15:14.705Z",
                        "updated_at": "2026-11-02T12:15:14.705Z",
                        "allowed_document_types": [
                          "purchase_invoice",
                          "financial_mutation",
                          "general_journal_document"
                        ],
                        "taxonomy_item": {
                          "taxonomy_version": "3.5",
                          "code": "WBedVkkDvd",
                          "name": "Dotatie voorziening dubieuze debiteuren",
                          "name_english": "Allocation provision for doubtful debts",
                          "reference": "4203160"
                        },
                        "financial_account_id": null
                      },
                      {
                        "id": "502689108787725427",
                        "administration_id": 123,
                        "name": "Financiële rekeningen",
                        "account_type": "current_assets",
                        "account_id": "10510.01",
                        "parent_id": null,
                        "active": true,
                        "created_at": "2026-11-02T12:15:13.849Z",
                        "updated_at": "2026-11-02T12:15:13.937Z",
                        "allowed_document_types": [
                          "financial_mutation",
                          "general_journal_document"
                        ],
                        "taxonomy_item": {
                          "taxonomy_version": "3.5",
                          "code": "BLimKruSto",
                          "name": "Stortingen onderweg",
                          "name_english": "Deposits in transit",
                          "reference": "1003010"
                        },
                        "financial_account_id": null
                      },
                      {
                        "id": "502689108787725435",
                        "administration_id": 123,
                        "name": "Huisvestingskosten",
                        "account_type": "expenses",
                        "account_id": "45185",
                        "parent_id": null,
                        "active": true,
                        "created_at": "2026-11-02T12:15:13.849Z",
                        "updated_at": "2026-11-02T12:15:13.849Z",
                        "allowed_document_types": [
                          "purchase_invoice",
                          "financial_mutation",
                          "general_journal_document"
                        ],
                        "taxonomy_item": {
                          "taxonomy_version": "3.5",
                          "code": "WBedHuiOhv",
                          "name": "Overige huisvestingskosten",
                          "name_english": "Other accommodation expenses",
                          "reference": "4201270"
                        },
                        "financial_account_id": null
                      },
                      {
                        "id": "502689108787725425",
                        "administration_id": 123,
                        "name": "Hulprekeningen",
                        "account_type": "current_assets",
                        "account_id": "13850.01",
                        "parent_id": null,
                        "active": true,
                        "created_at": "2026-11-02T12:15:13.849Z",
                        "updated_at": "2026-11-02T12:15:13.955Z",
                        "allowed_document_types": [
                          "financial_mutation",
                          "general_journal_document"
                        ],
                        "taxonomy_item": {
                          "taxonomy_version": "3.5",
                          "code": "BVorOvrOvk",
                          "name": "Overige vorderingen",
                          "name_english": "Other receivables",
                          "reference": "1103190"
                        },
                        "financial_account_id": null
                      },
                      {
                        "id": "502689108787725426",
                        "administration_id": 123,
                        "name": "Koersverschillen",
                        "account_type": "other_income_expenses",
                        "account_id": "84601",
                        "parent_id": null,
                        "active": true,
                        "created_at": "2026-11-02T12:15:13.849Z",
                        "updated_at": "2026-11-02T12:15:13.849Z",
                        "allowed_document_types": [
                          "purchase_invoice",
                          "financial_mutation",
                          "general_journal_document"
                        ],
                        "taxonomy_item": {
                          "taxonomy_version": "3.5",
                          "code": "WFbeWisWis",
                          "name": "Valutakoersverschillen",
                          "name_english": "Currency exchange differences",
                          "reference": "8407010"
                        },
                        "financial_account_id": null
                      },
                      {
                        "id": "502689108802405502",
                        "administration_id": 123,
                        "name": "Kruisposten",
                        "account_type": "current_assets",
                        "account_id": "10510.02",
                        "parent_id": "502689108787725425",
                        "active": true,
                        "created_at": "2026-11-02T12:15:13.914Z",
                        "updated_at": "2026-11-02T12:15:13.946Z",
                        "allowed_document_types": [
                          "financial_mutation",
                          "general_journal_document"
                        ],
                        "taxonomy_item": {
                          "taxonomy_version": "3.5",
                          "code": "BLimKruSto",
                          "name": "Stortingen onderweg",
                          "name_english": "Deposits in transit",
                          "reference": "1003010"
                        },
                        "financial_account_id": null
                      },
                      {
                        "id": "502689108803454087",
                        "administration_id": 123,
                        "name": "Nog te betalen kosten",
                        "account_type": "current_liabilities",
                        "account_id": "17201",
                        "parent_id": "502689108787725430",
                        "active": true,
                        "created_at": "2026-11-02T12:15:13.914Z",
                        "updated_at": "2026-11-02T12:15:13.914Z",
                        "allowed_document_types": [
                          "financial_mutation",
                          "general_journal_document"
                        ],
                        "taxonomy_item": {
                          "taxonomy_version": "3.5",
                          "code": "BSchOpaNtb",
                          "name": "Nog te betalen andere kosten",
                          "name_english": "Other payable expenses",
                          "reference": "1210020"
                        },
                        "financial_account_id": null
                      },
                      {
                        "id": "502689108803454088",
                        "administration_id": 123,
                        "name": "Nog te factureren omzet",
                        "account_type": "current_assets",
                        "account_id": "14305",
                        "parent_id": "502689108787725428",
                        "active": true,
                        "created_at": "2026-11-02T12:15:13.914Z",
                        "updated_at": "2026-11-02T12:15:13.914Z",
                        "allowed_document_types": [
                          "financial_mutation",
                          "general_journal_document"
                        ],
                        "taxonomy_item": {
                          "taxonomy_version": "3.5",
                          "code": "BVorOvaNtf",
                          "name": "Nog te factureren of nog te verzenden facturen",
                          "name_english": "Invoices not yet billed or sent",
                          "reference": "1104030"
                        },
                        "financial_account_id": null
                      },
                      {
                        "id": "502689108787725436",
                        "administration_id": 123,
                        "name": "Omzet",
                        "account_type": "revenue",
                        "account_id": "81180.01",
                        "parent_id": null,
                        "active": true,
                        "created_at": "2026-11-02T12:15:13.849Z",
                        "updated_at": "2026-11-02T12:15:13.976Z",
                        "allowed_document_types": [
                          "sales_invoice",
                          "financial_mutation",
                          "general_journal_document"
                        ],
                        "taxonomy_item": {
                          "taxonomy_version": "3.5",
                          "code": "WOmzNooNdo",
                          "name": "Opbrengsten uit overige bronnen",
                          "name_english": "Revenue from other sources",
                          "reference": "8004040"
                        },
                        "financial_account_id": null
                      },
                      {
                        "id": "502689108787725434",
                        "administration_id": 123,
                        "name": "Ongecategoriseerde inkomsten",
                        "account_type": "revenue",
                        "account_id": "81180.02",
                        "parent_id": null,
                        "active": true,
                        "created_at": "2026-11-02T12:15:13.849Z",
                        "updated_at": "2026-11-02T12:15:13.976Z",
                        "allowed_document_types": [
                          "sales_invoice",
                          "financial_mutation",
                          "general_journal_document"
                        ],
                        "taxonomy_item": {
                          "taxonomy_version": "3.5",
                          "code": "WOmzNooNdo",
                          "name": "Opbrengsten uit overige bronnen",
                          "name_english": "Revenue from other sources",
                          "reference": "8004040"
                        },
                        "financial_account_id": null
                      },
                      {
                        "id": "502689108787725433",
                        "administration_id": 123,
                        "name": "Ongecategoriseerde uitgaven",
                        "account_type": "expenses",
                        "account_id": "46801.02",
                        "parent_id": null,
                        "active": true,
                        "created_at": "2026-11-02T12:15:13.849Z",
                        "updated_at": "2026-11-02T12:15:13.977Z",
                        "allowed_document_types": [
                          "purchase_invoice",
                          "financial_mutation",
                          "general_journal_document"
                        ],
                        "taxonomy_item": {
                          "taxonomy_version": "3.5",
                          "code": "WBedAlkOal",
                          "name": "Algemene kosten",
                          "name_english": "General expenses",
                          "reference": "4215010"
                        },
                        "financial_account_id": null
                      },
                      {
                        "id": "502689109738783903",
                        "administration_id": 123,
                        "name": "Oninbare omzet",
                        "account_type": "expenses",
                        "account_id": "45661",
                        "parent_id": "502689108787725431",
                        "active": true,
                        "created_at": "2026-11-02T12:15:14.811Z",
                        "updated_at": "2026-11-02T12:15:14.811Z",
                        "allowed_document_types": [
                          "purchase_invoice",
                          "financial_mutation",
                          "general_journal_document"
                        ],
                        "taxonomy_item": {
                          "taxonomy_version": "3.5",
                          "code": "WBedVkkAdd",
                          "name": "Afboeking dubieuze debiteuren",
                          "name_english": "Write-off doubtful debts",
                          "reference": "4203170"
                        },
                        "financial_account_id": null
                      },
                      {
                        "id": "502689108787725430",
                        "administration_id": 123,
                        "name": "Overige schulden",
                        "account_type": "current_liabilities",
                        "account_id": "16525",
                        "parent_id": null,
                        "active": true,
                        "created_at": "2026-11-02T12:15:13.849Z",
                        "updated_at": "2026-11-02T12:15:13.849Z",
                        "allowed_document_types": [
                          "financial_mutation",
                          "general_journal_document"
                        ],
                        "taxonomy_item": {
                          "taxonomy_version": "3.5",
                          "code": "BSchOvsOvs",
                          "name": "Overige schulden",
                          "name_english": "Other debts",
                          "reference": "1209150"
                        },
                        "financial_account_id": null
                      },
                      {
                        "id": "502689108787725428",
                        "administration_id": 123,
                        "name": "Overige vorderingen",
                        "account_type": "current_assets",
                        "account_id": "13850.02",
                        "parent_id": null,
                        "active": true,
                        "created_at": "2026-11-02T12:15:13.849Z",
                        "updated_at": "2026-11-02T12:15:13.959Z",
                        "allowed_document_types": [
                          "financial_mutation",
                          "general_journal_document"
                        ],
                        "taxonomy_item": {
                          "taxonomy_version": "3.5",
                          "code": "BVorOvrOvk",
                          "name": "Overige vorderingen",
                          "name_english": "Other receivables",
                          "reference": "1103190"
                        },
                        "financial_account_id": null
                      },
                      {
                        "id": "502689108803454084",
                        "administration_id": 123,
                        "name": "Te betalen btw",
                        "account_type": "current_liabilities",
                        "account_id": "16221.03",
                        "parent_id": "502689108787725432",
                        "active": true,
                        "created_at": "2026-11-02T12:15:13.914Z",
                        "updated_at": "2026-11-02T12:15:13.974Z",
                        "allowed_document_types": [
                          "general_journal_document"
                        ],
                        "taxonomy_item": {
                          "taxonomy_version": "3.5",
                          "code": "BSchBepBtwOlo",
                          "name": "1c. Omzetbelasting leveringen/diensten belast met overige tarieven, behalve 0%",
                          "name_english": "1c. Value Added Tax on supplies/services subject to other rates, except 0%",
                          "reference": "1205010.04"
                        },
                        "financial_account_id": null
                      },
                      {
                        "id": "502689108803454082",
                        "administration_id": 123,
                        "name": "Te rubriceren betalingen",
                        "account_type": "current_liabilities",
                        "account_id": "10510.05",
                        "parent_id": "502689108787725430",
                        "active": true,
                        "created_at": "2026-11-02T12:15:13.914Z",
                        "updated_at": "2026-11-02T12:15:13.954Z",
                        "allowed_document_types": [
                          "financial_mutation",
                          "general_journal_document"
                        ],
                        "taxonomy_item": {
                          "taxonomy_version": "3.5",
                          "code": "BLimKruSto",
                          "name": "Stortingen onderweg",
                          "name_english": "Deposits in transit",
                          "reference": "1003010"
                        },
                        "financial_account_id": null
                      },
                      {
                        "id": "502689108803454083",
                        "administration_id": 123,
                        "name": "Te rubriceren ontvangen betalingen",
                        "account_type": "current_assets",
                        "account_id": "10510.03",
                        "parent_id": "502689108787725428",
                        "active": true,
                        "created_at": "2026-11-02T12:15:13.914Z",
                        "updated_at": "2026-11-02T12:15:13.950Z",
                        "allowed_document_types": [
                          "financial_mutation",
                          "general_journal_document"
                        ],
                        "taxonomy_item": {
                          "taxonomy_version": "3.5",
                          "code": "BLimKruSto",
                          "name": "Stortingen onderweg",
                          "name_english": "Deposits in transit",
                          "reference": "1003010"
                        },
                        "financial_account_id": null
                      },
                      {
                        "id": "502689108803454081",
                        "administration_id": 123,
                        "name": "Te rubriceren transacties",
                        "account_type": "current_assets",
                        "account_id": "10510.04",
                        "parent_id": "502689108787725425",
                        "active": true,
                        "created_at": "2026-11-02T12:15:13.914Z",
                        "updated_at": "2026-11-02T12:15:13.951Z",
                        "allowed_document_types": [
                          "general_journal_document"
                        ],
                        "taxonomy_item": {
                          "taxonomy_version": "3.5",
                          "code": "BLimKruSto",
                          "name": "Stortingen onderweg",
                          "name_english": "Deposits in transit",
                          "reference": "1003010"
                        },
                        "financial_account_id": null
                      },
                      {
                        "id": "502689108803454085",
                        "administration_id": 123,
                        "name": "Te vorderen btw",
                        "account_type": "current_liabilities",
                        "account_id": "16221.04",
                        "parent_id": "502689108787725432",
                        "active": true,
                        "created_at": "2026-11-02T12:15:13.914Z",
                        "updated_at": "2026-11-02T12:15:13.975Z",
                        "allowed_document_types": [
                          "general_journal_document"
                        ],
                        "taxonomy_item": {
                          "taxonomy_version": "3.5",
                          "code": "BSchBepBtwVoo",
                          "name": "5b. Voorbelasting",
                          "name_english": "5a. Input VAT",
                          "reference": "1205010.09"
                        },
                        "financial_account_id": null
                      },
                      {
                        "id": "502689108787725431",
                        "administration_id": 123,
                        "name": "Verkoopkosten",
                        "account_type": "expenses",
                        "account_id": "45680",
                        "parent_id": null,
                        "active": true,
                        "created_at": "2026-11-02T12:15:13.849Z",
                        "updated_at": "2026-11-02T12:15:13.849Z",
                        "allowed_document_types": [
                          "purchase_invoice",
                          "financial_mutation",
                          "general_journal_document"
                        ],
                        "taxonomy_item": {
                          "taxonomy_version": "3.5",
                          "code": "WBedVkkOvr",
                          "name": "Overige verkoopkosten",
                          "name_english": "Other sales costs",
                          "reference": "4203220"
                        },
                        "financial_account_id": null
                      },
                      {
                        "id": "502689108803454086",
                        "administration_id": 123,
                        "name": "Verrekeningen",
                        "account_type": "current_assets",
                        "account_id": "14510",
                        "parent_id": "502689108787725425",
                        "active": true,
                        "created_at": "2026-11-02T12:15:13.914Z",
                        "updated_at": "2026-11-02T12:15:13.914Z",
                        "allowed_document_types": [
                          "financial_mutation",
                          "general_journal_document"
                        ],
                        "taxonomy_item": {
                          "taxonomy_version": "3.5",
                          "code": "BVorTusTbt",
                          "name": "Tussenrekeningen betalingen",
                          "name_english": "Transitory account payments",
                          "reference": "1105100"
                        },
                        "financial_account_id": null
                      },
                      {
                        "id": "502689108787725437",
                        "administration_id": 123,
                        "name": "Vervoerskosten",
                        "account_type": "expenses",
                        "account_id": "45875",
                        "parent_id": null,
                        "active": true,
                        "created_at": "2026-11-02T12:15:13.849Z",
                        "updated_at": "2026-11-02T12:15:13.849Z",
                        "allowed_document_types": [
                          "purchase_invoice",
                          "financial_mutation",
                          "general_journal_document"
                        ],
                        "taxonomy_item": {
                          "taxonomy_version": "3.5",
                          "code": "WBedTraOtr",
                          "name": "Overige transportkosten",
                          "name_english": "Other transportation costs",
                          "reference": "4205170"
                        },
                        "financial_account_id": null
                      },
                      {
                        "id": "502689108803454079",
                        "administration_id": 123,
                        "name": "Vooruitgefactureerde kosten",
                        "account_type": "current_assets",
                        "account_id": "14101",
                        "parent_id": "502689108787725428",
                        "active": true,
                        "created_at": "2026-11-02T12:15:13.914Z",
                        "updated_at": "2026-11-02T12:15:13.914Z",
                        "allowed_document_types": [
                          "financial_mutation",
                          "general_journal_document"
                        ],
                        "taxonomy_item": {
                          "taxonomy_version": "3.5",
                          "code": "BVorOvaVof",
                          "name": "Vooruitbetaalde facturen",
                          "name_english": "Prepaid invoices",
                          "reference": "1104010"
                        },
                        "financial_account_id": null
                      },
                      {
                        "id": "502689108803454080",
                        "administration_id": 123,
                        "name": "Vooruitgefactureerde omzet",
                        "account_type": "current_liabilities",
                        "account_id": "17250",
                        "parent_id": "502689108787725430",
                        "active": true,
                        "created_at": "2026-11-02T12:15:13.914Z",
                        "updated_at": "2026-11-02T12:15:13.914Z",
                        "allowed_document_types": [
                          "financial_mutation",
                          "general_journal_document"
                        ],
                        "taxonomy_item": {
                          "taxonomy_version": "3.5",
                          "code": "BSchOpaVgo",
                          "name": "Vooruitgefactureerde omzet",
                          "name_english": "Pre-invoiced revenue",
                          "reference": "1210260"
                        },
                        "financial_account_id": null
                      },
                      {
                        "id": "502689109472445595",
                        "administration_id": 123,
                        "name": "Voorziening dubieuze debiteuren",
                        "account_type": "current_assets",
                        "account_id": "13021",
                        "parent_id": "502689108787725424",
                        "active": true,
                        "created_at": "2026-11-02T12:15:14.548Z",
                        "updated_at": "2026-11-02T12:15:14.548Z",
                        "allowed_document_types": [
                          "financial_mutation",
                          "general_journal_document"
                        ],
                        "taxonomy_item": {
                          "taxonomy_version": "3.5",
                          "code": "BVorDebVdd",
                          "name": "Voorziening voor oninbaarheid op vorderingen op handelsdebiteuren",
                          "name_english": "Provision for uncollectibility of trade debtors",
                          "reference": "1101030"
                        },
                        "financial_account_id": null
                      }
                    ]
                  }
                }
              }
            }
          }
        },
        "operationId": "get_administration_id_ledger_accounts"
      },
      "post": {
        "summary": "Creates a new ledger account",
        "description": "The `account_type` determines the kind of ledger account, this can be any of the following values:\n`non_current_assets`, `current_assets`, `equity`, `provisions`, `non_current_liabilities`, `current_liabilities`, `revenue`, `direct_costs`, `expenses`, `other_income_expenses`\n\nBy providing the `parent_id`, it is possible to create a tree of ledger accounts. Make sure the `account_types`\nof the parent and child equal.\n\n### Required scope(s)\n `settings`",
        "tags": [
          "Ledger accounts"
        ],
        "security": [
          {
            "bearerAuth": [
              "settings"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/administration_id"
          },
          {
            "$ref": "#/components/parameters/format"
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/*": {
              "schema": {
                "unevaluatedProperties": false,
                "type": "object",
                "properties": {
                  "ledger_account": {
                    "type": "object",
                    "unevaluatedProperties": false,
                    "properties": {
                      "name": {
                        "type": "string",
                        "description": "Should be unique for this combination of administration and account type."
                      },
                      "account_type": {
                        "type": "string",
                        "enum": [
                          "non_current_assets",
                          "current_assets",
                          "equity",
                          "provisions",
                          "non_current_liabilities",
                          "current_liabilities",
                          "revenue",
                          "direct_costs",
                          "expenses",
                          "other_income_expenses"
                        ]
                      },
                      "account_id": {
                        "type": [
                          "string",
                          "integer"
                        ],
                        "description": "Optional field, also known as general ledger code. Uniqueness is not enforced, but the auditfile export fails when a code is missing or used more than once."
                      },
                      "parent_id": {
                        "$ref": "#/components/schemas/identifier",
                        "description": "Id of the parent ledger account. Should be a valid ledger account id."
                      },
                      "allowed_document_types": {
                        "type": "array",
                        "items": {
                          "type": "string",
                          "enum": [
                            "sales_invoice",
                            "purchase_invoice",
                            "general_journal_document",
                            "financial_mutation",
                            "payment"
                          ]
                        },
                        "description": "Restricts the document types this ledger account can be used on. Defaults to a set derived from the `account_type`."
                      },
                      "description": {
                        "type": "string"
                      }
                    },
                    "required": [
                      "name",
                      "account_type"
                    ]
                  },
                  "rgs_code": {
                    "type": "string",
                    "description": "Existing RGS version 3.5 code, e.g. 'WMfoBelMfo'"
                  }
                },
                "required": [
                  "rgs_code"
                ]
              },
              "examples": {
                "CreatesANewLedgerAccount": {
                  "summary": "Creates a new ledger account",
                  "value": {
                    "ledger_account": {
                      "name": "Test ledger account",
                      "account_type": "expenses",
                      "account_id": 2182
                    },
                    "rgs_code": "WAfsAmv"
                  }
                },
                "CreatesANewLedgerAccountWithTaxonomyItemByProvidingAnExistingRgsCode": {
                  "summary": "Creates a new ledger account with taxonomy item by providing an existing rgs code",
                  "value": {
                    "rgs_code": "WOmzAovEie",
                    "ledger_account": {
                      "name": "Test ledger account",
                      "account_type": "expenses",
                      "account_id": 2182
                    }
                  }
                }
              }
            }
          }
        },
        "responses": {
          "201": {
            "description": "Ledger account created",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ledger_account_response"
                },
                "examples": {
                  "CreatesANewLedgerAccount": {
                    "summary": "Creates a new ledger account",
                    "value": {
                      "id": "502689209141692130",
                      "administration_id": 123,
                      "name": "Test ledger account",
                      "account_type": "expenses",
                      "account_id": "2182",
                      "parent_id": null,
                      "active": true,
                      "created_at": "2026-11-02T12:16:49.613Z",
                      "updated_at": "2026-11-02T12:16:49.613Z",
                      "allowed_document_types": [
                        "purchase_invoice",
                        "financial_mutation",
                        "general_journal_document"
                      ],
                      "taxonomy_item": {
                        "taxonomy_version": "3.5",
                        "code": "WAfsAmv",
                        "name": "Afschrijvingen op materiële vaste activa",
                        "name_english": "Depreciation of tangible fixed assets",
                        "reference": "4102000"
                      },
                      "financial_account_id": null
                    }
                  },
                  "CreatesANewLedgerAccountWithTaxonomyItemByProvidingAnExistingRgsCode": {
                    "summary": "Creates a new ledger account with taxonomy item by providing an existing rgs code",
                    "value": {
                      "id": "502689209206703844",
                      "administration_id": 123,
                      "name": "Test ledger account",
                      "account_type": "expenses",
                      "account_id": "2182",
                      "parent_id": null,
                      "active": true,
                      "created_at": "2026-11-02T12:16:49.675Z",
                      "updated_at": "2026-11-02T12:16:49.675Z",
                      "allowed_document_types": [
                        "purchase_invoice",
                        "financial_mutation",
                        "general_journal_document"
                      ],
                      "taxonomy_item": {
                        "taxonomy_version": "3.5",
                        "code": "WOmzAovEie",
                        "name": "Eiergeld",
                        "name_english": "Egg money",
                        "reference": "8008040"
                      },
                      "financial_account_id": null
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "Bad request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/symbolic_error"
                },
                "examples": {
                  "ReturnsAnErrorWhenNameIsNotProvided": {
                    "summary": "Returns an error when name is not provided",
                    "value": {
                      "error": "Name is required",
                      "symbolic": {
                        "ledger_account": {
                          "name": "required"
                        }
                      }
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Not found",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/symbolic_error"
                },
                "examples": {
                  "ReturnsErrorWhenProvidedRgsCodeDoesNotBelongToATaxonomyItemOfVersion35": {
                    "summary": "Returns error when provided rgs code does not belong to a taxonomy item of version 3.5",
                    "value": {
                      "error": "Given RGS code does not belong to a taxonomy item of version 3.5",
                      "symbolic": {
                        "rgs_code": "not_found"
                      }
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "Unprocessable entity",
            "content": {
              "application/json": {
                "schema": {
                  "anyOf": [
                    {
                      "$ref": "#/components/schemas/symbolic_error"
                    },
                    {
                      "$ref": "#/components/schemas/non_symbolic_error"
                    }
                  ]
                },
                "examples": {
                  "ReturnsAnErrorWhenAnEmptyNameIsProvided": {
                    "summary": "Returns an error when an empty name is provided",
                    "value": {
                      "error": {
                        "name": [
                          "can't be blank"
                        ]
                      },
                      "details": {
                        "name": [
                          {
                            "error": "blank"
                          }
                        ]
                      }
                    }
                  }
                }
              }
            }
          }
        },
        "operationId": "post_administration_id_ledger_accounts"
      }
    },
    "/{administration_id}/payments/{id}{format}": {
      "get": {
        "summary": "Returns information about a payment",
        "description": "Returns information about a payment. The token needs the scope of the invoice the payment belongs to:\n`sales_invoices` for (external) sales invoices, `documents` for purchase invoices and receipts, or\n`sales_invoices`, `documents`, `bank` and `settings` for VAT documents.",
        "tags": [
          "Payments"
        ],
        "security": [
          {
            "bearerAuth": []
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/administration_id"
          },
          {
            "name": "id",
            "in": "path",
            "required": true,
            "schema": {
              "$ref": "#/components/schemas/identifier"
            }
          },
          {
            "$ref": "#/components/parameters/format"
          }
        ],
        "responses": {
          "200": {
            "description": "A payment",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/payment_response"
                },
                "examples": {
                  "ReturnsASinglePayment": {
                    "summary": "Returns a single payment",
                    "value": {
                      "id": "502689275045741926",
                      "administration_id": 123,
                      "invoice_type": "SalesInvoice",
                      "invoice_id": "502689274907329872",
                      "financial_account_id": "502689275037353314",
                      "user_id": 1,
                      "payment_transaction_id": null,
                      "transaction_identifier": null,
                      "price": "363.0",
                      "price_base": "363.0",
                      "payment_date": "2026-11-02",
                      "credit_invoice_id": null,
                      "financial_mutation_id": "502689275042596197",
                      "ledger_account_id": "502689275030013281",
                      "linked_payment_id": null,
                      "manual_payment_action": null,
                      "created_at": "2026-11-02T12:17:52.464Z",
                      "updated_at": "2026-11-02T12:17:52.464Z"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Not found",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/symbolic_error"
                },
                "examples": {
                  "Returns404WhenPaymentDoesNotExist": {
                    "summary": "Returns 404 when payment does not exist",
                    "value": {
                      "error": "record not found",
                      "symbolic": {
                        "id": "not_found"
                      }
                    }
                  }
                }
              }
            }
          }
        },
        "operationId": "get_administration_id_payments_id"
      }
    },
    "/{administration_id}/products/identifier/{identifier}{format}": {
      "get": {
        "summary": "Returns information about a product based on the identifier",
        "description": "Finds the product by the identifier field of the product.\n\n### Required scope(s)\n `settings`",
        "tags": [
          "Products"
        ],
        "security": [
          {
            "bearerAuth": [
              "settings"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/administration_id"
          },
          {
            "name": "identifier",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/format"
          }
        ],
        "responses": {
          "200": {
            "description": "A product",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/product_response"
                },
                "examples": {
                  "ReturnsASingleProductBasedOnTheIdentifier": {
                    "summary": "Returns a single product based on the identifier",
                    "value": {
                      "id": "502689206900884802",
                      "administration_id": 123,
                      "description": "My product description",
                      "title": null,
                      "identifier": "SKU1234",
                      "price": "100.0",
                      "currency": "EUR",
                      "frequency": null,
                      "frequency_type": null,
                      "tax_rate_id": "502689108899923082",
                      "ledger_account_id": "502689108787725434",
                      "created_at": "2026-11-02T12:16:47.476Z",
                      "updated_at": "2026-11-02T12:16:47.476Z"
                    }
                  },
                  "ReturnsASingleProductBasedOnTheIdentifierWithDot": {
                    "summary": "Returns a single product based on the identifier with dot",
                    "value": {
                      "id": "502689206957507910",
                      "administration_id": 123,
                      "description": "My product description",
                      "title": null,
                      "identifier": "aa.bb",
                      "price": "100.0",
                      "currency": "EUR",
                      "frequency": null,
                      "frequency_type": null,
                      "tax_rate_id": "502689108899923082",
                      "ledger_account_id": "502689108787725434",
                      "created_at": "2026-11-02T12:16:47.531Z",
                      "updated_at": "2026-11-02T12:16:47.536Z"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Not found",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/symbolic_error"
                },
                "examples": {
                  "Returns404WhenProductDoesNotExist": {
                    "summary": "Returns 404 when product does not exist",
                    "value": {
                      "error": "record not found",
                      "symbolic": {
                        "id": "not_found"
                      }
                    }
                  }
                }
              }
            }
          }
        },
        "operationId": "get_administration_id_products_identifier_identifier"
      }
    },
    "/{administration_id}/products/{id}/sales_link{format}": {
      "post": {
        "summary": "Create online sales link",
        "description": "This call generates an online sales link, and allows pre-setting the contact for a checkout page. The link is valid for one hour\n\n### Required scope(s)\n `settings`",
        "tags": [
          "Products"
        ],
        "security": [
          {
            "bearerAuth": [
              "settings"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/administration_id"
          },
          {
            "name": "id",
            "in": "path",
            "required": true,
            "schema": {
              "$ref": "#/components/schemas/identifier"
            }
          },
          {
            "$ref": "#/components/parameters/format"
          },
          {
            "name": "contact_id",
            "in": "query",
            "required": false,
            "schema": {
              "$ref": "#/components/schemas/identifier"
            }
          }
        ],
        "responses": {
          "201": {
            "description": "A sales link",
            "content": {
              "application/json": {
                "schema": {
                  "type": "string"
                },
                "examples": {
                  "CreatesAnOnlineSalesLink": {
                    "summary": "Creates an online sales link",
                    "value": "http://checkout.moneybird.dev/o/gGn5DxMPE0Gr"
                  },
                  "CreatesAnOnlineSalesLinkIfNoContactIdIsProvided": {
                    "summary": "Creates an online sales link if no contact id is provided",
                    "value": "http://checkout.moneybird.dev/o/jDw5xlBY1E6b"
                  }
                }
              }
            }
          },
          "404": {
            "description": "Not found",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/symbolic_error"
                },
                "examples": {
                  "Returns404WhenProductDoesNotExist": {
                    "summary": "Returns 404 when product does not exist",
                    "value": {
                      "error": "Record not found for model name: Product"
                    }
                  },
                  "Returns404WhenProductIsNotValidForOnlineSales": {
                    "summary": "Returns 404 when product is not valid for online sales",
                    "value": {
                      "error": "Product not valid for online sales"
                    }
                  },
                  "Returns404IfContactIsNotFound": {
                    "summary": "Returns 404 if contact is not found",
                    "value": {
                      "error": "Record not found for model name: Contact"
                    }
                  }
                }
              }
            }
          }
        },
        "operationId": "post_administration_id_products_id_sales_link"
      }
    },
    "/{administration_id}/products/{id}{format}": {
      "get": {
        "summary": "Returns information about a product",
        "description": "Returns information about a product.\n\n### Required scope(s)\n `settings`",
        "tags": [
          "Products"
        ],
        "security": [
          {
            "bearerAuth": [
              "settings"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/administration_id"
          },
          {
            "name": "id",
            "in": "path",
            "required": true,
            "schema": {
              "$ref": "#/components/schemas/identifier"
            }
          },
          {
            "$ref": "#/components/parameters/format"
          }
        ],
        "responses": {
          "200": {
            "description": "A product",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/product_response"
                },
                "examples": {
                  "ReturnsASingleProduct": {
                    "summary": "Returns a single product",
                    "value": {
                      "id": "502689206389179662",
                      "administration_id": 123,
                      "description": "My product description",
                      "title": null,
                      "identifier": "SKU1234",
                      "price": "100.0",
                      "currency": "EUR",
                      "frequency": null,
                      "frequency_type": null,
                      "tax_rate_id": "502689108899923082",
                      "ledger_account_id": "502689108787725434",
                      "created_at": "2026-11-02T12:16:46.989Z",
                      "updated_at": "2026-11-02T12:16:46.989Z"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Not found",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/symbolic_error"
                },
                "examples": {
                  "Returns404WhenProductDoesNotExist": {
                    "summary": "Returns 404 when product does not exist",
                    "value": {
                      "error": "Record not found for model name: Product"
                    }
                  }
                }
              }
            }
          }
        },
        "operationId": "get_administration_id_products_id"
      },
      "patch": {
        "summary": "Updates a product",
        "description": "Updates a product.\n\n### Required scope(s)\n `settings`",
        "tags": [
          "Products"
        ],
        "security": [
          {
            "bearerAuth": [
              "settings"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/administration_id"
          },
          {
            "name": "id",
            "in": "path",
            "required": true,
            "schema": {
              "$ref": "#/components/schemas/identifier"
            }
          },
          {
            "$ref": "#/components/parameters/format"
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/*": {
              "schema": {
                "unevaluatedProperties": false,
                "type": "object",
                "properties": {
                  "product": {
                    "type": "object",
                    "unevaluatedProperties": false,
                    "properties": {
                      "title": {
                        "type": "string",
                        "description": "The name of the product, displayed on invoices and estimates."
                      },
                      "description": {
                        "type": "string",
                        "description": "A description of the product. Used as the default detail description when adding this product to a document."
                      },
                      "checkout_description": {
                        "type": "string",
                        "description": "A description shown on the checkout page when selling this product online."
                      },
                      "price": {
                        "$ref": "#/components/schemas/money"
                      },
                      "tax_rate_id": {
                        "$ref": "#/components/schemas/identifier",
                        "description": "Should be a valid tax rate id."
                      },
                      "ledger_account_id": {
                        "$ref": "#/components/schemas/identifier",
                        "description": "Should be a valid ledger account id."
                      },
                      "currency": {
                        "type": "string",
                        "description": "ISO three-character currency code, e.g. EUR or USD."
                      },
                      "frequency_type": {
                        "type": "string",
                        "description": "Can be `day`, `week`, `month`, `quarter` or `year`."
                      },
                      "frequency": {
                        "type": "integer",
                        "description": "Should be an integer >= 1."
                      },
                      "product_type": {
                        "type": "string",
                        "description": "Can be `digital_service`, `service` or `product`."
                      },
                      "vat_rate_type": {
                        "type": "string",
                        "description": "Can be `standard` or `reduced`."
                      },
                      "checkout_type": {
                        "type": "string",
                        "description": "Can be `product` or `subscription`."
                      },
                      "max_amount_per_order": {
                        "type": "integer",
                        "description": "When `checkout_type` is `subscription`, should be an integer 0 <= *n* < 2."
                      },
                      "document_style_id": {
                        "$ref": "#/components/schemas/identifier",
                        "description": "Should be a valid document style id."
                      },
                      "workflow_id": {
                        "$ref": "#/components/schemas/identifier",
                        "description": "Should be a valid workflow id."
                      },
                      "identifier": {
                        "type": "string",
                        "description": "Should be unique for the administration."
                      },
                      "frequency_preset": {
                        "type": "string",
                        "pattern": "^\\d+:(day|week|month|quarter|year|custom|nil)$",
                        "description": "Sets `frequency` and `frequency_type` in one value as `<frequency>:<frequency_type>`, e.g. `1:month` or `3:month`. `custom` is ignored, `nil` (e.g. `0:nil`) removes the billing interval."
                      }
                    },
                    "required": []
                  }
                },
                "required": []
              },
              "examples": {
                "UpdatesAProduct": {
                  "summary": "Updates a product",
                  "value": {
                    "product": {
                      "description": "Updated",
                      "price": "123"
                    }
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Product updated",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/product_response"
                },
                "examples": {
                  "UpdatesAProduct": {
                    "summary": "Updates a product",
                    "value": {
                      "id": "502689206553806106",
                      "administration_id": 123,
                      "description": "Updated",
                      "title": null,
                      "identifier": "SKU1234",
                      "price": "123.0",
                      "currency": "EUR",
                      "frequency": null,
                      "frequency_type": null,
                      "tax_rate_id": "502689108899923082",
                      "ledger_account_id": "502689108787725434",
                      "created_at": "2026-11-02T12:16:47.145Z",
                      "updated_at": "2026-11-02T12:16:47.159Z"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "Bad request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/symbolic_error"
                },
                "examples": {
                  "ReturnsA400IfTheValidationsFail": {
                    "summary": "Returns a 400 if the validations fail",
                    "value": {
                      "error": "Product is required",
                      "symbolic": {
                        "product": "required"
                      }
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Not found",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/symbolic_error"
                },
                "examples": {
                  "Returns404WhenProductDoesNotExist": {
                    "summary": "Returns 404 when product does not exist",
                    "value": {
                      "error": "record not found",
                      "symbolic": {
                        "id": "not_found"
                      }
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "Unprocessable entity",
            "content": {
              "application/json": {
                "schema": {
                  "anyOf": [
                    {
                      "$ref": "#/components/schemas/symbolic_error"
                    },
                    {
                      "$ref": "#/components/schemas/non_symbolic_error"
                    }
                  ]
                },
                "examples": {
                  "ReturnsA422IfTheProductIsInvalid": {
                    "summary": "Returns a 422 if the product is invalid",
                    "value": {
                      "error": {
                        "description": [
                          "is too long (maximum is 4096 characters)"
                        ]
                      },
                      "details": {
                        "description": [
                          {
                            "error": "too_long",
                            "count": 4096
                          }
                        ]
                      }
                    }
                  }
                }
              }
            }
          }
        },
        "operationId": "patch_administration_id_products_id"
      },
      "delete": {
        "summary": "Deletes a product",
        "description": "Deletes a product if it has no dependencies.\nIf the product has associated details, subscription products, orders, or subscription templates, deletion is blocked and the product will be deactivated instead.\nIf the product has active subscriptions or subscription templates, deactivation is blocked and an error is returned.\n\n### Required scope(s)\n `settings`",
        "tags": [
          "Products"
        ],
        "security": [
          {
            "bearerAuth": [
              "settings"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/administration_id"
          },
          {
            "name": "id",
            "in": "path",
            "required": true,
            "schema": {
              "$ref": "#/components/schemas/identifier"
            }
          },
          {
            "$ref": "#/components/parameters/format"
          }
        ],
        "responses": {
          "204": {
            "description": "Product deleted"
          },
          "404": {
            "description": "Not found",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/symbolic_error"
                },
                "examples": {
                  "Returns404WhenProductDoesNotExist": {
                    "summary": "Returns 404 when product does not exist",
                    "value": {
                      "error": "record not found",
                      "symbolic": {
                        "id": "not_found"
                      }
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "Unprocessable entity",
            "content": {
              "application/json": {
                "schema": {
                  "anyOf": [
                    {
                      "$ref": "#/components/schemas/symbolic_error"
                    },
                    {
                      "$ref": "#/components/schemas/non_symbolic_error"
                    }
                  ]
                },
                "examples": {
                  "ReturnsA422ResponseWhenProductHasAnSubscriptionProductInTheFuture": {
                    "summary": "Returns a 422 response when product has an subscription product in the future",
                    "value": {
                      "error": "Product cannot be destroyed or deactivated",
                      "symbolic": {
                        "base": "cannot_destroy_or_deactivate"
                      }
                    }
                  },
                  "ReturnsAnErrorWhenProductHasAnActiveSubscriptionProduct": {
                    "summary": "Returns an error when product has an active subscription product",
                    "value": {
                      "error": "Product cannot be destroyed or deactivated",
                      "symbolic": {
                        "base": "cannot_destroy_or_deactivate"
                      }
                    }
                  }
                }
              }
            }
          }
        },
        "operationId": "delete_administration_id_products_id"
      }
    },
    "/{administration_id}/products{format}": {
      "get": {
        "summary": "List all products of an administration",
        "description": "Returns a paginated list of products in the administration. Each page contains 10 products. You can use the `page` parameter to fetch the next page of products.\n\n### Required scope(s)\n `settings`",
        "tags": [
          "Products"
        ],
        "security": [
          {
            "bearerAuth": [
              "settings"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/administration_id"
          },
          {
            "$ref": "#/components/parameters/format"
          },
          {
            "name": "query",
            "in": "query",
            "required": false,
            "description": "Free-text search across the product description, title and identifier.",
            "schema": {
              "type": "string"
            },
            "examples": {
              "AllowsFilteringByQuery": {
                "summary": "Allows filtering by query",
                "value": "apple"
              },
              "HandlesEmptySearchResult": {
                "summary": "Handles empty search result",
                "value": "kjashdfjksadhfjk"
              }
            }
          },
          {
            "$ref": "#/components/parameters/page",
            "description": "The page to fetch, starting at 1."
          },
          {
            "$ref": "#/components/parameters/per_page"
          },
          {
            "name": "currency",
            "in": "query",
            "required": false,
            "schema": {
              "type": "string",
              "description": "ISO three-character currency code, e.g. EUR or USD."
            }
          },
          {
            "name": "active",
            "in": "query",
            "required": false,
            "schema": {
              "type": [
                "boolean",
                "string"
              ],
              "default": true,
              "description": "When true, only active products are returned. Set to false to include deactivated products."
            }
          },
          {
            "name": "for_checkout",
            "in": "query",
            "required": false,
            "schema": {
              "type": [
                "boolean",
                "string"
              ],
              "description": "When true, returns only products with online checkout enabled. When false, returns only products without checkout. Omit to include both."
            }
          },
          {
            "name": "ledger_account_id",
            "in": "query",
            "required": false,
            "schema": {
              "$ref": "#/components/schemas/identifier",
              "description": "Filters products by their associated ledger account."
            }
          }
        ],
        "responses": {
          "200": {
            "description": "A list of products",
            "content": {
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "$ref": "#/components/schemas/product_response"
                  }
                },
                "examples": {
                  "ReturnsAPaginatedResponseForPage2": {
                    "summary": "Returns a paginated response for page 2",
                    "value": [
                      {
                        "id": "502689203837994112",
                        "administration_id": 123,
                        "description": "My product description",
                        "title": null,
                        "identifier": "SKU1234",
                        "price": "100.0",
                        "currency": "EUR",
                        "frequency": null,
                        "frequency_type": null,
                        "tax_rate_id": "502689108899923082",
                        "ledger_account_id": "502689108787725434",
                        "created_at": "2026-11-02T12:16:44.555Z",
                        "updated_at": "2026-11-02T12:16:44.555Z"
                      }
                    ]
                  },
                  "AllowsFilteringByQuery": {
                    "summary": "Allows filtering by query",
                    "value": [
                      {
                        "id": "502689204355990675",
                        "administration_id": 123,
                        "description": "Apple",
                        "title": null,
                        "identifier": null,
                        "price": "100.0",
                        "currency": "EUR",
                        "frequency": null,
                        "frequency_type": null,
                        "tax_rate_id": "502689108899923082",
                        "ledger_account_id": "502689108787725434",
                        "created_at": "2026-11-02T12:16:45.050Z",
                        "updated_at": "2026-11-02T12:16:45.050Z"
                      }
                    ]
                  },
                  "HandlesEmptySearchResult": {
                    "summary": "Handles empty search result",
                    "value": []
                  },
                  "ReturnsAListOfActiveProducts": {
                    "summary": "Returns a list of active products",
                    "value": [
                      {
                        "id": "502689205793588422",
                        "administration_id": 123,
                        "description": "Apple",
                        "title": null,
                        "identifier": null,
                        "price": "100.0",
                        "currency": "EUR",
                        "frequency": null,
                        "frequency_type": null,
                        "tax_rate_id": "502689108899923082",
                        "ledger_account_id": "502689108787725434",
                        "created_at": "2026-11-02T12:16:46.420Z",
                        "updated_at": "2026-11-02T12:16:46.420Z"
                      },
                      {
                        "id": "502689205782054084",
                        "administration_id": 123,
                        "description": "My product description",
                        "title": null,
                        "identifier": "SKU1234",
                        "price": "100.0",
                        "currency": "EUR",
                        "frequency": null,
                        "frequency_type": null,
                        "tax_rate_id": "502689108899923082",
                        "ledger_account_id": "502689108787725434",
                        "created_at": "2026-11-02T12:16:46.409Z",
                        "updated_at": "2026-11-02T12:16:46.409Z"
                      },
                      {
                        "id": "502689205801977032",
                        "administration_id": 123,
                        "description": "Pie",
                        "title": null,
                        "identifier": null,
                        "price": "100.0",
                        "currency": "EUR",
                        "frequency": null,
                        "frequency_type": null,
                        "tax_rate_id": "502689108899923082",
                        "ledger_account_id": "502689108787725434",
                        "created_at": "2026-11-02T12:16:46.429Z",
                        "updated_at": "2026-11-02T12:16:46.429Z"
                      }
                    ]
                  }
                }
              }
            }
          },
          "400": {
            "description": "Bad request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/symbolic_error"
                },
                "examples": {
                  "ReturnsA400IfTheRequestIsInvalid": {
                    "summary": "Returns a 400 if the request is invalid",
                    "value": {
                      "error": "per_page does not have a valid value"
                    }
                  },
                  "ReturnsA400IfPageParamIsInvalid": {
                    "summary": "Returns a 400 if page param is invalid",
                    "value": {
                      "error": "Page is too small",
                      "symbolic": {
                        "page": "min"
                      }
                    }
                  }
                }
              }
            }
          }
        },
        "operationId": "get_administration_id_products"
      },
      "post": {
        "summary": "Creates a new product",
        "description": "Creates a new product.\n\n### Required scope(s)\n `settings`",
        "tags": [
          "Products"
        ],
        "security": [
          {
            "bearerAuth": [
              "settings"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/administration_id"
          },
          {
            "$ref": "#/components/parameters/format"
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/*": {
              "schema": {
                "unevaluatedProperties": false,
                "type": "object",
                "properties": {
                  "product": {
                    "type": "object",
                    "unevaluatedProperties": false,
                    "properties": {
                      "title": {
                        "type": "string",
                        "description": "The name of the product, displayed on invoices and estimates."
                      },
                      "description": {
                        "type": "string",
                        "description": "A description of the product. Used as the default detail description when adding this product to a document."
                      },
                      "checkout_description": {
                        "type": "string",
                        "description": "A description shown on the checkout page when selling this product online via Moneybird checkout."
                      },
                      "price": {
                        "$ref": "#/components/schemas/money"
                      },
                      "document_style_id": {
                        "$ref": "#/components/schemas/identifier",
                        "description": "Should be a valid document style id."
                      },
                      "ledger_account_id": {
                        "$ref": "#/components/schemas/identifier",
                        "description": "Should be a valid ledger account id."
                      },
                      "tax_rate_id": {
                        "$ref": "#/components/schemas/identifier",
                        "description": "Should be a valid tax rate id."
                      },
                      "workflow_id": {
                        "$ref": "#/components/schemas/identifier",
                        "description": "Should be a valid workflow id."
                      },
                      "currency": {
                        "type": "string",
                        "description": "ISO three-character currency code, e.g. EUR or USD."
                      },
                      "checkout_type": {
                        "type": "string",
                        "description": "Can be `product` or `subscription`."
                      },
                      "frequency_type": {
                        "type": "string",
                        "description": "Can be `day`, `week`, `month`, `quarter` or `year`."
                      },
                      "frequency": {
                        "type": "integer",
                        "description": "Should be an integer >= 1."
                      },
                      "product_type": {
                        "type": "string",
                        "description": "Can be `digital_service`, `service` or `product`."
                      },
                      "vat_rate_type": {
                        "type": "string",
                        "description": "Can be `standard` or `reduced`."
                      },
                      "max_amount_per_order": {
                        "type": "integer",
                        "description": "When `checkout_type` is `subscription`, should be an integer 0 <= *n* < 2."
                      },
                      "identifier": {
                        "type": "string",
                        "description": "Should be unique for the administration."
                      },
                      "frequency_preset": {
                        "type": "string",
                        "pattern": "^\\d+:(day|week|month|quarter|year|custom|nil)$",
                        "description": "Sets `frequency` and `frequency_type` in one value as `<frequency>:<frequency_type>`, e.g. `1:month` or `3:month`. `custom` is ignored, `nil` (e.g. `0:nil`) removes the billing interval."
                      }
                    },
                    "required": [
                      "price",
                      "ledger_account_id"
                    ]
                  }
                },
                "required": []
              },
              "examples": {
                "CreatesANewProduct": {
                  "summary": "Creates a new product",
                  "value": {
                    "product": {
                      "description": "Geldvogel",
                      "price": "50,50",
                      "tax_rate_id": 502689206652372300,
                      "ledger_account_id": 502689206660760900
                    }
                  }
                }
              }
            }
          }
        },
        "responses": {
          "201": {
            "description": "Product created",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/product_response"
                },
                "examples": {
                  "CreatesANewProduct": {
                    "summary": "Creates a new product",
                    "value": {
                      "id": "502689206672295211",
                      "administration_id": 123,
                      "description": "Geldvogel",
                      "title": null,
                      "identifier": null,
                      "price": "50.5",
                      "currency": "EUR",
                      "frequency": null,
                      "frequency_type": null,
                      "tax_rate_id": "502689206652372263",
                      "ledger_account_id": "502689206660760873",
                      "created_at": "2026-11-02T12:16:47.259Z",
                      "updated_at": "2026-11-02T12:16:47.259Z"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "Unprocessable entity",
            "content": {
              "application/json": {
                "schema": {
                  "anyOf": [
                    {
                      "$ref": "#/components/schemas/symbolic_error"
                    },
                    {
                      "$ref": "#/components/schemas/non_symbolic_error"
                    }
                  ]
                },
                "examples": {
                  "ReturnsAnErrorWhenInformationIsMissing": {
                    "summary": "Returns an error when information is missing",
                    "value": {
                      "error": {
                        "title": [
                          "can't be blank"
                        ],
                        "description": [
                          "can't be blank"
                        ],
                        "base": [
                          "must contain a title or description"
                        ]
                      },
                      "details": {
                        "title": [
                          {
                            "error": "blank"
                          }
                        ],
                        "description": [
                          {
                            "error": "blank"
                          }
                        ],
                        "base": [
                          {
                            "error": "must_have_a_title_or_description"
                          }
                        ]
                      }
                    }
                  }
                }
              }
            }
          }
        },
        "operationId": "post_administration_id_products"
      }
    },
    "/{administration_id}/projects/{id}{format}": {
      "get": {
        "summary": "Returns information about a project",
        "description": "Returns information about a project.\n\n### Required scope(s)\n `settings`",
        "tags": [
          "Projects"
        ],
        "security": [
          {
            "bearerAuth": [
              "settings"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/administration_id"
          },
          {
            "name": "id",
            "in": "path",
            "required": true,
            "schema": {
              "$ref": "#/components/schemas/identifier"
            }
          },
          {
            "$ref": "#/components/parameters/format"
          }
        ],
        "responses": {
          "200": {
            "description": "A project",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/project_response"
                },
                "examples": {
                  "ReturnsASingleProject": {
                    "summary": "Returns a single project",
                    "value": {
                      "id": "502689292784502133",
                      "name": "Project 1",
                      "state": "active",
                      "budget": 10
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Not found",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/symbolic_error"
                },
                "examples": {
                  "Returns404WhenProjectDoesNotExist": {
                    "summary": "Returns 404 when project does not exist",
                    "value": {
                      "error": "Record not found for model name: Project"
                    }
                  }
                }
              }
            }
          }
        },
        "operationId": "get_administration_id_projects_id"
      },
      "patch": {
        "summary": "Updates a project",
        "description": "Updates a project. Requires permission to settings. Requires a unique name within the administration (if name is provided).\n\n### Required scope(s)\n `settings`",
        "tags": [
          "Projects"
        ],
        "security": [
          {
            "bearerAuth": [
              "settings"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/administration_id"
          },
          {
            "name": "id",
            "in": "path",
            "required": true,
            "schema": {
              "$ref": "#/components/schemas/identifier"
            }
          },
          {
            "$ref": "#/components/parameters/format"
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/*": {
              "schema": {
                "unevaluatedProperties": false,
                "type": "object",
                "properties": {
                  "project": {
                    "type": "object",
                    "unevaluatedProperties": false,
                    "properties": {
                      "name": {
                        "type": "string",
                        "description": "Should be unique for the administration."
                      },
                      "budget": {
                        "$ref": "#/components/schemas/number",
                        "description": "The budget for this project in hours."
                      }
                    },
                    "required": [
                      "name"
                    ]
                  }
                },
                "required": []
              },
              "examples": {
                "UpdatesAProject": {
                  "summary": "Updates a project",
                  "value": {
                    "project": {
                      "name": "Eagle",
                      "budget": 1000
                    }
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Project updated",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/project_response"
                },
                "examples": {
                  "UpdatesAProject": {
                    "summary": "Updates a project",
                    "value": {
                      "id": "502689292851611003",
                      "name": "Eagle",
                      "state": "active",
                      "budget": 1000
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Not found",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/symbolic_error"
                },
                "examples": {
                  "ReturnsA404WhenTheProjectDoesNotExist": {
                    "summary": "Returns a 404 when the project does not exist",
                    "value": {
                      "error": "record not found",
                      "symbolic": {
                        "id": "not_found"
                      }
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "Unprocessable entity",
            "content": {
              "application/json": {
                "schema": {
                  "anyOf": [
                    {
                      "$ref": "#/components/schemas/symbolic_error"
                    },
                    {
                      "$ref": "#/components/schemas/non_symbolic_error"
                    }
                  ]
                },
                "examples": {
                  "ReturnsA422WhenTheProjectIsInvalid": {
                    "summary": "Returns a 422 when the project is invalid",
                    "value": {
                      "error": {
                        "name": [
                          "can't be blank"
                        ]
                      },
                      "details": {
                        "name": [
                          {
                            "error": "blank"
                          }
                        ]
                      }
                    }
                  }
                }
              }
            }
          }
        },
        "operationId": "patch_administration_id_projects_id"
      },
      "delete": {
        "summary": "Deletes a project",
        "description": "Deletes a project. When there are no linked entities (sales invoices, estimates, etc.) the project is deleted. When there are linked entities, the project gets the state `archived`.\n\n### Required scope(s)\n `settings`",
        "tags": [
          "Projects"
        ],
        "security": [
          {
            "bearerAuth": [
              "settings"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/administration_id"
          },
          {
            "name": "id",
            "in": "path",
            "required": true,
            "schema": {
              "$ref": "#/components/schemas/identifier"
            }
          },
          {
            "$ref": "#/components/parameters/format"
          }
        ],
        "responses": {
          "204": {
            "description": "Project deleted"
          },
          "404": {
            "description": "Not found",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/symbolic_error"
                },
                "examples": {
                  "ReturnsA404WhenTheProjectDoesNotExist": {
                    "summary": "Returns a 404 when the project does not exist",
                    "value": {
                      "error": "record not found",
                      "symbolic": {
                        "id": "not_found"
                      }
                    }
                  }
                }
              }
            }
          }
        },
        "operationId": "delete_administration_id_projects_id"
      }
    },
    "/{administration_id}/projects{format}": {
      "get": {
        "summary": "List all projects of an administration",
        "description": "Returns a paginated list of projects in the administration. Each page contains 25 projects. You can use the `page` parameter to fetch the next page of projects. It returns the active projects when no filter is applied.\n\n### Required scope(s)\n `settings`",
        "tags": [
          "Projects"
        ],
        "security": [
          {
            "bearerAuth": [
              "settings"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/administration_id"
          },
          {
            "$ref": "#/components/parameters/format"
          },
          {
            "name": "filter",
            "in": "query",
            "required": false,
            "description": "Filters are `key:value` terms separated by commas (e.g. `state:active`). Any filter you pass replaces the defaults below entirely, so include every key you need. Available filters:\n\n| **Filter** | **Type** | **Default** | **Description** |\n| - | - | - | - |\n| state | `String` | `active` | `all`, `active` or `archived`. Combine values with a pipe, e.g. `state:active|archived` |",
            "schema": {
              "type": "string",
              "default": "state:active"
            },
            "examples": {
              "ReturnsTheListOfFilteredArchivedProjects": {
                "summary": "Returns the list of filtered archived projects",
                "value": "state:archived"
              }
            }
          },
          {
            "$ref": "#/components/parameters/per_page",
            "description": "Amount of projects per page, default: 25"
          },
          {
            "$ref": "#/components/parameters/page",
            "description": "The page to fetch, starting at 1."
          }
        ],
        "responses": {
          "200": {
            "description": "A list of projects",
            "content": {
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "$ref": "#/components/schemas/project_response"
                  }
                },
                "examples": {
                  "ReturnsTheListOfFilteredArchivedProjects": {
                    "summary": "Returns the list of filtered archived projects",
                    "value": [
                      {
                        "id": "502689293063423382",
                        "name": "Project Blackbird",
                        "state": "archived",
                        "budget": 10
                      }
                    ]
                  },
                  "ReturnsTheListOfProjects": {
                    "summary": "Returns the list of projects",
                    "value": [
                      {
                        "id": "502689293104317850",
                        "name": "Project 1",
                        "state": "active",
                        "budget": 10
                      }
                    ]
                  }
                }
              }
            }
          },
          "400": {
            "description": "Bad request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/symbolic_error"
                },
                "examples": {
                  "ReturnsA400IfPageParamIsInvalid": {
                    "summary": "Returns a 400 if page param is invalid",
                    "value": {
                      "error": "Page is too small",
                      "symbolic": {
                        "page": "min"
                      }
                    }
                  }
                }
              }
            }
          }
        },
        "operationId": "get_administration_id_projects"
      },
      "post": {
        "summary": "Creates a new project",
        "description": "Creates a new project. Requires a unique name within the administration.\n\n### Required scope(s)\n `settings`",
        "tags": [
          "Projects"
        ],
        "security": [
          {
            "bearerAuth": [
              "settings"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/administration_id"
          },
          {
            "$ref": "#/components/parameters/format"
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/*": {
              "schema": {
                "unevaluatedProperties": false,
                "type": "object",
                "properties": {
                  "project": {
                    "type": "object",
                    "unevaluatedProperties": false,
                    "properties": {
                      "name": {
                        "type": "string",
                        "description": "Should be unique for the administration."
                      },
                      "budget": {
                        "$ref": "#/components/schemas/number",
                        "description": "The budget for this project in hours. Both a decimal and a string are accepted."
                      }
                    },
                    "required": [
                      "name"
                    ]
                  }
                },
                "required": []
              },
              "examples": {
                "CreatesANewProject": {
                  "summary": "Creates a new project",
                  "value": {
                    "project": {
                      "name": "Falcon"
                    }
                  }
                }
              }
            }
          }
        },
        "responses": {
          "201": {
            "description": "Project created",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/project_response"
                },
                "examples": {
                  "CreatesANewProject": {
                    "summary": "Creates a new project",
                    "value": {
                      "id": "502689292913476994",
                      "name": "Falcon",
                      "state": "active",
                      "budget": null
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "Unprocessable entity",
            "content": {
              "application/json": {
                "schema": {
                  "anyOf": [
                    {
                      "$ref": "#/components/schemas/symbolic_error"
                    },
                    {
                      "$ref": "#/components/schemas/non_symbolic_error"
                    }
                  ]
                },
                "examples": {
                  "ReturnsAnErrorWhenInformationIsMissing": {
                    "summary": "Returns an error when information is missing",
                    "value": {
                      "error": {
                        "name": [
                          "can't be blank"
                        ]
                      },
                      "details": {
                        "name": [
                          {
                            "error": "blank"
                          }
                        ]
                      }
                    }
                  }
                }
              }
            }
          }
        },
        "operationId": "post_administration_id_projects"
      }
    },
    "/{administration_id}/purchase_transactions/{id}/delete{format}": {
      "delete": {
        "summary": "Delete a purchase transaction",
        "description": "This endpoint is deprecated. Use the DELETE /purchase_transactions/{id} endpoint instead. Delete a purchase transaction. Requires that the purchase transaction is pending and doesn't belong to a purchase transaction batch.\n\n### Required scope(s)\n `bank`",
        "deprecated": true,
        "x-sunset": "2026-12-31",
        "tags": [
          "Purchase transactions"
        ],
        "security": [
          {
            "bearerAuth": [
              "bank"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/administration_id"
          },
          {
            "name": "id",
            "in": "path",
            "required": true,
            "schema": {
              "$ref": "#/components/schemas/identifier"
            }
          },
          {
            "$ref": "#/components/parameters/format"
          }
        ],
        "responses": {
          "204": {
            "description": "Purchase transaction deleted"
          }
        },
        "operationId": "delete_administration_id_purchase_transactions_id_delete"
      }
    },
    "/{administration_id}/purchase_transactions/{id}{format}": {
      "get": {
        "summary": "Get a purchase transaction by id",
        "description": "Get a purchase transaction by id.\n\n### Required scope(s)\n `bank`",
        "tags": [
          "Purchase transactions"
        ],
        "security": [
          {
            "bearerAuth": [
              "bank"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/administration_id"
          },
          {
            "name": "id",
            "in": "path",
            "required": true,
            "schema": {
              "$ref": "#/components/schemas/identifier"
            }
          },
          {
            "$ref": "#/components/parameters/format"
          }
        ],
        "responses": {
          "200": {
            "description": "A purchase transaction",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/purchase_transaction_response"
                },
                "examples": {
                  "ReturnsPurchaseTransactionWhenSuccessful": {
                    "summary": "Returns purchase transaction when successful",
                    "value": {
                      "id": "502689217260816156",
                      "administration_id": 123,
                      "financial_account_id": "502689217256621850",
                      "payment_instrument_id": null,
                      "state": "open",
                      "sepa_iban": "NL47TEST9876543210",
                      "sepa_iban_account_name": "Test Inc.",
                      "sepa_bic": "TESTNL22",
                      "source_sepa_iban": "NL28INGB0000000001",
                      "source_sepa_iban_account_name": "ING NL28INGB0000000001",
                      "date": "2026-11-02",
                      "description": "FOOBAR-1",
                      "end_to_end_id": "FOOBAR-1",
                      "contact": {
                        "id": "502689217234601749",
                        "administration_id": 123,
                        "company_name": "Relation 1",
                        "firstname": null,
                        "lastname": null,
                        "address1": null,
                        "address2": null,
                        "zipcode": null,
                        "city": null,
                        "country": "NL",
                        "phone": null,
                        "delivery_method": "Email",
                        "customer_id": "customer-1",
                        "tax_number": null,
                        "chamber_of_commerce": null,
                        "bank_account": "NL47TEST9876543210",
                        "is_trusted": false,
                        "max_transfer_amount": null,
                        "attention": null,
                        "email": "contact1@example.com",
                        "email_ubl": false,
                        "send_invoices_to_attention": null,
                        "send_invoices_to_email": "contact1@example.com",
                        "send_estimates_to_attention": null,
                        "send_estimates_to_email": null,
                        "direct_debit": false,
                        "sepa_active": false,
                        "sepa_iban": "NL47TEST9876543210",
                        "sepa_iban_account_name": "Test Inc.",
                        "sepa_bic": "TESTNL22",
                        "sepa_mandate_id": null,
                        "sepa_mandate_date": null,
                        "sepa_sequence_type": "RCUR",
                        "credit_card_number": null,
                        "credit_card_reference": null,
                        "credit_card_type": null,
                        "tax_number_validated_at": null,
                        "tax_number_valid": null,
                        "invoice_workflow_id": null,
                        "estimate_workflow_id": null,
                        "si_identifier": null,
                        "si_identifier_type": null,
                        "moneybird_payments_mandate": false,
                        "created_at": "2026-11-02T12:16:57.331Z",
                        "updated_at": "2026-11-02T12:16:57.331Z",
                        "version": 1793621817,
                        "sales_invoices_url": "https://moneybird.dev/123/sales_invoices/0000000000000000000000000000000000000000000000000000000000000001/all",
                        "notes": [],
                        "custom_fields": [],
                        "contact_people": [],
                        "archived": false
                      },
                      "amount": "121.0",
                      "created_at": "2026-11-02T12:16:57.357Z",
                      "updated_at": "2026-11-02T12:16:57.357Z",
                      "payable_type": "Document",
                      "payable_id": "502689217246136088",
                      "payment_method": null
                    }
                  },
                  "ReturnsPurchaseTransactionWhenFinancialaccountIsNotABankaccount": {
                    "summary": "Returns purchase transaction when financialaccount is not a bankaccount",
                    "value": {
                      "id": "502689217384548151",
                      "administration_id": 123,
                      "financial_account_id": "502689217361479471",
                      "payment_instrument_id": null,
                      "state": "open",
                      "sepa_iban": "NL47TEST9876543210",
                      "sepa_iban_account_name": "Test Inc.",
                      "sepa_bic": "TESTNL22",
                      "source_sepa_iban": null,
                      "source_sepa_iban_account_name": null,
                      "date": "2026-11-02",
                      "description": "FOOBAR-2",
                      "end_to_end_id": "FOOBAR-2",
                      "contact": {
                        "id": "502689217366722354",
                        "administration_id": 123,
                        "company_name": "Relation 2",
                        "firstname": null,
                        "lastname": null,
                        "address1": null,
                        "address2": null,
                        "zipcode": null,
                        "city": null,
                        "country": "NL",
                        "phone": null,
                        "delivery_method": "Email",
                        "customer_id": "customer-2",
                        "tax_number": null,
                        "chamber_of_commerce": null,
                        "bank_account": "NL47TEST9876543210",
                        "is_trusted": false,
                        "max_transfer_amount": null,
                        "attention": null,
                        "email": "contact2@example.com",
                        "email_ubl": false,
                        "send_invoices_to_attention": null,
                        "send_invoices_to_email": "contact2@example.com",
                        "send_estimates_to_attention": null,
                        "send_estimates_to_email": null,
                        "direct_debit": false,
                        "sepa_active": false,
                        "sepa_iban": "NL47TEST9876543210",
                        "sepa_iban_account_name": "Test Inc.",
                        "sepa_bic": "TESTNL22",
                        "sepa_mandate_id": null,
                        "sepa_mandate_date": null,
                        "sepa_sequence_type": "RCUR",
                        "credit_card_number": null,
                        "credit_card_reference": null,
                        "credit_card_type": null,
                        "tax_number_validated_at": null,
                        "tax_number_valid": null,
                        "invoice_workflow_id": null,
                        "estimate_workflow_id": null,
                        "si_identifier": null,
                        "si_identifier_type": null,
                        "moneybird_payments_mandate": false,
                        "created_at": "2026-11-02T12:16:57.457Z",
                        "updated_at": "2026-11-02T12:16:57.457Z",
                        "version": 1793621817,
                        "sales_invoices_url": "https://moneybird.dev/123/sales_invoices/0000000000000000000000000000000000000000000000000000000000000002/all",
                        "notes": [],
                        "custom_fields": [],
                        "contact_people": [],
                        "archived": false
                      },
                      "amount": "121.0",
                      "created_at": "2026-11-02T12:16:57.474Z",
                      "updated_at": "2026-11-02T12:16:57.474Z",
                      "payable_type": "Document",
                      "payable_id": "502689217377208117",
                      "payment_method": null
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Not found",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/symbolic_error"
                },
                "examples": {
                  "ReturnsErrorsWhenAnErrorOccurred": {
                    "summary": "Returns errors when an error occurred",
                    "value": {
                      "error": "Record not found for model name: Purchase transaction"
                    }
                  }
                }
              }
            }
          }
        },
        "operationId": "get_administration_id_purchase_transactions_id"
      },
      "delete": {
        "summary": "Delete a purchase transaction",
        "description": "Delete a purchase transaction. Requires that the purchase transaction is pending and doesn't belong to a purchase transaction batch.\n\n### Required scope(s)\n `bank`",
        "tags": [
          "Purchase transactions"
        ],
        "security": [
          {
            "bearerAuth": [
              "bank"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/administration_id"
          },
          {
            "name": "id",
            "in": "path",
            "required": true,
            "schema": {
              "$ref": "#/components/schemas/identifier"
            }
          },
          {
            "$ref": "#/components/parameters/format"
          }
        ],
        "responses": {
          "204": {
            "description": "Purchase transaction deleted"
          }
        },
        "operationId": "delete_administration_id_purchase_transactions_id"
      }
    },
    "/{administration_id}/purchase_transactions{format}": {
      "get": {
        "summary": "List all purchase transactions",
        "description": "Returns a list of purchase transactions in the administration.\n\n### Required scope(s)\n `bank`",
        "tags": [
          "Purchase transactions"
        ],
        "security": [
          {
            "bearerAuth": [
              "bank"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/administration_id"
          },
          {
            "$ref": "#/components/parameters/format"
          },
          {
            "name": "filter",
            "in": "query",
            "required": false,
            "description": "Filters are `key:value` terms separated by commas (e.g. `period:this_year,state:open`). Any filter you pass replaces the defaults below entirely, so include every key you need. Available filters:\n\n| **Filter** | **Type** | **Default** | **Description** |\n| --- | --- | --- | --- |\n| state | `String` | `all` | `all`, `open`, `pending_payment`, `paid` or `cancelled` |\n| period | `String` | `nil` | This can either be the description of a period (`this_week`, `prev_week`, `next_week`, `this_month`, `prev_month`, `next_month`, `this_quarter`, `prev_quarter`, `next_quarter`, `this_year`, `prev_year`, `next_year`) or a custom period (`201301..201302`, `20130101..20130131`). A custom period must have a start and an end date. It must not be longer than 10 years and must be between `20000101` and `21000101`. For one month, use `202401..202401`, not `202401`. Without `period`, the filter does not limit the dates. |\n| unbatched | `Boolean` | `true` | `true` or `false` |\n\nYou can filter by multiple states at the same time as well. To do this, separate the state values by a pipe: `state:open|pending_payment`.",
            "schema": {
              "type": "string",
              "default": "unbatched:true"
            },
            "examples": {
              "ReturnsAllPurchaseTransactionsFilteredOnPeriod": {
                "summary": "Returns all purchase transactions filtered on period",
                "value": "period:this_month"
              },
              "DoesNotListTransactions": {
                "summary": "Does not list transactions",
                "value": "state:pending_payment,unbatched:true,signable_by_user:true"
              },
              "ReturnsOnlyPurchaseTransactionsReadyToBeSigned": {
                "summary": "Returns only purchase transactions ready to be signed",
                "value": "state:awaiting_authorization,unbatched:true,signable_by_user:true"
              }
            }
          },
          {
            "$ref": "#/components/parameters/page"
          },
          {
            "$ref": "#/components/parameters/per_page"
          }
        ],
        "responses": {
          "200": {
            "description": "A list of purchase transactions",
            "content": {
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "$ref": "#/components/schemas/purchase_transaction_response"
                  }
                },
                "examples": {
                  "ReturnsAllPurchaseTransactionsFilteredOnPeriod": {
                    "summary": "Returns all purchase transactions filtered on period",
                    "value": [
                      {
                        "id": "502689217431734080",
                        "administration_id": 123,
                        "financial_account_id": "502689217428588350",
                        "payment_instrument_id": null,
                        "state": "open",
                        "sepa_iban": "NL47TEST9876543210",
                        "sepa_iban_account_name": "Test Inc.",
                        "sepa_bic": "TESTNL22",
                        "source_sepa_iban": "NL28INGB0000000001",
                        "source_sepa_iban_account_name": "ING NL28INGB0000000001",
                        "date": "2026-11-02",
                        "description": "FOOBAR-1",
                        "end_to_end_id": "FOOBAR-1",
                        "contact": {
                          "id": "502689217408665401",
                          "administration_id": 123,
                          "company_name": "Relation 1",
                          "firstname": null,
                          "lastname": null,
                          "address1": null,
                          "address2": null,
                          "zipcode": null,
                          "city": null,
                          "country": "NL",
                          "phone": null,
                          "delivery_method": "Email",
                          "customer_id": "customer-1",
                          "tax_number": null,
                          "chamber_of_commerce": null,
                          "bank_account": "NL47TEST9876543210",
                          "is_trusted": false,
                          "max_transfer_amount": null,
                          "attention": null,
                          "email": "contact1@example.com",
                          "email_ubl": false,
                          "send_invoices_to_attention": null,
                          "send_invoices_to_email": "contact1@example.com",
                          "send_estimates_to_attention": null,
                          "send_estimates_to_email": null,
                          "direct_debit": false,
                          "sepa_active": false,
                          "sepa_iban": "NL47TEST9876543210",
                          "sepa_iban_account_name": "Test Inc.",
                          "sepa_bic": "TESTNL22",
                          "sepa_mandate_id": null,
                          "sepa_mandate_date": null,
                          "sepa_sequence_type": "RCUR",
                          "credit_card_number": null,
                          "credit_card_reference": null,
                          "credit_card_type": null,
                          "tax_number_validated_at": null,
                          "tax_number_valid": null,
                          "invoice_workflow_id": null,
                          "estimate_workflow_id": null,
                          "si_identifier": null,
                          "si_identifier_type": null,
                          "moneybird_payments_mandate": false,
                          "created_at": "2026-11-02T12:16:57.498Z",
                          "updated_at": "2026-11-02T12:16:57.498Z",
                          "version": 1793621817,
                          "sales_invoices_url": "https://moneybird.dev/123/sales_invoices/0000000000000000000000000000000000000000000000000000000000000001/all",
                          "notes": [],
                          "custom_fields": [],
                          "contact_people": [],
                          "archived": false
                        },
                        "amount": "121.0",
                        "created_at": "2026-11-02T12:16:57.520Z",
                        "updated_at": "2026-11-02T12:16:57.520Z",
                        "payable_type": "Document",
                        "payable_id": "502689217420199740",
                        "payment_method": null
                      }
                    ]
                  },
                  "ReturnsAllPurchaseTransactionsOfAnAdministration": {
                    "summary": "Returns all purchase transactions of an administration",
                    "value": [
                      {
                        "id": "502689217508280146",
                        "administration_id": 123,
                        "financial_account_id": "502689217504085840",
                        "payment_instrument_id": null,
                        "state": "open",
                        "sepa_iban": "NL47TEST9876543210",
                        "sepa_iban_account_name": "Test Inc.",
                        "sepa_bic": "TESTNL22",
                        "source_sepa_iban": "NL28INGB0000000001",
                        "source_sepa_iban_account_name": "ING NL28INGB0000000001",
                        "date": "2026-11-02",
                        "description": "FOOBAR-1",
                        "end_to_end_id": "FOOBAR-1",
                        "contact": {
                          "id": "502689217485211467",
                          "administration_id": 123,
                          "company_name": "Relation 1",
                          "firstname": null,
                          "lastname": null,
                          "address1": null,
                          "address2": null,
                          "zipcode": null,
                          "city": null,
                          "country": "NL",
                          "phone": null,
                          "delivery_method": "Email",
                          "customer_id": "customer-1",
                          "tax_number": null,
                          "chamber_of_commerce": null,
                          "bank_account": "NL47TEST9876543210",
                          "is_trusted": false,
                          "max_transfer_amount": null,
                          "attention": null,
                          "email": "contact1@example.com",
                          "email_ubl": false,
                          "send_invoices_to_attention": null,
                          "send_invoices_to_email": "contact1@example.com",
                          "send_estimates_to_attention": null,
                          "send_estimates_to_email": null,
                          "direct_debit": false,
                          "sepa_active": false,
                          "sepa_iban": "NL47TEST9876543210",
                          "sepa_iban_account_name": "Test Inc.",
                          "sepa_bic": "TESTNL22",
                          "sepa_mandate_id": null,
                          "sepa_mandate_date": null,
                          "sepa_sequence_type": "RCUR",
                          "credit_card_number": null,
                          "credit_card_reference": null,
                          "credit_card_type": null,
                          "tax_number_validated_at": null,
                          "tax_number_valid": null,
                          "invoice_workflow_id": null,
                          "estimate_workflow_id": null,
                          "si_identifier": null,
                          "si_identifier_type": null,
                          "moneybird_payments_mandate": false,
                          "created_at": "2026-11-02T12:16:57.570Z",
                          "updated_at": "2026-11-02T12:16:57.570Z",
                          "version": 1793621817,
                          "sales_invoices_url": "https://moneybird.dev/123/sales_invoices/0000000000000000000000000000000000000000000000000000000000000001/all",
                          "notes": [],
                          "custom_fields": [],
                          "contact_people": [],
                          "archived": false
                        },
                        "amount": "121.0",
                        "created_at": "2026-11-02T12:16:57.592Z",
                        "updated_at": "2026-11-02T12:16:57.592Z",
                        "payable_type": "Document",
                        "payable_id": "502689217496745806",
                        "payment_method": null
                      }
                    ]
                  },
                  "DoesNotListTransactions": {
                    "summary": "Does not list transactions",
                    "value": []
                  },
                  "ReturnsOnlyPurchaseTransactionsReadyToBeSigned": {
                    "summary": "Returns only purchase transactions ready to be signed",
                    "value": [
                      {
                        "id": "502689217724286841",
                        "administration_id": 123,
                        "financial_account_id": "502689217709606774",
                        "payment_instrument_id": null,
                        "state": "awaiting_authorization",
                        "sepa_iban": "NL47TEST9876543210",
                        "sepa_iban_account_name": "Test Inc.",
                        "sepa_bic": "TESTNL22",
                        "source_sepa_iban": "NL35ADYB0000000001",
                        "source_sepa_iban_account_name": "Moneybird NL35ADYB0000000001",
                        "date": "2026-11-02",
                        "description": "2026-0003",
                        "end_to_end_id": "2026-0003",
                        "contact": {
                          "id": "502689217687586673",
                          "administration_id": 123,
                          "company_name": "Relation 2",
                          "firstname": null,
                          "lastname": null,
                          "address1": null,
                          "address2": null,
                          "zipcode": null,
                          "city": null,
                          "country": "NL",
                          "phone": null,
                          "delivery_method": "Email",
                          "customer_id": "customer-2",
                          "tax_number": null,
                          "chamber_of_commerce": null,
                          "bank_account": "NL47TEST9876543210",
                          "is_trusted": false,
                          "max_transfer_amount": null,
                          "attention": null,
                          "email": "contact2@example.com",
                          "email_ubl": false,
                          "send_invoices_to_attention": null,
                          "send_invoices_to_email": "contact2@example.com",
                          "send_estimates_to_attention": null,
                          "send_estimates_to_email": null,
                          "direct_debit": false,
                          "sepa_active": false,
                          "sepa_iban": "NL47TEST9876543210",
                          "sepa_iban_account_name": "Test Inc.",
                          "sepa_bic": "TESTNL22",
                          "sepa_mandate_id": null,
                          "sepa_mandate_date": null,
                          "sepa_sequence_type": "RCUR",
                          "credit_card_number": null,
                          "credit_card_reference": null,
                          "credit_card_type": null,
                          "tax_number_validated_at": null,
                          "tax_number_valid": null,
                          "invoice_workflow_id": null,
                          "estimate_workflow_id": null,
                          "si_identifier": null,
                          "si_identifier_type": null,
                          "moneybird_payments_mandate": false,
                          "created_at": "2026-11-02T12:16:57.763Z",
                          "updated_at": "2026-11-02T12:16:57.763Z",
                          "version": 1793621817,
                          "sales_invoices_url": "https://moneybird.dev/123/sales_invoices/0000000000000000000000000000000000000000000000000000000000000002/all",
                          "notes": [],
                          "custom_fields": [],
                          "contact_people": [],
                          "archived": false
                        },
                        "amount": "121.0",
                        "created_at": "2026-11-02T12:16:57.799Z",
                        "updated_at": "2026-11-02T12:16:57.799Z",
                        "payable_type": "Document",
                        "payable_id": "502689217700169588",
                        "payment_method": null
                      }
                    ]
                  },
                  "DoesNotListPaidTransactions": {
                    "summary": "Does not list paid transactions",
                    "value": []
                  }
                }
              }
            }
          }
        },
        "operationId": "get_administration_id_purchase_transactions"
      }
    },
    "/{administration_id}/recurring_sales_invoices/synchronization{format}": {
      "get": {
        "summary": "List all IDs and versions",
        "description": "Returns all recurring sales invoices in the administration. The list contains the invoice id and the version of the\nrecurring invoice. Check if the version of the recurring invoice is newer than the version you have stored locally,\nuse the `POST` variant for fetching recurring invoices with the given IDs.\n\n### Required scope(s)\n `sales_invoices`",
        "tags": [
          "Recurring sales invoices"
        ],
        "security": [
          {
            "bearerAuth": [
              "sales_invoices"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/administration_id"
          },
          {
            "$ref": "#/components/parameters/format"
          },
          {
            "name": "filter",
            "in": "query",
            "required": false,
            "description": "Comma-separated `key:value` filter terms. Same syntax as `GET /recurring_sales_invoices` — see that operation's description for the available keys.",
            "schema": {
              "type": "string"
            },
            "examples": {
              "RetrievesTheIdsForSynchronizationWithAFilter": {
                "summary": "Retrieves the ids for synchronization with a filter",
                "value": "frequency:month"
              }
            }
          }
        ],
        "responses": {
          "200": {
            "description": "IDs and versions of records",
            "content": {
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "type": "object",
                    "unevaluatedProperties": false,
                    "properties": {
                      "id": {
                        "type": [
                          "integer",
                          "string"
                        ]
                      },
                      "version": {
                        "type": [
                          "integer",
                          "string"
                        ]
                      }
                    }
                  }
                },
                "examples": {
                  "RetrievesTheIdsForSynchronizationWithAFilter": {
                    "summary": "Retrieves the ids for synchronization with a filter",
                    "value": [
                      {
                        "id": "502689212642886819",
                        "version": 1793621812
                      }
                    ]
                  },
                  "RetrievesTheIdsForSynchronization": {
                    "summary": "Retrieves the ids for synchronization",
                    "value": [
                      {
                        "id": "502689212764521654",
                        "version": 1793621813
                      },
                      {
                        "id": "502689212729918640",
                        "version": 1793621813
                      }
                    ]
                  }
                }
              }
            }
          }
        },
        "operationId": "get_administration_id_recurring_sales_invoices_synchronization"
      },
      "post": {
        "summary": "Fetch recurring sales invoices with given IDs",
        "x-query": true,
        "description": "Given a list of recurring sales invoice IDs, returns the details of the recurring invoices.\nReturns a maximum of 100 recurring invoices, even if more IDs are provided.\n\n### Required scope(s)\n `sales_invoices`",
        "tags": [
          "Recurring sales invoices"
        ],
        "security": [
          {
            "bearerAuth": [
              "sales_invoices"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/administration_id"
          },
          {
            "$ref": "#/components/parameters/format"
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/*": {
              "schema": {
                "unevaluatedProperties": false,
                "type": "object",
                "properties": {
                  "ids": {
                    "type": "array",
                    "items": {
                      "type": [
                        "integer",
                        "string"
                      ]
                    }
                  }
                },
                "required": [
                  "ids"
                ]
              },
              "examples": {
                "RetrievesRecurringSalesInvoicesGivenByIds": {
                  "summary": "Retrieves recurring sales invoices given by ids",
                  "value": {
                    "ids": [
                      502689209542248200,
                      502689209568462600
                    ]
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "A list of recurring sales invoices",
            "content": {
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "$ref": "#/components/schemas/recurring_sales_invoice_response"
                  }
                },
                "examples": {
                  "RetrievesRecurringSalesInvoicesGivenByIds": {
                    "summary": "Retrieves recurring sales invoices given by ids",
                    "value": [
                      {
                        "id": "502689209568462592",
                        "administration_id": 123,
                        "contact_id": "502689209519179515",
                        "contact": {
                          "id": "502689209519179515",
                          "administration_id": 123,
                          "company_name": "Foobar Holding B.V.",
                          "firstname": null,
                          "lastname": null,
                          "address1": "Hoofdstraat 12",
                          "address2": null,
                          "zipcode": "1234AB",
                          "city": "Amsterdam",
                          "country": "NL",
                          "phone": null,
                          "delivery_method": "Email",
                          "customer_id": "customer-2",
                          "tax_number": null,
                          "chamber_of_commerce": null,
                          "bank_account": null,
                          "is_trusted": false,
                          "max_transfer_amount": null,
                          "attention": null,
                          "email": "info@example.com",
                          "email_ubl": true,
                          "send_invoices_to_attention": null,
                          "send_invoices_to_email": "info@example.com",
                          "send_estimates_to_attention": null,
                          "send_estimates_to_email": "info@example.com",
                          "direct_debit": false,
                          "sepa_active": false,
                          "sepa_iban": null,
                          "sepa_iban_account_name": null,
                          "sepa_bic": null,
                          "sepa_mandate_id": null,
                          "sepa_mandate_date": null,
                          "sepa_sequence_type": "RCUR",
                          "credit_card_number": null,
                          "credit_card_reference": null,
                          "credit_card_type": null,
                          "tax_number_validated_at": null,
                          "tax_number_valid": null,
                          "invoice_workflow_id": null,
                          "estimate_workflow_id": null,
                          "si_identifier": null,
                          "si_identifier_type": null,
                          "moneybird_payments_mandate": false,
                          "created_at": "2026-11-02T12:16:49.973Z",
                          "updated_at": "2026-11-02T12:16:49.973Z",
                          "version": 1793621809,
                          "sales_invoices_url": "https://moneybird.dev/123/sales_invoices/0000000000000000000000000000000000000000000000000000000000000002/all",
                          "notes": [],
                          "custom_fields": [],
                          "contact_people": [],
                          "archived": false
                        },
                        "contact_person_id": null,
                        "contact_person": null,
                        "workflow_id": "502689109097055375",
                        "start_date": "2026-11-03",
                        "invoice_date": "2026-11-03",
                        "last_date": "2026-11-03",
                        "active": true,
                        "payment_conditions": "We verzoeken u vriendelijk het bovenstaande bedrag van {document.total_price} voor {document.due_date} te voldoen op onze bankrekening onder vermelding van de omschrijving {document.payment_reference}. Voor vragen kunt u contact opnemen per e-mail.",
                        "reference": "Project X",
                        "language": "nl",
                        "currency": "EUR",
                        "discount": "0.0",
                        "first_due_interval": 14,
                        "auto_send": false,
                        "sending_scheduled_at": null,
                        "sending_scheduled_user_id": null,
                        "frequency_type": "month",
                        "frequency": 1,
                        "created_at": "2026-11-02T12:16:50.021Z",
                        "updated_at": "2026-11-02T12:16:50.024Z",
                        "version": 1793621810,
                        "prices_are_incl_tax": false,
                        "total_price_excl_tax": "2.91",
                        "total_price_excl_tax_base": "2.91",
                        "total_price_incl_tax": "3.52",
                        "total_price_incl_tax_base": "3.52",
                        "details": [
                          {
                            "id": "502689209570559745",
                            "administration_id": 123,
                            "tax_rate_id": "502689108899923082",
                            "ledger_account_id": "502689108787725434",
                            "project_id": null,
                            "product_id": null,
                            "amount": "5 stuks",
                            "amount_decimal": "5.0",
                            "description": "Appels",
                            "price": "0.45",
                            "period": null,
                            "row_order": 1,
                            "total_price_excl_tax_with_discount": "2.25",
                            "total_price_excl_tax_with_discount_base": "2.25",
                            "tax_report_reference": [
                              "NL/1a"
                            ],
                            "mandatory_tax_text": null,
                            "created_at": "2026-11-02T12:16:50.022Z",
                            "updated_at": "2026-11-02T12:16:50.022Z"
                          },
                          {
                            "id": "502689209571608322",
                            "administration_id": 123,
                            "tax_rate_id": "502689108899923082",
                            "ledger_account_id": "502689108787725434",
                            "project_id": null,
                            "product_id": null,
                            "amount": "2 stuks",
                            "amount_decimal": "2.0",
                            "description": "Peren",
                            "price": "0.33",
                            "period": null,
                            "row_order": 2,
                            "total_price_excl_tax_with_discount": "0.66",
                            "total_price_excl_tax_with_discount_base": "0.66",
                            "tax_report_reference": [
                              "NL/1a"
                            ],
                            "mandatory_tax_text": null,
                            "created_at": "2026-11-02T12:16:50.023Z",
                            "updated_at": "2026-11-02T12:16:50.023Z"
                          }
                        ],
                        "custom_fields": [],
                        "notes": [],
                        "attachments": [],
                        "events": [
                          {
                            "administration_id": 123,
                            "user_id": "502689108256097381",
                            "action": "recurring_sales_invoice_created",
                            "link_entity_id": null,
                            "link_entity_type": null,
                            "data": {},
                            "created_at": "2026-11-02T12:16:50.027Z",
                            "updated_at": "2026-11-02T12:16:50.027Z"
                          }
                        ],
                        "subscription": null
                      },
                      {
                        "id": "502689209542248188",
                        "administration_id": 123,
                        "contact_id": "502689209519179515",
                        "contact": {
                          "id": "502689209519179515",
                          "administration_id": 123,
                          "company_name": "Foobar Holding B.V.",
                          "firstname": null,
                          "lastname": null,
                          "address1": "Hoofdstraat 12",
                          "address2": null,
                          "zipcode": "1234AB",
                          "city": "Amsterdam",
                          "country": "NL",
                          "phone": null,
                          "delivery_method": "Email",
                          "customer_id": "customer-2",
                          "tax_number": null,
                          "chamber_of_commerce": null,
                          "bank_account": null,
                          "is_trusted": false,
                          "max_transfer_amount": null,
                          "attention": null,
                          "email": "info@example.com",
                          "email_ubl": true,
                          "send_invoices_to_attention": null,
                          "send_invoices_to_email": "info@example.com",
                          "send_estimates_to_attention": null,
                          "send_estimates_to_email": "info@example.com",
                          "direct_debit": false,
                          "sepa_active": false,
                          "sepa_iban": null,
                          "sepa_iban_account_name": null,
                          "sepa_bic": null,
                          "sepa_mandate_id": null,
                          "sepa_mandate_date": null,
                          "sepa_sequence_type": "RCUR",
                          "credit_card_number": null,
                          "credit_card_reference": null,
                          "credit_card_type": null,
                          "tax_number_validated_at": null,
                          "tax_number_valid": null,
                          "invoice_workflow_id": null,
                          "estimate_workflow_id": null,
                          "si_identifier": null,
                          "si_identifier_type": null,
                          "moneybird_payments_mandate": false,
                          "created_at": "2026-11-02T12:16:49.973Z",
                          "updated_at": "2026-11-02T12:16:49.973Z",
                          "version": 1793621809,
                          "sales_invoices_url": "https://moneybird.dev/123/sales_invoices/0000000000000000000000000000000000000000000000000000000000000002/all",
                          "notes": [],
                          "custom_fields": [],
                          "contact_people": [],
                          "archived": false
                        },
                        "contact_person_id": null,
                        "contact_person": null,
                        "workflow_id": "502689109097055375",
                        "start_date": "2026-11-03",
                        "invoice_date": "2026-11-03",
                        "last_date": "2026-11-03",
                        "active": true,
                        "payment_conditions": "We verzoeken u vriendelijk het bovenstaande bedrag van {document.total_price} voor {document.due_date} te voldoen op onze bankrekening onder vermelding van de omschrijving {document.payment_reference}. Voor vragen kunt u contact opnemen per e-mail.",
                        "reference": "Project X",
                        "language": "nl",
                        "currency": "EUR",
                        "discount": "0.0",
                        "first_due_interval": 14,
                        "auto_send": false,
                        "sending_scheduled_at": null,
                        "sending_scheduled_user_id": null,
                        "frequency_type": "year",
                        "frequency": 1,
                        "created_at": "2026-11-02T12:16:49.995Z",
                        "updated_at": "2026-11-02T12:16:49.998Z",
                        "version": 1793621809,
                        "prices_are_incl_tax": false,
                        "total_price_excl_tax": "2.91",
                        "total_price_excl_tax_base": "2.91",
                        "total_price_incl_tax": "3.52",
                        "total_price_incl_tax_base": "3.52",
                        "details": [
                          {
                            "id": "502689209543296765",
                            "administration_id": 123,
                            "tax_rate_id": "502689108899923082",
                            "ledger_account_id": "502689108787725434",
                            "project_id": null,
                            "product_id": null,
                            "amount": "5 stuks",
                            "amount_decimal": "5.0",
                            "description": "Appels",
                            "price": "0.45",
                            "period": null,
                            "row_order": 1,
                            "total_price_excl_tax_with_discount": "2.25",
                            "total_price_excl_tax_with_discount_base": "2.25",
                            "tax_report_reference": [
                              "NL/1a"
                            ],
                            "mandatory_tax_text": null,
                            "created_at": "2026-11-02T12:16:49.996Z",
                            "updated_at": "2026-11-02T12:16:49.996Z"
                          },
                          {
                            "id": "502689209544345342",
                            "administration_id": 123,
                            "tax_rate_id": "502689108899923082",
                            "ledger_account_id": "502689108787725434",
                            "project_id": null,
                            "product_id": null,
                            "amount": "2 stuks",
                            "amount_decimal": "2.0",
                            "description": "Peren",
                            "price": "0.33",
                            "period": null,
                            "row_order": 2,
                            "total_price_excl_tax_with_discount": "0.66",
                            "total_price_excl_tax_with_discount_base": "0.66",
                            "tax_report_reference": [
                              "NL/1a"
                            ],
                            "mandatory_tax_text": null,
                            "created_at": "2026-11-02T12:16:49.998Z",
                            "updated_at": "2026-11-02T12:16:49.998Z"
                          }
                        ],
                        "custom_fields": [],
                        "notes": [],
                        "attachments": [],
                        "events": [
                          {
                            "administration_id": 123,
                            "user_id": "502689108256097381",
                            "action": "recurring_sales_invoice_created",
                            "link_entity_id": null,
                            "link_entity_type": null,
                            "data": {},
                            "created_at": "2026-11-02T12:16:49.999Z",
                            "updated_at": "2026-11-02T12:16:49.999Z"
                          }
                        ],
                        "subscription": null
                      }
                    ]
                  }
                }
              }
            }
          },
          "400": {
            "description": "Bad request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/symbolic_error"
                },
                "examples": {
                  "Returns400WhenInvalidParametersAreProvided": {
                    "summary": "Returns 400 when invalid parameters are provided",
                    "value": {
                      "error": "Ids isn't an array",
                      "symbolic": {
                        "ids": "array"
                      }
                    }
                  }
                }
              }
            }
          }
        },
        "operationId": "post_administration_id_recurring_sales_invoices_synchronization"
      }
    },
    "/{administration_id}/recurring_sales_invoices/{id}{format}": {
      "get": {
        "summary": "Get a recurring sales invoice by id",
        "description": "Get a recurring sales invoice by id.\n\n### Required scope(s)\n `sales_invoices`",
        "tags": [
          "Recurring sales invoices"
        ],
        "security": [
          {
            "bearerAuth": [
              "sales_invoices"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/administration_id"
          },
          {
            "name": "id",
            "in": "path",
            "required": true,
            "schema": {
              "$ref": "#/components/schemas/identifier"
            }
          },
          {
            "$ref": "#/components/parameters/format"
          }
        ],
        "responses": {
          "200": {
            "description": "A recurring sales invoice",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/recurring_sales_invoice_response"
                },
                "examples": {
                  "ReturnsInvoiceByGivenId": {
                    "summary": "Returns invoice by given id",
                    "value": {
                      "id": "502689211366769670",
                      "administration_id": 123,
                      "contact_id": "502689211348943876",
                      "contact": {
                        "id": "502689211348943876",
                        "administration_id": 123,
                        "company_name": "Foobar Holding B.V.",
                        "firstname": null,
                        "lastname": null,
                        "address1": "Hoofdstraat 12",
                        "address2": null,
                        "zipcode": "1234AB",
                        "city": "Amsterdam",
                        "country": "NL",
                        "phone": null,
                        "delivery_method": "Email",
                        "customer_id": "customer-1",
                        "tax_number": null,
                        "chamber_of_commerce": null,
                        "bank_account": null,
                        "is_trusted": false,
                        "max_transfer_amount": null,
                        "attention": null,
                        "email": "info@example.com",
                        "email_ubl": true,
                        "send_invoices_to_attention": null,
                        "send_invoices_to_email": "info@example.com",
                        "send_estimates_to_attention": null,
                        "send_estimates_to_email": "info@example.com",
                        "direct_debit": false,
                        "sepa_active": false,
                        "sepa_iban": null,
                        "sepa_iban_account_name": null,
                        "sepa_bic": null,
                        "sepa_mandate_id": null,
                        "sepa_mandate_date": null,
                        "sepa_sequence_type": "RCUR",
                        "credit_card_number": null,
                        "credit_card_reference": null,
                        "credit_card_type": null,
                        "tax_number_validated_at": null,
                        "tax_number_valid": null,
                        "invoice_workflow_id": null,
                        "estimate_workflow_id": null,
                        "si_identifier": null,
                        "si_identifier_type": null,
                        "moneybird_payments_mandate": false,
                        "created_at": "2026-11-02T12:16:51.718Z",
                        "updated_at": "2026-11-02T12:16:51.718Z",
                        "version": 1793621811,
                        "sales_invoices_url": "https://moneybird.dev/123/sales_invoices/0000000000000000000000000000000000000000000000000000000000000001/all",
                        "notes": [],
                        "custom_fields": [],
                        "contact_people": [],
                        "archived": false
                      },
                      "contact_person_id": null,
                      "contact_person": null,
                      "workflow_id": "502689109097055375",
                      "start_date": "2026-11-03",
                      "invoice_date": "2026-11-03",
                      "last_date": "2026-11-03",
                      "active": true,
                      "payment_conditions": "We verzoeken u vriendelijk het bovenstaande bedrag van {document.total_price} voor {document.due_date} te voldoen op onze bankrekening onder vermelding van de omschrijving {document.payment_reference}. Voor vragen kunt u contact opnemen per e-mail.",
                      "reference": "Project X",
                      "language": "nl",
                      "currency": "EUR",
                      "discount": "0.0",
                      "first_due_interval": 14,
                      "auto_send": false,
                      "sending_scheduled_at": null,
                      "sending_scheduled_user_id": null,
                      "frequency_type": "month",
                      "frequency": 1,
                      "created_at": "2026-11-02T12:16:51.736Z",
                      "updated_at": "2026-11-02T12:16:51.738Z",
                      "version": 1793621811,
                      "prices_are_incl_tax": false,
                      "total_price_excl_tax": "2.91",
                      "total_price_excl_tax_base": "2.91",
                      "total_price_incl_tax": "3.52",
                      "total_price_incl_tax_base": "3.52",
                      "details": [
                        {
                          "id": "502689211367818247",
                          "administration_id": 123,
                          "tax_rate_id": "502689108899923082",
                          "ledger_account_id": "502689108787725434",
                          "project_id": null,
                          "product_id": null,
                          "amount": "5 stuks",
                          "amount_decimal": "5.0",
                          "description": "Appels",
                          "price": "0.45",
                          "period": null,
                          "row_order": 1,
                          "total_price_excl_tax_with_discount": "2.25",
                          "total_price_excl_tax_with_discount_base": "2.25",
                          "tax_report_reference": [
                            "NL/1a"
                          ],
                          "mandatory_tax_text": null,
                          "created_at": "2026-11-02T12:16:51.737Z",
                          "updated_at": "2026-11-02T12:16:51.737Z"
                        },
                        {
                          "id": "502689211368866824",
                          "administration_id": 123,
                          "tax_rate_id": "502689108899923082",
                          "ledger_account_id": "502689108787725434",
                          "project_id": null,
                          "product_id": null,
                          "amount": "2 stuks",
                          "amount_decimal": "2.0",
                          "description": "Peren",
                          "price": "0.33",
                          "period": null,
                          "row_order": 2,
                          "total_price_excl_tax_with_discount": "0.66",
                          "total_price_excl_tax_with_discount_base": "0.66",
                          "tax_report_reference": [
                            "NL/1a"
                          ],
                          "mandatory_tax_text": null,
                          "created_at": "2026-11-02T12:16:51.738Z",
                          "updated_at": "2026-11-02T12:16:51.738Z"
                        }
                      ],
                      "custom_fields": [],
                      "notes": [],
                      "attachments": [],
                      "events": [
                        {
                          "administration_id": 123,
                          "user_id": "502689108256097381",
                          "action": "recurring_sales_invoice_created",
                          "link_entity_id": null,
                          "link_entity_type": null,
                          "data": {},
                          "created_at": "2026-11-02T12:16:51.739Z",
                          "updated_at": "2026-11-02T12:16:51.739Z"
                        }
                      ],
                      "subscription": null
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Not found",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/symbolic_error"
                },
                "examples": {
                  "Returns404WhenInvoiceDoesNotExist": {
                    "summary": "Returns 404 when invoice does not exist",
                    "value": {
                      "error": "record not found",
                      "symbolic": {
                        "id": "not_found"
                      }
                    }
                  }
                }
              }
            }
          }
        },
        "operationId": "get_administration_id_recurring_sales_invoices_id"
      },
      "patch": {
        "summary": "Updates a recurring sales invoice",
        "description": "Updates a recurring sales invoice. Only possible if the recurring sales invoice has no active subscription.\n\n### Required scope(s)\n `sales_invoices`",
        "tags": [
          "Recurring sales invoices"
        ],
        "security": [
          {
            "bearerAuth": [
              "sales_invoices"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/administration_id"
          },
          {
            "name": "id",
            "in": "path",
            "required": true,
            "schema": {
              "$ref": "#/components/schemas/identifier"
            }
          },
          {
            "$ref": "#/components/parameters/format"
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/*": {
              "schema": {
                "unevaluatedProperties": false,
                "type": "object",
                "properties": {
                  "recurring_sales_invoice": {
                    "type": "object",
                    "unevaluatedProperties": false,
                    "properties": {
                      "document_style_id": {
                        "$ref": "#/components/schemas/identifier",
                        "description": "Should be a valid document style id."
                      },
                      "contact_id": {
                        "$ref": "#/components/schemas/identifier",
                        "description": "Should be a valid contact id."
                      },
                      "contact_person_id": {
                        "$ref": "#/components/schemas/identifier_nullable",
                        "description": "Should be a valid contact person id."
                      },
                      "update_contact": {
                        "type": [
                          "boolean",
                          "string"
                        ],
                        "description": "When `true`, the contact's address and other details are refreshed from the current contact record each time a new invoice is generated."
                      },
                      "reference": {
                        "type": "string",
                        "description": "A reference to include on each generated invoice, e.g. a contract or project code."
                      },
                      "invoice_date": {
                        "type": "string",
                        "description": "Should be in the future."
                      },
                      "workflow_id": {
                        "$ref": "#/components/schemas/identifier",
                        "description": "Should be a valid workflow id."
                      },
                      "currency": {
                        "type": "string",
                        "description": "ISO three-character currency code, e.g. EUR or USD."
                      },
                      "first_due_interval": {
                        "type": "integer",
                        "description": "The number of days after the invoice date before each generated invoice is due."
                      },
                      "prices_are_incl_tax": {
                        "type": [
                          "boolean",
                          "string"
                        ],
                        "description": "Whether the prices on generated invoices are inclusive of tax."
                      },
                      "discount": {
                        "$ref": "#/components/schemas/number",
                        "description": "Discount percentage, e.g. 10,0%."
                      },
                      "frequency_type": {
                        "type": "string",
                        "description": "Can be `day`, `week`, `month`, `quarter` or `year`."
                      },
                      "frequency": {
                        "type": "string",
                        "description": "The interval multiplier. Combined with `frequency_type` to determine the billing cycle."
                      },
                      "has_desired_count": {
                        "type": [
                          "boolean",
                          "string"
                        ],
                        "description": "When `true`, the recurring invoice stops after `desired_count` invoices have been created."
                      },
                      "desired_count": {
                        "type": "string",
                        "description": "The maximum number of invoices to generate. Only applied when `has_desired_count` is `true`."
                      },
                      "auto_send": {
                        "type": [
                          "boolean",
                          "string"
                        ],
                        "description": "When `true`, each generated invoice is automatically sent to the contact."
                      },
                      "mergeable": {
                        "type": [
                          "boolean",
                          "string"
                        ],
                        "description": "When `true`, generated invoices may be merged with other mergeable invoices for the same contact, if they share the same workflow, layout, currency, language and other invoice settings."
                      },
                      "details_attributes": {
                        "$ref": "#/components/schemas/details_attributes"
                      },
                      "custom_fields_attributes": {
                        "$ref": "#/components/schemas/custom_fields_attributes"
                      }
                    },
                    "required": []
                  }
                },
                "required": []
              },
              "examples": {
                "UpdatesARecurringSalesInvoiceDetail": {
                  "summary": "Updates a recurring sales invoice detail",
                  "value": {
                    "recurring_sales_invoice": {
                      "details_attributes": {
                        "0": {
                          "id": 502689212012692540,
                          "price": 10
                        }
                      }
                    }
                  }
                },
                "UpdatesTheRecurringSalesInvoice": {
                  "summary": "Updates the recurring sales invoice",
                  "value": {
                    "recurring_sales_invoice": {
                      "reference": "Reference changed"
                    }
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Recurring sales invoice updated",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/recurring_sales_invoice_response"
                },
                "examples": {
                  "UpdatesARecurringSalesInvoiceDetail": {
                    "summary": "Updates a recurring sales invoice detail",
                    "value": {
                      "id": "502689212011643985",
                      "administration_id": 123,
                      "contact_id": "502689211985429583",
                      "contact": {
                        "id": "502689211985429583",
                        "administration_id": 123,
                        "company_name": "Foobar Holding B.V.",
                        "firstname": null,
                        "lastname": null,
                        "address1": "Hoofdstraat 12",
                        "address2": null,
                        "zipcode": "1234AB",
                        "city": "Amsterdam",
                        "country": "NL",
                        "phone": null,
                        "delivery_method": "Email",
                        "customer_id": "customer-1",
                        "tax_number": null,
                        "chamber_of_commerce": null,
                        "bank_account": null,
                        "is_trusted": false,
                        "max_transfer_amount": null,
                        "attention": null,
                        "email": "info@example.com",
                        "email_ubl": true,
                        "send_invoices_to_attention": null,
                        "send_invoices_to_email": "info@example.com",
                        "send_estimates_to_attention": null,
                        "send_estimates_to_email": "info@example.com",
                        "direct_debit": false,
                        "sepa_active": false,
                        "sepa_iban": null,
                        "sepa_iban_account_name": null,
                        "sepa_bic": null,
                        "sepa_mandate_id": null,
                        "sepa_mandate_date": null,
                        "sepa_sequence_type": "RCUR",
                        "credit_card_number": null,
                        "credit_card_reference": null,
                        "credit_card_type": null,
                        "tax_number_validated_at": null,
                        "tax_number_valid": null,
                        "invoice_workflow_id": null,
                        "estimate_workflow_id": null,
                        "si_identifier": null,
                        "si_identifier_type": null,
                        "moneybird_payments_mandate": false,
                        "created_at": "2026-11-02T12:16:52.324Z",
                        "updated_at": "2026-11-02T12:16:52.324Z",
                        "version": 1793621812,
                        "sales_invoices_url": "https://moneybird.dev/123/sales_invoices/0000000000000000000000000000000000000000000000000000000000000001/all",
                        "notes": [],
                        "custom_fields": [],
                        "contact_people": [],
                        "archived": false
                      },
                      "contact_person_id": null,
                      "contact_person": null,
                      "workflow_id": "502689109097055375",
                      "start_date": "2026-11-03",
                      "invoice_date": "2026-11-03",
                      "last_date": "2026-11-03",
                      "active": true,
                      "payment_conditions": "We verzoeken u vriendelijk het bovenstaande bedrag van {document.total_price} voor {document.due_date} te voldoen op onze bankrekening onder vermelding van de omschrijving {document.payment_reference}. Voor vragen kunt u contact opnemen per e-mail.",
                      "reference": "Project X",
                      "language": "nl",
                      "currency": "EUR",
                      "discount": "0.0",
                      "first_due_interval": 14,
                      "auto_send": false,
                      "sending_scheduled_at": null,
                      "sending_scheduled_user_id": null,
                      "frequency_type": "month",
                      "frequency": 1,
                      "created_at": "2026-11-02T12:16:52.350Z",
                      "updated_at": "2026-11-02T12:16:52.372Z",
                      "version": 1793621812,
                      "prices_are_incl_tax": false,
                      "total_price_excl_tax": "50.66",
                      "total_price_excl_tax_base": "50.66",
                      "total_price_incl_tax": "61.3",
                      "total_price_incl_tax_base": "61.3",
                      "details": [
                        {
                          "id": "502689212012692562",
                          "administration_id": 123,
                          "tax_rate_id": "502689108899923082",
                          "ledger_account_id": "502689108787725434",
                          "project_id": null,
                          "product_id": null,
                          "amount": "5 stuks",
                          "amount_decimal": "5.0",
                          "description": "Appels",
                          "price": "10.0",
                          "period": null,
                          "row_order": 1,
                          "total_price_excl_tax_with_discount": "50.0",
                          "total_price_excl_tax_with_discount_base": "50.0",
                          "tax_report_reference": [
                            "NL/1a"
                          ],
                          "mandatory_tax_text": null,
                          "created_at": "2026-11-02T12:16:52.352Z",
                          "updated_at": "2026-11-02T12:16:52.371Z"
                        },
                        {
                          "id": "502689212013741139",
                          "administration_id": 123,
                          "tax_rate_id": "502689108899923082",
                          "ledger_account_id": "502689108787725434",
                          "project_id": null,
                          "product_id": null,
                          "amount": "2 stuks",
                          "amount_decimal": "2.0",
                          "description": "Peren",
                          "price": "0.33",
                          "period": null,
                          "row_order": 2,
                          "total_price_excl_tax_with_discount": "0.66",
                          "total_price_excl_tax_with_discount_base": "0.66",
                          "tax_report_reference": [
                            "NL/1a"
                          ],
                          "mandatory_tax_text": null,
                          "created_at": "2026-11-02T12:16:52.353Z",
                          "updated_at": "2026-11-02T12:16:52.353Z"
                        }
                      ],
                      "custom_fields": [],
                      "notes": [],
                      "attachments": [],
                      "events": [
                        {
                          "administration_id": 123,
                          "user_id": "502689108256097381",
                          "action": "recurring_sales_invoice_created",
                          "link_entity_id": null,
                          "link_entity_type": null,
                          "data": {},
                          "created_at": "2026-11-02T12:16:52.355Z",
                          "updated_at": "2026-11-02T12:16:52.355Z"
                        }
                      ],
                      "subscription": null
                    }
                  },
                  "UpdatesTheRecurringSalesInvoice": {
                    "summary": "Updates the recurring sales invoice",
                    "value": {
                      "id": "502689212086092888",
                      "administration_id": 123,
                      "contact_id": "502689212061975638",
                      "contact": {
                        "id": "502689212061975638",
                        "administration_id": 123,
                        "company_name": "Foobar Holding B.V.",
                        "firstname": null,
                        "lastname": null,
                        "address1": "Hoofdstraat 12",
                        "address2": null,
                        "zipcode": "1234AB",
                        "city": "Amsterdam",
                        "country": "NL",
                        "phone": null,
                        "delivery_method": "Email",
                        "customer_id": "customer-1",
                        "tax_number": null,
                        "chamber_of_commerce": null,
                        "bank_account": null,
                        "is_trusted": false,
                        "max_transfer_amount": null,
                        "attention": null,
                        "email": "info@example.com",
                        "email_ubl": true,
                        "send_invoices_to_attention": null,
                        "send_invoices_to_email": "info@example.com",
                        "send_estimates_to_attention": null,
                        "send_estimates_to_email": "info@example.com",
                        "direct_debit": false,
                        "sepa_active": false,
                        "sepa_iban": null,
                        "sepa_iban_account_name": null,
                        "sepa_bic": null,
                        "sepa_mandate_id": null,
                        "sepa_mandate_date": null,
                        "sepa_sequence_type": "RCUR",
                        "credit_card_number": null,
                        "credit_card_reference": null,
                        "credit_card_type": null,
                        "tax_number_validated_at": null,
                        "tax_number_valid": null,
                        "invoice_workflow_id": null,
                        "estimate_workflow_id": null,
                        "si_identifier": null,
                        "si_identifier_type": null,
                        "moneybird_payments_mandate": false,
                        "created_at": "2026-11-02T12:16:52.398Z",
                        "updated_at": "2026-11-02T12:16:52.398Z",
                        "version": 1793621812,
                        "sales_invoices_url": "https://moneybird.dev/123/sales_invoices/0000000000000000000000000000000000000000000000000000000000000001/all",
                        "notes": [],
                        "custom_fields": [],
                        "contact_people": [],
                        "archived": false
                      },
                      "contact_person_id": null,
                      "contact_person": null,
                      "workflow_id": "502689109097055375",
                      "start_date": "2026-11-03",
                      "invoice_date": "2026-11-03",
                      "last_date": "2026-11-03",
                      "active": true,
                      "payment_conditions": "We verzoeken u vriendelijk het bovenstaande bedrag van {document.total_price} voor {document.due_date} te voldoen op onze bankrekening onder vermelding van de omschrijving {document.payment_reference}. Voor vragen kunt u contact opnemen per e-mail.",
                      "reference": "Reference changed",
                      "language": "nl",
                      "currency": "EUR",
                      "discount": "0.0",
                      "first_due_interval": 14,
                      "auto_send": false,
                      "sending_scheduled_at": null,
                      "sending_scheduled_user_id": null,
                      "frequency_type": "month",
                      "frequency": 1,
                      "created_at": "2026-11-02T12:16:52.421Z",
                      "updated_at": "2026-11-02T12:16:52.446Z",
                      "version": 1793621812,
                      "prices_are_incl_tax": false,
                      "total_price_excl_tax": "2.91",
                      "total_price_excl_tax_base": "2.91",
                      "total_price_incl_tax": "3.52",
                      "total_price_incl_tax_base": "3.52",
                      "details": [
                        {
                          "id": "502689212087141465",
                          "administration_id": 123,
                          "tax_rate_id": "502689108899923082",
                          "ledger_account_id": "502689108787725434",
                          "project_id": null,
                          "product_id": null,
                          "amount": "5 stuks",
                          "amount_decimal": "5.0",
                          "description": "Appels",
                          "price": "0.45",
                          "period": null,
                          "row_order": 1,
                          "total_price_excl_tax_with_discount": "2.25",
                          "total_price_excl_tax_with_discount_base": "2.25",
                          "tax_report_reference": [
                            "NL/1a"
                          ],
                          "mandatory_tax_text": null,
                          "created_at": "2026-11-02T12:16:52.423Z",
                          "updated_at": "2026-11-02T12:16:52.423Z"
                        },
                        {
                          "id": "502689212089238618",
                          "administration_id": 123,
                          "tax_rate_id": "502689108899923082",
                          "ledger_account_id": "502689108787725434",
                          "project_id": null,
                          "product_id": null,
                          "amount": "2 stuks",
                          "amount_decimal": "2.0",
                          "description": "Peren",
                          "price": "0.33",
                          "period": null,
                          "row_order": 2,
                          "total_price_excl_tax_with_discount": "0.66",
                          "total_price_excl_tax_with_discount_base": "0.66",
                          "tax_report_reference": [
                            "NL/1a"
                          ],
                          "mandatory_tax_text": null,
                          "created_at": "2026-11-02T12:16:52.424Z",
                          "updated_at": "2026-11-02T12:16:52.424Z"
                        }
                      ],
                      "custom_fields": [],
                      "notes": [],
                      "attachments": [],
                      "events": [
                        {
                          "administration_id": 123,
                          "user_id": "502689108256097381",
                          "action": "recurring_sales_invoice_created",
                          "link_entity_id": null,
                          "link_entity_type": null,
                          "data": {},
                          "created_at": "2026-11-02T12:16:52.428Z",
                          "updated_at": "2026-11-02T12:16:52.428Z"
                        }
                      ],
                      "subscription": null
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "Bad request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/symbolic_error"
                },
                "examples": {
                  "Returns400WhenRecurringSalesInvoiceCannotBeEditedDueToActiveSubscription": {
                    "summary": "Returns 400 when recurring sales invoice cannot be edited due to active subscription",
                    "value": {
                      "error": "cannot be updated",
                      "symbolic": {
                        "id": "cannot_be_updated"
                      }
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Not found",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/symbolic_error"
                },
                "examples": {
                  "Returns404WhenRecurringSalesInvoiceDoesNotExist": {
                    "summary": "Returns 404 when recurring sales invoice does not exist",
                    "value": {
                      "error": "record not found",
                      "symbolic": {
                        "id": "not_found"
                      }
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "Unprocessable entity",
            "content": {
              "application/json": {
                "schema": {
                  "anyOf": [
                    {
                      "$ref": "#/components/schemas/symbolic_error"
                    },
                    {
                      "$ref": "#/components/schemas/non_symbolic_error"
                    }
                  ]
                },
                "examples": {
                  "Returns422WhenValidationFails": {
                    "summary": "Returns 422 when validation fails",
                    "value": {
                      "error": {
                        "invoice_date": [
                          "must be further in the future"
                        ]
                      },
                      "details": {
                        "invoice_date": [
                          {
                            "error": "too_early"
                          }
                        ]
                      }
                    }
                  }
                }
              }
            }
          }
        },
        "operationId": "patch_administration_id_recurring_sales_invoices_id"
      },
      "delete": {
        "summary": "Destroy or deactivate a recurring sales invoice",
        "description": "A recurring sales invoice will be destroyed if it has not created any sales invoices. If it has created sales\ninvoices, it will be deactivated. Returns a 422 when the recurring sales invoice belongs to an active\nsubscription, or has created sales invoices and is already deactivated.\n\n### Required scope(s)\n `sales_invoices`",
        "tags": [
          "Recurring sales invoices"
        ],
        "security": [
          {
            "bearerAuth": [
              "sales_invoices"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/administration_id"
          },
          {
            "name": "id",
            "in": "path",
            "required": true,
            "schema": {
              "$ref": "#/components/schemas/identifier"
            }
          },
          {
            "$ref": "#/components/parameters/format"
          }
        ],
        "responses": {
          "204": {
            "description": "Recurring sales invoice deleted"
          },
          "404": {
            "description": "Not found",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/symbolic_error"
                },
                "examples": {
                  "Returns404WhenRecurringSalesInvoiceDoesNotExist": {
                    "summary": "Returns 404 when recurring sales invoice does not exist",
                    "value": {
                      "error": "record not found",
                      "symbolic": {
                        "id": "not_found"
                      }
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "Unprocessable entity",
            "content": {
              "application/json": {
                "schema": {
                  "anyOf": [
                    {
                      "$ref": "#/components/schemas/symbolic_error"
                    },
                    {
                      "$ref": "#/components/schemas/non_symbolic_error"
                    }
                  ]
                },
                "examples": {
                  "Returns422WhenTheRecurringSalesInvoiceBelongsToAnActiveSubscription": {
                    "summary": "Returns 422 when the recurring sales invoice belongs to an active subscription",
                    "value": {
                      "error": "Recurring sales invoice cannot be destroyed or deactivated",
                      "symbolic": {
                        "id": "cannot_destroy_or_deactivate"
                      }
                    }
                  }
                }
              }
            }
          }
        },
        "operationId": "delete_administration_id_recurring_sales_invoices_id"
      }
    },
    "/{administration_id}/recurring_sales_invoices/{recurring_sales_invoice_id}/notes/{id}{format}": {
      "delete": {
        "summary": "Destroys note from entity",
        "description": "Deletes a note from the recurring sales invoice.\n\n### Required scope(s)\n `sales_invoices`",
        "tags": [
          "Recurring sales invoices"
        ],
        "security": [
          {
            "bearerAuth": [
              "sales_invoices"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/administration_id"
          },
          {
            "name": "recurring_sales_invoice_id",
            "in": "path",
            "required": true,
            "schema": {
              "$ref": "#/components/schemas/identifier"
            }
          },
          {
            "name": "id",
            "in": "path",
            "required": true,
            "schema": {
              "$ref": "#/components/schemas/identifier"
            }
          },
          {
            "$ref": "#/components/parameters/format"
          }
        ],
        "responses": {
          "204": {
            "description": "Note deleted"
          },
          "404": {
            "description": "Not found",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/symbolic_error"
                },
                "examples": {
                  "Returns404IfTheIdIsWrong": {
                    "summary": "Returns 404 if the id is wrong",
                    "value": {
                      "error": "record not found",
                      "symbolic": {
                        "id": "not_found"
                      }
                    }
                  }
                }
              }
            }
          }
        },
        "operationId": "delete_administration_id_recurring_sales_invoices_recurring_sales_invoice_id_notes_id"
      }
    },
    "/{administration_id}/recurring_sales_invoices/{recurring_sales_invoice_id}/notes{format}": {
      "post": {
        "summary": "Adds note to entity",
        "description": "Adds a note to the recurring sales invoice.\n\n### Required scope(s)\n `sales_invoices`",
        "tags": [
          "Recurring sales invoices"
        ],
        "security": [
          {
            "bearerAuth": [
              "sales_invoices"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/administration_id"
          },
          {
            "name": "recurring_sales_invoice_id",
            "in": "path",
            "required": true,
            "schema": {
              "$ref": "#/components/schemas/identifier"
            }
          },
          {
            "$ref": "#/components/parameters/format"
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/*": {
              "schema": {
                "unevaluatedProperties": false,
                "type": "object",
                "properties": {
                  "note": {
                    "type": "object",
                    "unevaluatedProperties": false,
                    "properties": {
                      "note": {
                        "type": "string",
                        "description": "**Required**. Text for the note or to-do."
                      },
                      "todo": {
                        "type": [
                          "boolean",
                          "string"
                        ],
                        "description": "If `true` the note is a to-do."
                      },
                      "assignee_id": {
                        "$ref": "#/components/schemas/identifier",
                        "description": "Assign to-do to user. Should be a valid user id. If assignee_id is provided the note will be a to-do."
                      }
                    },
                    "required": []
                  }
                },
                "required": []
              },
              "examples": {
                "CreateANote": {
                  "summary": "Create a note",
                  "value": {
                    "note": {
                      "note": "Text of the note",
                      "assignee_id": 502689211131889600,
                      "todo": true
                    }
                  }
                }
              }
            }
          }
        },
        "responses": {
          "201": {
            "description": "Note created",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/note_response"
                },
                "examples": {
                  "CreateANote": {
                    "summary": "Create a note",
                    "value": {
                      "id": "502689211142375393",
                      "administration_id": 123,
                      "entity_id": "502689211121403867",
                      "entity_type": "RecurringSalesInvoice",
                      "user_id": "502689108256097381",
                      "assignee_id": "502689211131889631",
                      "todo": true,
                      "note": "Text of the note",
                      "completed_at": null,
                      "completed_by_id": null,
                      "todo_type": null,
                      "data": {},
                      "created_at": "2026-11-02T12:16:51.522Z",
                      "updated_at": "2026-11-02T12:16:51.522Z"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "Bad request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/symbolic_error"
                },
                "examples": {
                  "Returns400WhenRecurringSalesInvoiceDoesNotExist": {
                    "summary": "Returns 400 when recurring sales invoice does not exist",
                    "value": {
                      "error": "Entity is invalid; User has no permissions to notes for RecurringSalesInvoice",
                      "symbolic": {
                        "entity": "not_found",
                        "user": "insufficient_permissions"
                      }
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "Unprocessable entity",
            "content": {
              "application/json": {
                "schema": {
                  "anyOf": [
                    {
                      "$ref": "#/components/schemas/symbolic_error"
                    },
                    {
                      "$ref": "#/components/schemas/non_symbolic_error"
                    }
                  ]
                },
                "examples": {
                  "Returns422WhenValidationFails": {
                    "summary": "Returns 422 when validation fails",
                    "value": {
                      "error": {
                        "note": [
                          "can't be blank"
                        ],
                        "todo_type": [
                          "can't be blank"
                        ]
                      },
                      "details": {
                        "note": [
                          {
                            "error": "blank"
                          }
                        ],
                        "todo_type": [
                          {
                            "error": "blank"
                          }
                        ]
                      }
                    }
                  }
                }
              }
            }
          }
        },
        "operationId": "post_administration_id_recurring_sales_invoices_recurring_sales_invoice_id_notes"
      }
    },
    "/{administration_id}/recurring_sales_invoices{format}": {
      "get": {
        "summary": "List all recurring sales invoices",
        "description": "Returns a paginated list of recurring sales invoices in the administration.\n\n### Required scope(s)\n `sales_invoices`",
        "tags": [
          "Recurring sales invoices"
        ],
        "security": [
          {
            "bearerAuth": [
              "sales_invoices"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/administration_id"
          },
          {
            "$ref": "#/components/parameters/format"
          },
          {
            "name": "filter",
            "in": "query",
            "required": false,
            "description": "Filters are `key:value` terms separated by commas (e.g. `state:active,contact_id:123`). A filter key you leave out keeps its default below. Available filters:\n\n| **Filter** | **Type** | **Default** | **Description** |\n| --- | --- | --- | --- |\n| state | `String` | `active` | `active` or `inactive` |\n| frequency | `String` | `all` | `all`, `day`, `week`, `month`, `quarter` or `year` |\n| auto_send | `Boolean` | `null` | `null`, `true` or `false` |\n| contact_id | `Integer` | | Filters recurring invoices by a single contact |\n| workflow_id | `Integer` | | Filters recurring invoices by a single workflow |\n| include_subscriptions | `Boolean` | `false` | Use `true` to include the recurring sales invoices that belong to a subscription |",
            "schema": {
              "type": "string",
              "default": "state:active"
            },
            "examples": {
              "ReturnsRecurringInvoicesFilteredOnContact": {
                "summary": "Returns recurring invoices filtered on contact",
                "value": "contact_id:502689210764887973"
              },
              "ReturnsRecurringInvoicesFilteredOnFrequency": {
                "summary": "Returns recurring invoices filtered on frequency",
                "value": "frequency:month"
              }
            }
          },
          {
            "$ref": "#/components/parameters/page"
          },
          {
            "$ref": "#/components/parameters/per_page"
          }
        ],
        "responses": {
          "200": {
            "description": "A list of recurring sales invoices",
            "content": {
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "$ref": "#/components/schemas/recurring_sales_invoice_response"
                  }
                },
                "examples": {
                  "ReturnsAllRecurringSalesInvoicesOfAnAdministration": {
                    "summary": "Returns all recurring sales invoices of an administration",
                    "value": [
                      {
                        "id": "502689210248988513",
                        "administration_id": 123,
                        "contact_id": "502689210185025368",
                        "contact": {
                          "id": "502689210185025368",
                          "administration_id": 123,
                          "company_name": "Foobar Holding B.V.",
                          "firstname": null,
                          "lastname": null,
                          "address1": "Hoofdstraat 12",
                          "address2": null,
                          "zipcode": "1234AB",
                          "city": "Amsterdam",
                          "country": "NL",
                          "phone": null,
                          "delivery_method": "Email",
                          "customer_id": "customer-2",
                          "tax_number": null,
                          "chamber_of_commerce": null,
                          "bank_account": null,
                          "is_trusted": false,
                          "max_transfer_amount": null,
                          "attention": null,
                          "email": "info@example.com",
                          "email_ubl": true,
                          "send_invoices_to_attention": null,
                          "send_invoices_to_email": "info@example.com",
                          "send_estimates_to_attention": null,
                          "send_estimates_to_email": "info@example.com",
                          "direct_debit": false,
                          "sepa_active": false,
                          "sepa_iban": null,
                          "sepa_iban_account_name": null,
                          "sepa_bic": null,
                          "sepa_mandate_id": null,
                          "sepa_mandate_date": null,
                          "sepa_sequence_type": "RCUR",
                          "credit_card_number": null,
                          "credit_card_reference": null,
                          "credit_card_type": null,
                          "tax_number_validated_at": null,
                          "tax_number_valid": null,
                          "invoice_workflow_id": null,
                          "estimate_workflow_id": null,
                          "si_identifier": null,
                          "si_identifier_type": null,
                          "moneybird_payments_mandate": false,
                          "created_at": "2026-11-02T12:16:50.609Z",
                          "updated_at": "2026-11-02T12:16:50.609Z",
                          "version": 1793621810,
                          "sales_invoices_url": "https://moneybird.dev/123/sales_invoices/0000000000000000000000000000000000000000000000000000000000000002/all",
                          "notes": [],
                          "custom_fields": [],
                          "contact_people": [],
                          "archived": false
                        },
                        "contact_person_id": null,
                        "contact_person": null,
                        "workflow_id": "502689109097055375",
                        "start_date": "2026-11-03",
                        "invoice_date": "2026-11-03",
                        "last_date": "2026-11-03",
                        "active": true,
                        "payment_conditions": "We verzoeken u vriendelijk het bovenstaande bedrag van {document.total_price} voor {document.due_date} te voldoen op onze bankrekening onder vermelding van de omschrijving {document.payment_reference}. Voor vragen kunt u contact opnemen per e-mail.",
                        "reference": "Project X",
                        "language": "nl",
                        "currency": "EUR",
                        "discount": "0.0",
                        "first_due_interval": 14,
                        "auto_send": false,
                        "sending_scheduled_at": null,
                        "sending_scheduled_user_id": null,
                        "frequency_type": "year",
                        "frequency": 1,
                        "created_at": "2026-11-02T12:16:50.669Z",
                        "updated_at": "2026-11-02T12:16:50.673Z",
                        "version": 1793621810,
                        "prices_are_incl_tax": false,
                        "total_price_excl_tax": "2.91",
                        "total_price_excl_tax_base": "2.91",
                        "total_price_incl_tax": "3.52",
                        "total_price_incl_tax_base": "3.52",
                        "details": [
                          {
                            "id": "502689210250037090",
                            "administration_id": 123,
                            "tax_rate_id": "502689108899923082",
                            "ledger_account_id": "502689108787725434",
                            "project_id": null,
                            "product_id": null,
                            "amount": "5 stuks",
                            "amount_decimal": "5.0",
                            "description": "Appels",
                            "price": "0.45",
                            "period": null,
                            "row_order": 1,
                            "total_price_excl_tax_with_discount": "2.25",
                            "total_price_excl_tax_with_discount_base": "2.25",
                            "tax_report_reference": [
                              "NL/1a"
                            ],
                            "mandatory_tax_text": null,
                            "created_at": "2026-11-02T12:16:50.671Z",
                            "updated_at": "2026-11-02T12:16:50.671Z"
                          },
                          {
                            "id": "502689210252134243",
                            "administration_id": 123,
                            "tax_rate_id": "502689108899923082",
                            "ledger_account_id": "502689108787725434",
                            "project_id": null,
                            "product_id": null,
                            "amount": "2 stuks",
                            "amount_decimal": "2.0",
                            "description": "Peren",
                            "price": "0.33",
                            "period": null,
                            "row_order": 2,
                            "total_price_excl_tax_with_discount": "0.66",
                            "total_price_excl_tax_with_discount_base": "0.66",
                            "tax_report_reference": [
                              "NL/1a"
                            ],
                            "mandatory_tax_text": null,
                            "created_at": "2026-11-02T12:16:50.672Z",
                            "updated_at": "2026-11-02T12:16:50.672Z"
                          }
                        ],
                        "custom_fields": [],
                        "notes": [],
                        "attachments": [],
                        "events": [
                          {
                            "administration_id": 123,
                            "user_id": "502689108256097381",
                            "action": "recurring_sales_invoice_created",
                            "link_entity_id": null,
                            "link_entity_type": null,
                            "data": {},
                            "created_at": "2026-11-02T12:16:50.675Z",
                            "updated_at": "2026-11-02T12:16:50.675Z"
                          }
                        ],
                        "subscription": null
                      },
                      {
                        "id": "502689210223822685",
                        "administration_id": 123,
                        "contact_id": "502689210185025368",
                        "contact": {
                          "id": "502689210185025368",
                          "administration_id": 123,
                          "company_name": "Foobar Holding B.V.",
                          "firstname": null,
                          "lastname": null,
                          "address1": "Hoofdstraat 12",
                          "address2": null,
                          "zipcode": "1234AB",
                          "city": "Amsterdam",
                          "country": "NL",
                          "phone": null,
                          "delivery_method": "Email",
                          "customer_id": "customer-2",
                          "tax_number": null,
                          "chamber_of_commerce": null,
                          "bank_account": null,
                          "is_trusted": false,
                          "max_transfer_amount": null,
                          "attention": null,
                          "email": "info@example.com",
                          "email_ubl": true,
                          "send_invoices_to_attention": null,
                          "send_invoices_to_email": "info@example.com",
                          "send_estimates_to_attention": null,
                          "send_estimates_to_email": "info@example.com",
                          "direct_debit": false,
                          "sepa_active": false,
                          "sepa_iban": null,
                          "sepa_iban_account_name": null,
                          "sepa_bic": null,
                          "sepa_mandate_id": null,
                          "sepa_mandate_date": null,
                          "sepa_sequence_type": "RCUR",
                          "credit_card_number": null,
                          "credit_card_reference": null,
                          "credit_card_type": null,
                          "tax_number_validated_at": null,
                          "tax_number_valid": null,
                          "invoice_workflow_id": null,
                          "estimate_workflow_id": null,
                          "si_identifier": null,
                          "si_identifier_type": null,
                          "moneybird_payments_mandate": false,
                          "created_at": "2026-11-02T12:16:50.609Z",
                          "updated_at": "2026-11-02T12:16:50.609Z",
                          "version": 1793621810,
                          "sales_invoices_url": "https://moneybird.dev/123/sales_invoices/0000000000000000000000000000000000000000000000000000000000000002/all",
                          "notes": [],
                          "custom_fields": [],
                          "contact_people": [],
                          "archived": false
                        },
                        "contact_person_id": null,
                        "contact_person": null,
                        "workflow_id": "502689109097055375",
                        "start_date": "2026-11-03",
                        "invoice_date": "2026-11-03",
                        "last_date": "2026-11-03",
                        "active": true,
                        "payment_conditions": "We verzoeken u vriendelijk het bovenstaande bedrag van {document.total_price} voor {document.due_date} te voldoen op onze bankrekening onder vermelding van de omschrijving {document.payment_reference}. Voor vragen kunt u contact opnemen per e-mail.",
                        "reference": "Project X",
                        "language": "nl",
                        "currency": "EUR",
                        "discount": "0.0",
                        "first_due_interval": 14,
                        "auto_send": false,
                        "sending_scheduled_at": null,
                        "sending_scheduled_user_id": null,
                        "frequency_type": "year",
                        "frequency": 1,
                        "created_at": "2026-11-02T12:16:50.646Z",
                        "updated_at": "2026-11-02T12:16:50.649Z",
                        "version": 1793621810,
                        "prices_are_incl_tax": false,
                        "total_price_excl_tax": "2.91",
                        "total_price_excl_tax_base": "2.91",
                        "total_price_incl_tax": "3.52",
                        "total_price_incl_tax_base": "3.52",
                        "details": [
                          {
                            "id": "502689210224871262",
                            "administration_id": 123,
                            "tax_rate_id": "502689108899923082",
                            "ledger_account_id": "502689108787725434",
                            "project_id": null,
                            "product_id": null,
                            "amount": "5 stuks",
                            "amount_decimal": "5.0",
                            "description": "Appels",
                            "price": "0.45",
                            "period": null,
                            "row_order": 1,
                            "total_price_excl_tax_with_discount": "2.25",
                            "total_price_excl_tax_with_discount_base": "2.25",
                            "tax_report_reference": [
                              "NL/1a"
                            ],
                            "mandatory_tax_text": null,
                            "created_at": "2026-11-02T12:16:50.647Z",
                            "updated_at": "2026-11-02T12:16:50.647Z"
                          },
                          {
                            "id": "502689210225919839",
                            "administration_id": 123,
                            "tax_rate_id": "502689108899923082",
                            "ledger_account_id": "502689108787725434",
                            "project_id": null,
                            "product_id": null,
                            "amount": "2 stuks",
                            "amount_decimal": "2.0",
                            "description": "Peren",
                            "price": "0.33",
                            "period": null,
                            "row_order": 2,
                            "total_price_excl_tax_with_discount": "0.66",
                            "total_price_excl_tax_with_discount_base": "0.66",
                            "tax_report_reference": [
                              "NL/1a"
                            ],
                            "mandatory_tax_text": null,
                            "created_at": "2026-11-02T12:16:50.648Z",
                            "updated_at": "2026-11-02T12:16:50.648Z"
                          }
                        ],
                        "custom_fields": [],
                        "notes": [],
                        "attachments": [],
                        "events": [
                          {
                            "administration_id": 123,
                            "user_id": "502689108256097381",
                            "action": "recurring_sales_invoice_created",
                            "link_entity_id": null,
                            "link_entity_type": null,
                            "data": {},
                            "created_at": "2026-11-02T12:16:50.650Z",
                            "updated_at": "2026-11-02T12:16:50.650Z"
                          }
                        ],
                        "subscription": null
                      },
                      {
                        "id": "502689210201802585",
                        "administration_id": 123,
                        "contact_id": "502689210185025368",
                        "contact": {
                          "id": "502689210185025368",
                          "administration_id": 123,
                          "company_name": "Foobar Holding B.V.",
                          "firstname": null,
                          "lastname": null,
                          "address1": "Hoofdstraat 12",
                          "address2": null,
                          "zipcode": "1234AB",
                          "city": "Amsterdam",
                          "country": "NL",
                          "phone": null,
                          "delivery_method": "Email",
                          "customer_id": "customer-2",
                          "tax_number": null,
                          "chamber_of_commerce": null,
                          "bank_account": null,
                          "is_trusted": false,
                          "max_transfer_amount": null,
                          "attention": null,
                          "email": "info@example.com",
                          "email_ubl": true,
                          "send_invoices_to_attention": null,
                          "send_invoices_to_email": "info@example.com",
                          "send_estimates_to_attention": null,
                          "send_estimates_to_email": "info@example.com",
                          "direct_debit": false,
                          "sepa_active": false,
                          "sepa_iban": null,
                          "sepa_iban_account_name": null,
                          "sepa_bic": null,
                          "sepa_mandate_id": null,
                          "sepa_mandate_date": null,
                          "sepa_sequence_type": "RCUR",
                          "credit_card_number": null,
                          "credit_card_reference": null,
                          "credit_card_type": null,
                          "tax_number_validated_at": null,
                          "tax_number_valid": null,
                          "invoice_workflow_id": null,
                          "estimate_workflow_id": null,
                          "si_identifier": null,
                          "si_identifier_type": null,
                          "moneybird_payments_mandate": false,
                          "created_at": "2026-11-02T12:16:50.609Z",
                          "updated_at": "2026-11-02T12:16:50.609Z",
                          "version": 1793621810,
                          "sales_invoices_url": "https://moneybird.dev/123/sales_invoices/0000000000000000000000000000000000000000000000000000000000000002/all",
                          "notes": [],
                          "custom_fields": [],
                          "contact_people": [],
                          "archived": false
                        },
                        "contact_person_id": null,
                        "contact_person": null,
                        "workflow_id": "502689109097055375",
                        "start_date": "2026-11-03",
                        "invoice_date": "2026-11-03",
                        "last_date": "2026-11-03",
                        "active": true,
                        "payment_conditions": "We verzoeken u vriendelijk het bovenstaande bedrag van {document.total_price} voor {document.due_date} te voldoen op onze bankrekening onder vermelding van de omschrijving {document.payment_reference}. Voor vragen kunt u contact opnemen per e-mail.",
                        "reference": "Project X",
                        "language": "nl",
                        "currency": "EUR",
                        "discount": "0.0",
                        "first_due_interval": 14,
                        "auto_send": false,
                        "sending_scheduled_at": null,
                        "sending_scheduled_user_id": null,
                        "frequency_type": "year",
                        "frequency": 1,
                        "created_at": "2026-11-02T12:16:50.624Z",
                        "updated_at": "2026-11-02T12:16:50.628Z",
                        "version": 1793621810,
                        "prices_are_incl_tax": false,
                        "total_price_excl_tax": "2.91",
                        "total_price_excl_tax_base": "2.91",
                        "total_price_incl_tax": "3.52",
                        "total_price_incl_tax_base": "3.52",
                        "details": [
                          {
                            "id": "502689210202851162",
                            "administration_id": 123,
                            "tax_rate_id": "502689108899923082",
                            "ledger_account_id": "502689108787725434",
                            "project_id": null,
                            "product_id": null,
                            "amount": "5 stuks",
                            "amount_decimal": "5.0",
                            "description": "Appels",
                            "price": "0.45",
                            "period": null,
                            "row_order": 1,
                            "total_price_excl_tax_with_discount": "2.25",
                            "total_price_excl_tax_with_discount_base": "2.25",
                            "tax_report_reference": [
                              "NL/1a"
                            ],
                            "mandatory_tax_text": null,
                            "created_at": "2026-11-02T12:16:50.626Z",
                            "updated_at": "2026-11-02T12:16:50.626Z"
                          },
                          {
                            "id": "502689210204948315",
                            "administration_id": 123,
                            "tax_rate_id": "502689108899923082",
                            "ledger_account_id": "502689108787725434",
                            "project_id": null,
                            "product_id": null,
                            "amount": "2 stuks",
                            "amount_decimal": "2.0",
                            "description": "Peren",
                            "price": "0.33",
                            "period": null,
                            "row_order": 2,
                            "total_price_excl_tax_with_discount": "0.66",
                            "total_price_excl_tax_with_discount_base": "0.66",
                            "tax_report_reference": [
                              "NL/1a"
                            ],
                            "mandatory_tax_text": null,
                            "created_at": "2026-11-02T12:16:50.627Z",
                            "updated_at": "2026-11-02T12:16:50.627Z"
                          }
                        ],
                        "custom_fields": [],
                        "notes": [],
                        "attachments": [],
                        "events": [
                          {
                            "administration_id": 123,
                            "user_id": "502689108256097381",
                            "action": "recurring_sales_invoice_created",
                            "link_entity_id": null,
                            "link_entity_type": null,
                            "data": {},
                            "created_at": "2026-11-02T12:16:50.630Z",
                            "updated_at": "2026-11-02T12:16:50.630Z"
                          }
                        ],
                        "subscription": null
                      },
                      {
                        "id": "502689210175588179",
                        "administration_id": 123,
                        "contact_id": "502689210153568081",
                        "contact": {
                          "id": "502689210153568081",
                          "administration_id": 123,
                          "company_name": "Foobar Holding B.V.",
                          "firstname": null,
                          "lastname": null,
                          "address1": "Hoofdstraat 12",
                          "address2": null,
                          "zipcode": "1234AB",
                          "city": "Amsterdam",
                          "country": "NL",
                          "phone": null,
                          "delivery_method": "Email",
                          "customer_id": "customer-1",
                          "tax_number": null,
                          "chamber_of_commerce": null,
                          "bank_account": null,
                          "is_trusted": false,
                          "max_transfer_amount": null,
                          "attention": null,
                          "email": "info@example.com",
                          "email_ubl": true,
                          "send_invoices_to_attention": null,
                          "send_invoices_to_email": "info@example.com",
                          "send_estimates_to_attention": null,
                          "send_estimates_to_email": "info@example.com",
                          "direct_debit": false,
                          "sepa_active": false,
                          "sepa_iban": null,
                          "sepa_iban_account_name": null,
                          "sepa_bic": null,
                          "sepa_mandate_id": null,
                          "sepa_mandate_date": null,
                          "sepa_sequence_type": "RCUR",
                          "credit_card_number": null,
                          "credit_card_reference": null,
                          "credit_card_type": null,
                          "tax_number_validated_at": null,
                          "tax_number_valid": null,
                          "invoice_workflow_id": null,
                          "estimate_workflow_id": null,
                          "si_identifier": null,
                          "si_identifier_type": null,
                          "moneybird_payments_mandate": false,
                          "created_at": "2026-11-02T12:16:50.578Z",
                          "updated_at": "2026-11-02T12:16:50.578Z",
                          "version": 1793621810,
                          "sales_invoices_url": "https://moneybird.dev/123/sales_invoices/0000000000000000000000000000000000000000000000000000000000000001/all",
                          "notes": [],
                          "custom_fields": [],
                          "contact_people": [],
                          "archived": false
                        },
                        "contact_person_id": null,
                        "contact_person": null,
                        "workflow_id": "502689109097055375",
                        "start_date": "2026-11-03",
                        "invoice_date": "2026-11-03",
                        "last_date": "2026-11-03",
                        "active": true,
                        "payment_conditions": "We verzoeken u vriendelijk het bovenstaande bedrag van {document.total_price} voor {document.due_date} te voldoen op onze bankrekening onder vermelding van de omschrijving {document.payment_reference}. Voor vragen kunt u contact opnemen per e-mail.",
                        "reference": "Project X",
                        "language": "nl",
                        "currency": "EUR",
                        "discount": "0.0",
                        "first_due_interval": 14,
                        "auto_send": false,
                        "sending_scheduled_at": null,
                        "sending_scheduled_user_id": null,
                        "frequency_type": "month",
                        "frequency": 1,
                        "created_at": "2026-11-02T12:16:50.599Z",
                        "updated_at": "2026-11-02T12:16:50.602Z",
                        "version": 1793621810,
                        "prices_are_incl_tax": false,
                        "total_price_excl_tax": "2.91",
                        "total_price_excl_tax_base": "2.91",
                        "total_price_incl_tax": "3.52",
                        "total_price_incl_tax_base": "3.52",
                        "details": [
                          {
                            "id": "502689210176636756",
                            "administration_id": 123,
                            "tax_rate_id": "502689108899923082",
                            "ledger_account_id": "502689108787725434",
                            "project_id": null,
                            "product_id": null,
                            "amount": "5 stuks",
                            "amount_decimal": "5.0",
                            "description": "Appels",
                            "price": "0.45",
                            "period": null,
                            "row_order": 1,
                            "total_price_excl_tax_with_discount": "2.25",
                            "total_price_excl_tax_with_discount_base": "2.25",
                            "tax_report_reference": [
                              "NL/1a"
                            ],
                            "mandatory_tax_text": null,
                            "created_at": "2026-11-02T12:16:50.600Z",
                            "updated_at": "2026-11-02T12:16:50.600Z"
                          },
                          {
                            "id": "502689210177685333",
                            "administration_id": 123,
                            "tax_rate_id": "502689108899923082",
                            "ledger_account_id": "502689108787725434",
                            "project_id": null,
                            "product_id": null,
                            "amount": "2 stuks",
                            "amount_decimal": "2.0",
                            "description": "Peren",
                            "price": "0.33",
                            "period": null,
                            "row_order": 2,
                            "total_price_excl_tax_with_discount": "0.66",
                            "total_price_excl_tax_with_discount_base": "0.66",
                            "tax_report_reference": [
                              "NL/1a"
                            ],
                            "mandatory_tax_text": null,
                            "created_at": "2026-11-02T12:16:50.601Z",
                            "updated_at": "2026-11-02T12:16:50.601Z"
                          }
                        ],
                        "custom_fields": [],
                        "notes": [],
                        "attachments": [],
                        "events": [
                          {
                            "administration_id": 123,
                            "user_id": "502689108256097381",
                            "action": "recurring_sales_invoice_created",
                            "link_entity_id": null,
                            "link_entity_type": null,
                            "data": {},
                            "created_at": "2026-11-02T12:16:50.603Z",
                            "updated_at": "2026-11-02T12:16:50.603Z"
                          }
                        ],
                        "subscription": null
                      }
                    ]
                  },
                  "ReturnsPaginatedRecurringSalesInvoicesOnPage1": {
                    "summary": "Returns paginated recurring sales invoices on page 1",
                    "value": [
                      {
                        "id": "502689210544686987",
                        "administration_id": 123,
                        "contact_id": "502689210484918146",
                        "contact": {
                          "id": "502689210484918146",
                          "administration_id": 123,
                          "company_name": "Foobar Holding B.V.",
                          "firstname": null,
                          "lastname": null,
                          "address1": "Hoofdstraat 12",
                          "address2": null,
                          "zipcode": "1234AB",
                          "city": "Amsterdam",
                          "country": "NL",
                          "phone": null,
                          "delivery_method": "Email",
                          "customer_id": "customer-2",
                          "tax_number": null,
                          "chamber_of_commerce": null,
                          "bank_account": null,
                          "is_trusted": false,
                          "max_transfer_amount": null,
                          "attention": null,
                          "email": "info@example.com",
                          "email_ubl": true,
                          "send_invoices_to_attention": null,
                          "send_invoices_to_email": "info@example.com",
                          "send_estimates_to_attention": null,
                          "send_estimates_to_email": "info@example.com",
                          "direct_debit": false,
                          "sepa_active": false,
                          "sepa_iban": null,
                          "sepa_iban_account_name": null,
                          "sepa_bic": null,
                          "sepa_mandate_id": null,
                          "sepa_mandate_date": null,
                          "sepa_sequence_type": "RCUR",
                          "credit_card_number": null,
                          "credit_card_reference": null,
                          "credit_card_type": null,
                          "tax_number_validated_at": null,
                          "tax_number_valid": null,
                          "invoice_workflow_id": null,
                          "estimate_workflow_id": null,
                          "si_identifier": null,
                          "si_identifier_type": null,
                          "moneybird_payments_mandate": false,
                          "created_at": "2026-11-02T12:16:50.894Z",
                          "updated_at": "2026-11-02T12:16:50.894Z",
                          "version": 1793621810,
                          "sales_invoices_url": "https://moneybird.dev/123/sales_invoices/0000000000000000000000000000000000000000000000000000000000000002/all",
                          "notes": [],
                          "custom_fields": [],
                          "contact_people": [],
                          "archived": false
                        },
                        "contact_person_id": null,
                        "contact_person": null,
                        "workflow_id": "502689109097055375",
                        "start_date": "2026-11-03",
                        "invoice_date": "2026-11-03",
                        "last_date": "2026-11-03",
                        "active": true,
                        "payment_conditions": "We verzoeken u vriendelijk het bovenstaande bedrag van {document.total_price} voor {document.due_date} te voldoen op onze bankrekening onder vermelding van de omschrijving {document.payment_reference}. Voor vragen kunt u contact opnemen per e-mail.",
                        "reference": "Project X",
                        "language": "nl",
                        "currency": "EUR",
                        "discount": "0.0",
                        "first_due_interval": 14,
                        "auto_send": false,
                        "sending_scheduled_at": null,
                        "sending_scheduled_user_id": null,
                        "frequency_type": "year",
                        "frequency": 1,
                        "created_at": "2026-11-02T12:16:50.952Z",
                        "updated_at": "2026-11-02T12:16:50.955Z",
                        "version": 1793621810,
                        "prices_are_incl_tax": false,
                        "total_price_excl_tax": "2.91",
                        "total_price_excl_tax_base": "2.91",
                        "total_price_incl_tax": "3.52",
                        "total_price_incl_tax_base": "3.52",
                        "details": [
                          {
                            "id": "502689210545735564",
                            "administration_id": 123,
                            "tax_rate_id": "502689108899923082",
                            "ledger_account_id": "502689108787725434",
                            "project_id": null,
                            "product_id": null,
                            "amount": "5 stuks",
                            "amount_decimal": "5.0",
                            "description": "Appels",
                            "price": "0.45",
                            "period": null,
                            "row_order": 1,
                            "total_price_excl_tax_with_discount": "2.25",
                            "total_price_excl_tax_with_discount_base": "2.25",
                            "tax_report_reference": [
                              "NL/1a"
                            ],
                            "mandatory_tax_text": null,
                            "created_at": "2026-11-02T12:16:50.953Z",
                            "updated_at": "2026-11-02T12:16:50.953Z"
                          },
                          {
                            "id": "502689210546784141",
                            "administration_id": 123,
                            "tax_rate_id": "502689108899923082",
                            "ledger_account_id": "502689108787725434",
                            "project_id": null,
                            "product_id": null,
                            "amount": "2 stuks",
                            "amount_decimal": "2.0",
                            "description": "Peren",
                            "price": "0.33",
                            "period": null,
                            "row_order": 2,
                            "total_price_excl_tax_with_discount": "0.66",
                            "total_price_excl_tax_with_discount_base": "0.66",
                            "tax_report_reference": [
                              "NL/1a"
                            ],
                            "mandatory_tax_text": null,
                            "created_at": "2026-11-02T12:16:50.954Z",
                            "updated_at": "2026-11-02T12:16:50.954Z"
                          }
                        ],
                        "custom_fields": [],
                        "notes": [],
                        "attachments": [],
                        "events": [
                          {
                            "administration_id": 123,
                            "user_id": "502689108256097381",
                            "action": "recurring_sales_invoice_created",
                            "link_entity_id": null,
                            "link_entity_type": null,
                            "data": {},
                            "created_at": "2026-11-02T12:16:50.956Z",
                            "updated_at": "2026-11-02T12:16:50.956Z"
                          }
                        ],
                        "subscription": null
                      }
                    ]
                  },
                  "ReturnsPaginatedRecurringSalesInvoicesOnPage2": {
                    "summary": "Returns paginated recurring sales invoices on page 2",
                    "value": [
                      {
                        "id": "502689210672613276",
                        "administration_id": 123,
                        "contact_id": "502689210632767383",
                        "contact": {
                          "id": "502689210632767383",
                          "administration_id": 123,
                          "company_name": "Foobar Holding B.V.",
                          "firstname": null,
                          "lastname": null,
                          "address1": "Hoofdstraat 12",
                          "address2": null,
                          "zipcode": "1234AB",
                          "city": "Amsterdam",
                          "country": "NL",
                          "phone": null,
                          "delivery_method": "Email",
                          "customer_id": "customer-2",
                          "tax_number": null,
                          "chamber_of_commerce": null,
                          "bank_account": null,
                          "is_trusted": false,
                          "max_transfer_amount": null,
                          "attention": null,
                          "email": "info@example.com",
                          "email_ubl": true,
                          "send_invoices_to_attention": null,
                          "send_invoices_to_email": "info@example.com",
                          "send_estimates_to_attention": null,
                          "send_estimates_to_email": "info@example.com",
                          "direct_debit": false,
                          "sepa_active": false,
                          "sepa_iban": null,
                          "sepa_iban_account_name": null,
                          "sepa_bic": null,
                          "sepa_mandate_id": null,
                          "sepa_mandate_date": null,
                          "sepa_sequence_type": "RCUR",
                          "credit_card_number": null,
                          "credit_card_reference": null,
                          "credit_card_type": null,
                          "tax_number_validated_at": null,
                          "tax_number_valid": null,
                          "invoice_workflow_id": null,
                          "estimate_workflow_id": null,
                          "si_identifier": null,
                          "si_identifier_type": null,
                          "moneybird_payments_mandate": false,
                          "created_at": "2026-11-02T12:16:51.035Z",
                          "updated_at": "2026-11-02T12:16:51.035Z",
                          "version": 1793621811,
                          "sales_invoices_url": "https://moneybird.dev/123/sales_invoices/0000000000000000000000000000000000000000000000000000000000000002/all",
                          "notes": [],
                          "custom_fields": [],
                          "contact_people": [],
                          "archived": false
                        },
                        "contact_person_id": null,
                        "contact_person": null,
                        "workflow_id": "502689109097055375",
                        "start_date": "2026-11-03",
                        "invoice_date": "2026-11-03",
                        "last_date": "2026-11-03",
                        "active": true,
                        "payment_conditions": "We verzoeken u vriendelijk het bovenstaande bedrag van {document.total_price} voor {document.due_date} te voldoen op onze bankrekening onder vermelding van de omschrijving {document.payment_reference}. Voor vragen kunt u contact opnemen per e-mail.",
                        "reference": "Project X",
                        "language": "nl",
                        "currency": "EUR",
                        "discount": "0.0",
                        "first_due_interval": 14,
                        "auto_send": false,
                        "sending_scheduled_at": null,
                        "sending_scheduled_user_id": null,
                        "frequency_type": "year",
                        "frequency": 1,
                        "created_at": "2026-11-02T12:16:51.074Z",
                        "updated_at": "2026-11-02T12:16:51.077Z",
                        "version": 1793621811,
                        "prices_are_incl_tax": false,
                        "total_price_excl_tax": "2.91",
                        "total_price_excl_tax_base": "2.91",
                        "total_price_incl_tax": "3.52",
                        "total_price_incl_tax_base": "3.52",
                        "details": [
                          {
                            "id": "502689210673661853",
                            "administration_id": 123,
                            "tax_rate_id": "502689108899923082",
                            "ledger_account_id": "502689108787725434",
                            "project_id": null,
                            "product_id": null,
                            "amount": "5 stuks",
                            "amount_decimal": "5.0",
                            "description": "Appels",
                            "price": "0.45",
                            "period": null,
                            "row_order": 1,
                            "total_price_excl_tax_with_discount": "2.25",
                            "total_price_excl_tax_with_discount_base": "2.25",
                            "tax_report_reference": [
                              "NL/1a"
                            ],
                            "mandatory_tax_text": null,
                            "created_at": "2026-11-02T12:16:51.075Z",
                            "updated_at": "2026-11-02T12:16:51.075Z"
                          },
                          {
                            "id": "502689210675759006",
                            "administration_id": 123,
                            "tax_rate_id": "502689108899923082",
                            "ledger_account_id": "502689108787725434",
                            "project_id": null,
                            "product_id": null,
                            "amount": "2 stuks",
                            "amount_decimal": "2.0",
                            "description": "Peren",
                            "price": "0.33",
                            "period": null,
                            "row_order": 2,
                            "total_price_excl_tax_with_discount": "0.66",
                            "total_price_excl_tax_with_discount_base": "0.66",
                            "tax_report_reference": [
                              "NL/1a"
                            ],
                            "mandatory_tax_text": null,
                            "created_at": "2026-11-02T12:16:51.076Z",
                            "updated_at": "2026-11-02T12:16:51.076Z"
                          }
                        ],
                        "custom_fields": [],
                        "notes": [],
                        "attachments": [],
                        "events": [
                          {
                            "administration_id": 123,
                            "user_id": "502689108256097381",
                            "action": "recurring_sales_invoice_created",
                            "link_entity_id": null,
                            "link_entity_type": null,
                            "data": {},
                            "created_at": "2026-11-02T12:16:51.079Z",
                            "updated_at": "2026-11-02T12:16:51.079Z"
                          }
                        ],
                        "subscription": null
                      }
                    ]
                  },
                  "ReturnsRecurringInvoicesFilteredOnContact": {
                    "summary": "Returns recurring invoices filtered on contact",
                    "value": [
                      {
                        "id": "502689210786908071",
                        "administration_id": 123,
                        "contact_id": "502689210764887973",
                        "contact": {
                          "id": "502689210764887973",
                          "administration_id": 123,
                          "company_name": "Foobar Holding B.V.",
                          "firstname": null,
                          "lastname": null,
                          "address1": "Hoofdstraat 12",
                          "address2": null,
                          "zipcode": "1234AB",
                          "city": "Amsterdam",
                          "country": "NL",
                          "phone": null,
                          "delivery_method": "Email",
                          "customer_id": "customer-1",
                          "tax_number": null,
                          "chamber_of_commerce": null,
                          "bank_account": null,
                          "is_trusted": false,
                          "max_transfer_amount": null,
                          "attention": null,
                          "email": "info@example.com",
                          "email_ubl": true,
                          "send_invoices_to_attention": null,
                          "send_invoices_to_email": "info@example.com",
                          "send_estimates_to_attention": null,
                          "send_estimates_to_email": "info@example.com",
                          "direct_debit": false,
                          "sepa_active": false,
                          "sepa_iban": null,
                          "sepa_iban_account_name": null,
                          "sepa_bic": null,
                          "sepa_mandate_id": null,
                          "sepa_mandate_date": null,
                          "sepa_sequence_type": "RCUR",
                          "credit_card_number": null,
                          "credit_card_reference": null,
                          "credit_card_type": null,
                          "tax_number_validated_at": null,
                          "tax_number_valid": null,
                          "invoice_workflow_id": null,
                          "estimate_workflow_id": null,
                          "si_identifier": null,
                          "si_identifier_type": null,
                          "moneybird_payments_mandate": false,
                          "created_at": "2026-11-02T12:16:51.161Z",
                          "updated_at": "2026-11-02T12:16:51.161Z",
                          "version": 1793621811,
                          "sales_invoices_url": "https://moneybird.dev/123/sales_invoices/0000000000000000000000000000000000000000000000000000000000000001/all",
                          "notes": [],
                          "custom_fields": [],
                          "contact_people": [],
                          "archived": false
                        },
                        "contact_person_id": null,
                        "contact_person": null,
                        "workflow_id": "502689109097055375",
                        "start_date": "2026-11-03",
                        "invoice_date": "2026-11-03",
                        "last_date": "2026-11-03",
                        "active": true,
                        "payment_conditions": "We verzoeken u vriendelijk het bovenstaande bedrag van {document.total_price} voor {document.due_date} te voldoen op onze bankrekening onder vermelding van de omschrijving {document.payment_reference}. Voor vragen kunt u contact opnemen per e-mail.",
                        "reference": "Project X",
                        "language": "nl",
                        "currency": "EUR",
                        "discount": "0.0",
                        "first_due_interval": 14,
                        "auto_send": false,
                        "sending_scheduled_at": null,
                        "sending_scheduled_user_id": null,
                        "frequency_type": "month",
                        "frequency": 1,
                        "created_at": "2026-11-02T12:16:51.182Z",
                        "updated_at": "2026-11-02T12:16:51.185Z",
                        "version": 1793621811,
                        "prices_are_incl_tax": false,
                        "total_price_excl_tax": "2.91",
                        "total_price_excl_tax_base": "2.91",
                        "total_price_incl_tax": "3.52",
                        "total_price_incl_tax_base": "3.52",
                        "details": [
                          {
                            "id": "502689210787956648",
                            "administration_id": 123,
                            "tax_rate_id": "502689108899923082",
                            "ledger_account_id": "502689108787725434",
                            "project_id": null,
                            "product_id": null,
                            "amount": "5 stuks",
                            "amount_decimal": "5.0",
                            "description": "Appels",
                            "price": "0.45",
                            "period": null,
                            "row_order": 1,
                            "total_price_excl_tax_with_discount": "2.25",
                            "total_price_excl_tax_with_discount_base": "2.25",
                            "tax_report_reference": [
                              "NL/1a"
                            ],
                            "mandatory_tax_text": null,
                            "created_at": "2026-11-02T12:16:51.183Z",
                            "updated_at": "2026-11-02T12:16:51.183Z"
                          },
                          {
                            "id": "502689210789005225",
                            "administration_id": 123,
                            "tax_rate_id": "502689108899923082",
                            "ledger_account_id": "502689108787725434",
                            "project_id": null,
                            "product_id": null,
                            "amount": "2 stuks",
                            "amount_decimal": "2.0",
                            "description": "Peren",
                            "price": "0.33",
                            "period": null,
                            "row_order": 2,
                            "total_price_excl_tax_with_discount": "0.66",
                            "total_price_excl_tax_with_discount_base": "0.66",
                            "tax_report_reference": [
                              "NL/1a"
                            ],
                            "mandatory_tax_text": null,
                            "created_at": "2026-11-02T12:16:51.185Z",
                            "updated_at": "2026-11-02T12:16:51.185Z"
                          }
                        ],
                        "custom_fields": [],
                        "notes": [],
                        "attachments": [],
                        "events": [
                          {
                            "administration_id": 123,
                            "user_id": "502689108256097381",
                            "action": "recurring_sales_invoice_created",
                            "link_entity_id": null,
                            "link_entity_type": null,
                            "data": {},
                            "created_at": "2026-11-02T12:16:51.186Z",
                            "updated_at": "2026-11-02T12:16:51.186Z"
                          }
                        ],
                        "subscription": null
                      }
                    ]
                  },
                  "ReturnsRecurringInvoicesFilteredOnFrequency": {
                    "summary": "Returns recurring invoices filtered on frequency",
                    "value": [
                      {
                        "id": "502689210963068866",
                        "administration_id": 123,
                        "contact_id": "502689210943145920",
                        "contact": {
                          "id": "502689210943145920",
                          "administration_id": 123,
                          "company_name": "Foobar Holding B.V.",
                          "firstname": null,
                          "lastname": null,
                          "address1": "Hoofdstraat 12",
                          "address2": null,
                          "zipcode": "1234AB",
                          "city": "Amsterdam",
                          "country": "NL",
                          "phone": null,
                          "delivery_method": "Email",
                          "customer_id": "customer-1",
                          "tax_number": null,
                          "chamber_of_commerce": null,
                          "bank_account": null,
                          "is_trusted": false,
                          "max_transfer_amount": null,
                          "attention": null,
                          "email": "info@example.com",
                          "email_ubl": true,
                          "send_invoices_to_attention": null,
                          "send_invoices_to_email": "info@example.com",
                          "send_estimates_to_attention": null,
                          "send_estimates_to_email": "info@example.com",
                          "direct_debit": false,
                          "sepa_active": false,
                          "sepa_iban": null,
                          "sepa_iban_account_name": null,
                          "sepa_bic": null,
                          "sepa_mandate_id": null,
                          "sepa_mandate_date": null,
                          "sepa_sequence_type": "RCUR",
                          "credit_card_number": null,
                          "credit_card_reference": null,
                          "credit_card_type": null,
                          "tax_number_validated_at": null,
                          "tax_number_valid": null,
                          "invoice_workflow_id": null,
                          "estimate_workflow_id": null,
                          "si_identifier": null,
                          "si_identifier_type": null,
                          "moneybird_payments_mandate": false,
                          "created_at": "2026-11-02T12:16:51.332Z",
                          "updated_at": "2026-11-02T12:16:51.332Z",
                          "version": 1793621811,
                          "sales_invoices_url": "https://moneybird.dev/123/sales_invoices/0000000000000000000000000000000000000000000000000000000000000001/all",
                          "notes": [],
                          "custom_fields": [],
                          "contact_people": [],
                          "archived": false
                        },
                        "contact_person_id": null,
                        "contact_person": null,
                        "workflow_id": "502689109097055375",
                        "start_date": "2026-11-03",
                        "invoice_date": "2026-11-03",
                        "last_date": "2026-11-03",
                        "active": true,
                        "payment_conditions": "We verzoeken u vriendelijk het bovenstaande bedrag van {document.total_price} voor {document.due_date} te voldoen op onze bankrekening onder vermelding van de omschrijving {document.payment_reference}. Voor vragen kunt u contact opnemen per e-mail.",
                        "reference": "Project X",
                        "language": "nl",
                        "currency": "EUR",
                        "discount": "0.0",
                        "first_due_interval": 14,
                        "auto_send": false,
                        "sending_scheduled_at": null,
                        "sending_scheduled_user_id": null,
                        "frequency_type": "month",
                        "frequency": 1,
                        "created_at": "2026-11-02T12:16:51.350Z",
                        "updated_at": "2026-11-02T12:16:51.353Z",
                        "version": 1793621811,
                        "prices_are_incl_tax": false,
                        "total_price_excl_tax": "2.91",
                        "total_price_excl_tax_base": "2.91",
                        "total_price_incl_tax": "3.52",
                        "total_price_incl_tax_base": "3.52",
                        "details": [
                          {
                            "id": "502689210964117443",
                            "administration_id": 123,
                            "tax_rate_id": "502689108899923082",
                            "ledger_account_id": "502689108787725434",
                            "project_id": null,
                            "product_id": null,
                            "amount": "5 stuks",
                            "amount_decimal": "5.0",
                            "description": "Appels",
                            "price": "0.45",
                            "period": null,
                            "row_order": 1,
                            "total_price_excl_tax_with_discount": "2.25",
                            "total_price_excl_tax_with_discount_base": "2.25",
                            "tax_report_reference": [
                              "NL/1a"
                            ],
                            "mandatory_tax_text": null,
                            "created_at": "2026-11-02T12:16:51.352Z",
                            "updated_at": "2026-11-02T12:16:51.352Z"
                          },
                          {
                            "id": "502689210965166020",
                            "administration_id": 123,
                            "tax_rate_id": "502689108899923082",
                            "ledger_account_id": "502689108787725434",
                            "project_id": null,
                            "product_id": null,
                            "amount": "2 stuks",
                            "amount_decimal": "2.0",
                            "description": "Peren",
                            "price": "0.33",
                            "period": null,
                            "row_order": 2,
                            "total_price_excl_tax_with_discount": "0.66",
                            "total_price_excl_tax_with_discount_base": "0.66",
                            "tax_report_reference": [
                              "NL/1a"
                            ],
                            "mandatory_tax_text": null,
                            "created_at": "2026-11-02T12:16:51.353Z",
                            "updated_at": "2026-11-02T12:16:51.353Z"
                          }
                        ],
                        "custom_fields": [],
                        "notes": [],
                        "attachments": [],
                        "events": [
                          {
                            "administration_id": 123,
                            "user_id": "502689108256097381",
                            "action": "recurring_sales_invoice_created",
                            "link_entity_id": null,
                            "link_entity_type": null,
                            "data": {},
                            "created_at": "2026-11-02T12:16:51.355Z",
                            "updated_at": "2026-11-02T12:16:51.355Z"
                          }
                        ],
                        "subscription": null
                      }
                    ]
                  }
                }
              }
            }
          },
          "400": {
            "description": "Bad request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/symbolic_error"
                },
                "examples": {
                  "ReturnsAnErrorWhenTooManyRecurringSalesInvoicesAreRequested": {
                    "summary": "Returns an error when too many recurring sales invoices are requested",
                    "value": {
                      "error": "per_page does not have a valid value"
                    }
                  }
                }
              }
            }
          }
        },
        "operationId": "get_administration_id_recurring_sales_invoices"
      },
      "post": {
        "summary": "Creates a new recurring sales invoice",
        "description": "A recurring sales invoice will create new sales invoices on set intervals. To create a new recurring sales invoice,\nyou need to provide at least a contact and details for the invoice. Furthermore you need to determine the planning.\nThe following fields will influence the planning:\n\n1. `invoice_date`: the date in which the first invoice should be created\n2. `frequency_type`: the type of frequency you want to use, for example `month`\n3. `frequency`: defines the actual frequency, e.g. `frequency=2` and `frequency_type=month` will create an invoice every 2 months\n4. `has_desired_count`: whether or not the desired count should take effect\n5. `desired_count`: maximum number of sales invoices to create\n\n### Required scope(s)\n `sales_invoices`",
        "tags": [
          "Recurring sales invoices"
        ],
        "security": [
          {
            "bearerAuth": [
              "sales_invoices"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/administration_id"
          },
          {
            "$ref": "#/components/parameters/format"
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/*": {
              "schema": {
                "unevaluatedProperties": false,
                "type": "object",
                "properties": {
                  "recurring_sales_invoice": {
                    "type": "object",
                    "unevaluatedProperties": false,
                    "properties": {
                      "document_style_id": {
                        "$ref": "#/components/schemas/identifier",
                        "description": "Should be a valid document style id."
                      },
                      "contact_id": {
                        "$ref": "#/components/schemas/identifier",
                        "description": "Should be a valid contact id."
                      },
                      "contact_person_id": {
                        "$ref": "#/components/schemas/identifier",
                        "description": "Should be a valid contact person id."
                      },
                      "update_contact": {
                        "type": [
                          "boolean",
                          "string"
                        ],
                        "description": "When `true`, the contact's address and other details are refreshed from the current contact record each time a new invoice is generated."
                      },
                      "reference": {
                        "type": "string",
                        "description": "A reference to include on each generated invoice, e.g. a contract or project code."
                      },
                      "invoice_date": {
                        "type": "string",
                        "description": "Should be in the future."
                      },
                      "workflow_id": {
                        "$ref": "#/components/schemas/identifier",
                        "description": "Should be a valid workflow id. If not provided, the contact's invoice workflow is used."
                      },
                      "currency": {
                        "type": "string",
                        "description": "ISO three-character currency code, e.g. EUR or USD. Defaults to the workflow's currency."
                      },
                      "first_due_interval": {
                        "type": "integer",
                        "description": "The number of days after the invoice date before each generated invoice is due. Defaults to the first workflow step's due interval."
                      },
                      "prices_are_incl_tax": {
                        "type": [
                          "boolean",
                          "string"
                        ],
                        "description": "Whether the prices on generated invoices are inclusive of tax. Defaults to the workflow's setting."
                      },
                      "discount": {
                        "$ref": "#/components/schemas/number",
                        "description": "Discount percentage, e.g. 10,0%."
                      },
                      "frequency_type": {
                        "type": "string",
                        "description": "Can be `day`, `week`, `month`, `quarter` or `year`."
                      },
                      "frequency": {
                        "type": "string",
                        "description": "The interval multiplier. Combined with `frequency_type` to determine the billing cycle, e.g. `frequency=2` with `frequency_type=month` creates an invoice every 2 months."
                      },
                      "has_desired_count": {
                        "type": [
                          "boolean",
                          "string"
                        ],
                        "description": "When `true`, the recurring invoice will stop generating new invoices after `desired_count` invoices have been created."
                      },
                      "desired_count": {
                        "type": "string",
                        "description": "The maximum number of invoices to generate. Only applied when `has_desired_count` is `true`."
                      },
                      "auto_send": {
                        "type": [
                          "boolean",
                          "string"
                        ],
                        "description": "When `true`, each generated invoice is automatically sent to the contact via the configured delivery method."
                      },
                      "mergeable": {
                        "type": [
                          "boolean",
                          "string"
                        ],
                        "description": "When `true`, generated invoices may be merged with other mergeable invoices for the same contact, if they share the same workflow, layout, currency, language and other invoice settings."
                      },
                      "details_attributes": {
                        "$ref": "#/components/schemas/details_attributes"
                      },
                      "custom_fields_attributes": {
                        "$ref": "#/components/schemas/custom_fields_attributes"
                      }
                    },
                    "required": []
                  }
                },
                "required": []
              },
              "examples": {
                "CreatesANewRecurringSalesInvoice": {
                  "summary": "Creates a new recurring sales invoice",
                  "value": {
                    "recurring_sales_invoice": {
                      "reference": "My recurring invoice",
                      "contact_id": 502689209809635100,
                      "invoice_date": "2030-01-01",
                      "details_attributes": {
                        "0": {
                          "description": "Table",
                          "price": "10.5",
                          "tax_rate_id": 502689209814877950,
                          "ledger_account_id": 502689209822218050
                        }
                      }
                    }
                  }
                }
              }
            }
          }
        },
        "responses": {
          "201": {
            "description": "Recurring sales invoice created",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/recurring_sales_invoice_response"
                },
                "examples": {
                  "CreatesANewRecurringSalesInvoice": {
                    "summary": "Creates a new recurring sales invoice",
                    "value": {
                      "id": "502689209843189539",
                      "administration_id": 123,
                      "contact_id": "502689209809635101",
                      "contact": {
                        "id": "502689209809635101",
                        "administration_id": 123,
                        "company_name": "Foobar Holding B.V.",
                        "firstname": null,
                        "lastname": null,
                        "address1": "Hoofdstraat 12",
                        "address2": null,
                        "zipcode": "1234AB",
                        "city": "Amsterdam",
                        "country": "NL",
                        "phone": null,
                        "delivery_method": "Email",
                        "customer_id": "customer-2",
                        "tax_number": null,
                        "chamber_of_commerce": null,
                        "bank_account": null,
                        "is_trusted": false,
                        "max_transfer_amount": null,
                        "attention": null,
                        "email": "info@example.com",
                        "email_ubl": true,
                        "send_invoices_to_attention": null,
                        "send_invoices_to_email": "info@example.com",
                        "send_estimates_to_attention": null,
                        "send_estimates_to_email": "info@example.com",
                        "direct_debit": false,
                        "sepa_active": false,
                        "sepa_iban": null,
                        "sepa_iban_account_name": null,
                        "sepa_bic": null,
                        "sepa_mandate_id": null,
                        "sepa_mandate_date": null,
                        "sepa_sequence_type": "RCUR",
                        "credit_card_number": null,
                        "credit_card_reference": null,
                        "credit_card_type": null,
                        "tax_number_validated_at": null,
                        "tax_number_valid": null,
                        "invoice_workflow_id": null,
                        "estimate_workflow_id": null,
                        "si_identifier": null,
                        "si_identifier_type": null,
                        "moneybird_payments_mandate": false,
                        "created_at": "2026-11-02T12:16:50.251Z",
                        "updated_at": "2026-11-02T12:16:50.251Z",
                        "version": 1793621810,
                        "sales_invoices_url": "https://moneybird.dev/123/sales_invoices/0000000000000000000000000000000000000000000000000000000000000002/all",
                        "notes": [],
                        "custom_fields": [],
                        "contact_people": [],
                        "archived": false
                      },
                      "contact_person_id": null,
                      "contact_person": null,
                      "workflow_id": "502689109097055375",
                      "start_date": "2030-01-01",
                      "invoice_date": "2030-01-01",
                      "last_date": null,
                      "active": true,
                      "payment_conditions": "We verzoeken u vriendelijk het bovenstaande bedrag van {document.total_price} voor {document.due_date} te voldoen op onze bankrekening onder vermelding van de omschrijving {document.payment_reference}. Voor vragen kunt u contact opnemen per e-mail.",
                      "reference": "My recurring invoice",
                      "language": "nl",
                      "currency": "EUR",
                      "discount": "0.0",
                      "first_due_interval": 14,
                      "auto_send": false,
                      "sending_scheduled_at": null,
                      "sending_scheduled_user_id": null,
                      "frequency_type": "year",
                      "frequency": 1,
                      "created_at": "2026-11-02T12:16:50.283Z",
                      "updated_at": "2026-11-02T12:16:50.285Z",
                      "version": 1793621810,
                      "prices_are_incl_tax": false,
                      "total_price_excl_tax": "10.5",
                      "total_price_excl_tax_base": "10.5",
                      "total_price_incl_tax": "12.71",
                      "total_price_incl_tax_base": "12.71",
                      "details": [
                        {
                          "id": "502689209845286692",
                          "administration_id": 123,
                          "tax_rate_id": "502689209814877983",
                          "ledger_account_id": "502689209822218017",
                          "project_id": null,
                          "product_id": null,
                          "amount": null,
                          "amount_decimal": "1.0",
                          "description": "Table",
                          "price": "10.5",
                          "period": null,
                          "row_order": 0,
                          "total_price_excl_tax_with_discount": "10.5",
                          "total_price_excl_tax_with_discount_base": "10.5",
                          "tax_report_reference": [],
                          "mandatory_tax_text": null,
                          "created_at": "2026-11-02T12:16:50.284Z",
                          "updated_at": "2026-11-02T12:16:50.284Z"
                        }
                      ],
                      "custom_fields": [],
                      "notes": [],
                      "attachments": [],
                      "events": [
                        {
                          "administration_id": 123,
                          "user_id": "502689108256097381",
                          "action": "recurring_sales_invoice_created",
                          "link_entity_id": null,
                          "link_entity_type": null,
                          "data": {},
                          "created_at": "2026-11-02T12:16:50.286Z",
                          "updated_at": "2026-11-02T12:16:50.286Z"
                        }
                      ],
                      "subscription": null
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "Bad request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/symbolic_error"
                },
                "examples": {
                  "Returns400WhenMergeableIsTrueButAutoSendIsFalse": {
                    "summary": "Returns 400 when mergeable is true but auto send is false",
                    "value": {
                      "error": "if mergeable is true, auto_send must be true",
                      "symbolic": {
                        "mergeable": "invalid"
                      }
                    }
                  }
                }
              }
            }
          },
          "402": {
            "description": "Payment required",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/symbolic_error"
                },
                "examples": {
                  "Returns402WhenPaymentIsRequired": {
                    "summary": "Returns 402 when payment is required",
                    "value": {
                      "error": "creating recurring sales invoices is limited",
                      "symbolic": {
                        "administration": "limit_reached"
                      }
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "Unprocessable entity",
            "content": {
              "application/json": {
                "schema": {
                  "anyOf": [
                    {
                      "$ref": "#/components/schemas/symbolic_error"
                    },
                    {
                      "$ref": "#/components/schemas/non_symbolic_error"
                    }
                  ]
                },
                "examples": {
                  "Returns422WhenValidationFails": {
                    "summary": "Returns 422 when validation fails",
                    "value": {
                      "error": {
                        "invoice_date": [
                          "must be further in the future"
                        ]
                      },
                      "details": {
                        "invoice_date": [
                          {
                            "error": "too_early"
                          }
                        ]
                      }
                    }
                  }
                }
              }
            }
          }
        },
        "operationId": "post_administration_id_recurring_sales_invoices"
      }
    },
    "/{administration_id}/reports/assets{format}": {
      "get": {
        "summary": "Assets report",
        "description": "Get the assets report for the administration.\n\n### Required scope(s)\n `documents`",
        "tags": [
          "Reports"
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/administration_id"
          },
          {
            "$ref": "#/components/parameters/format"
          },
          {
            "$ref": "#/components/parameters/period"
          }
        ],
        "security": [
          {
            "bearerAuth": [
              "documents"
            ]
          }
        ],
        "responses": {
          "200": {
            "description": "An assets report",
            "content": {
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "type": "object",
                    "properties": {
                      "asset_id": {
                        "$ref": "#/components/schemas/identifier"
                      },
                      "ledger_account_id": {
                        "$ref": "#/components/schemas/identifier"
                      },
                      "name": {
                        "type": "string"
                      },
                      "purchase_date": {
                        "type": "string",
                        "format": "date"
                      },
                      "lifespan": {
                        "type": [
                          "string",
                          "null"
                        ],
                        "description": "In seconds"
                      },
                      "purchase_value": {
                        "type": "string"
                      },
                      "calculated_purchase_value": {
                        "type": "string"
                      },
                      "residual_value": {
                        "type": "string"
                      },
                      "total_value_changes_since_purchase": {
                        "type": "string"
                      },
                      "value_at_begin": {
                        "type": "string"
                      },
                      "investment": {
                        "type": "string"
                      },
                      "depreciation": {
                        "type": "string"
                      },
                      "divestment": {
                        "type": "string"
                      },
                      "value_changes": {
                        "type": "string"
                      },
                      "value_at_end": {
                        "type": "string"
                      },
                      "value_not_in_use": {
                        "type": "string",
                        "description": "Amount booked on an asset whose purchase date is after the end of the period"
                      }
                    }
                  }
                },
                "examples": {
                  "ReturnsAssetsReport": {
                    "summary": "Returns assets report",
                    "value": [
                      {
                        "asset_id": "502689275104462184",
                        "ledger_account_id": "502689275097122151",
                        "name": "Test Asset",
                        "purchase_date": "2025-01-01",
                        "lifespan": "157784760",
                        "purchase_value": "12345.67",
                        "calculated_purchase_value": "12345.67",
                        "residual_value": "10.0",
                        "total_value_changes_since_purchase": "-200.0",
                        "value_at_begin": "12145.67",
                        "investment": "0",
                        "depreciation": "0.0",
                        "divestment": "0.0",
                        "value_changes": "0.0",
                        "value_at_end": "12145.67",
                        "value_not_in_use": "0"
                      }
                    ]
                  },
                  "ReturnsSuccessForFullPeriod": {
                    "summary": "Returns success for full period",
                    "value": [
                      {
                        "asset_id": "502689276234827244",
                        "ledger_account_id": "502689276229584363",
                        "name": "Test Asset",
                        "purchase_date": "2025-01-01",
                        "lifespan": "157784760",
                        "purchase_value": "12345.67",
                        "calculated_purchase_value": "12345.67",
                        "residual_value": "10.0",
                        "total_value_changes_since_purchase": "-200.0",
                        "value_at_begin": "0",
                        "investment": "12345.67",
                        "depreciation": "-200.0",
                        "divestment": "0.0",
                        "value_changes": "-200.0",
                        "value_at_end": "12145.67",
                        "value_not_in_use": "0"
                      }
                    ]
                  }
                }
              }
            }
          },
          "400": {
            "description": "Bad request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/symbolic_error"
                },
                "examples": {
                  "ReturnsErrorWhenPeriodExceedsLimit": {
                    "summary": "Returns error when period exceeds limit",
                    "value": {
                      "error": "Period cannot exceed 12 months"
                    }
                  },
                  "ReturnsErrorForInvalidPeriodFormat": {
                    "summary": "Returns error for invalid period format",
                    "value": {
                      "error": "Period is invalid"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Unauthorized",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/symbolic_error"
                },
                "examples": {
                  "Returns401WhenUserLacksRequiredPermissions": {
                    "summary": "Returns 401 when user lacks required permissions",
                    "value": {
                      "error": "No access to documents"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "Too many requests - rate limit exceeded",
            "content": {
              "application/json": {
                "schema": {
                  "type": "string",
                  "example": "Retry later"
                },
                "examples": {
                  "Returns429WhenExceedingTheRateLimit": {
                    "summary": "Returns 429 when exceeding the rate limit",
                    "value": "Retry later"
                  }
                }
              }
            },
            "headers": {
              "RateLimit-Limit": {
                "description": "The rate limit ceiling for that given request",
                "schema": {
                  "type": "integer",
                  "example": 150
                }
              },
              "RateLimit-Remaining": {
                "description": "The number of requests left for the time window",
                "schema": {
                  "type": "integer",
                  "example": 149
                }
              },
              "RateLimit-Reset": {
                "description": "The time at which the current rate limit window resets in UTC epoch seconds",
                "schema": {
                  "type": "integer",
                  "example": 1609459200
                }
              },
              "Retry-After": {
                "description": "The time at which the current rate limit window resets in UTC epoch seconds",
                "schema": {
                  "type": "integer",
                  "example": 1609459200
                }
              }
            }
          }
        },
        "operationId": "get_administration_id_reports_assets"
      }
    },
    "/{administration_id}/reports/balance_sheet{format}": {
      "get": {
        "summary": "Balance sheet report",
        "description": "Get the balance sheet report for the administration showing the financial position at the end of the specified period.\n\nWith `granularity`, `periods` also gives the balance sheet at the end of every month, quarter or year in the period.\n\n### Required scope(s)\n `bank`",
        "tags": [
          "Reports"
        ],
        "security": [
          {
            "bearerAuth": [
              "bank"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/administration_id"
          },
          {
            "$ref": "#/components/parameters/format"
          },
          {
            "$ref": "#/components/parameters/period"
          },
          {
            "$ref": "#/components/parameters/granularity"
          }
        ],
        "responses": {
          "200": {
            "description": "A balance sheet report",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "debit": {
                      "$ref": "#/components/schemas/balance_sheet_debit"
                    },
                    "credit": {
                      "$ref": "#/components/schemas/balance_sheet_credit"
                    },
                    "periods": {
                      "type": "array",
                      "description": "Only present when `granularity` is given. One item for each month, quarter or year in `period`, oldest first.",
                      "items": {
                        "type": "object",
                        "required": [
                          "period",
                          "debit",
                          "credit"
                        ],
                        "properties": {
                          "period": {
                            "type": "string",
                            "description": "The period of this item, in the same format as the `period` parameter (e.g. `202501..202503`)."
                          },
                          "debit": {
                            "$ref": "#/components/schemas/balance_sheet_debit"
                          },
                          "credit": {
                            "$ref": "#/components/schemas/balance_sheet_credit"
                          }
                        }
                      }
                    }
                  }
                },
                "examples": {
                  "ReturnsABalanceSheetReport": {
                    "summary": "Returns a balance sheet report",
                    "value": {
                      "debit": {
                        "total": "1100.0",
                        "current_assets": [
                          {
                            "ledger_account_id": "502689223602603667",
                            "value": "800.0",
                            "children": [
                              {
                                "ledger_account_id": "502689223613089432",
                                "value": "100.0"
                              }
                            ]
                          }
                        ],
                        "non_current_assets": [
                          {
                            "ledger_account_id": "502689223621478045",
                            "value": "200.0",
                            "children": []
                          }
                        ]
                      },
                      "credit": {
                        "total": "1100.0",
                        "equity": [
                          {
                            "ledger_account_id": "502689223646643884",
                            "value": "550.0",
                            "children": []
                          }
                        ],
                        "provisions": [
                          {
                            "ledger_account_id": "502689223639303847",
                            "value": "150.0",
                            "children": []
                          }
                        ],
                        "non_current_liabilities": [],
                        "current_liabilities": [
                          {
                            "ledger_account_id": "502689223630915234",
                            "value": "300.0",
                            "children": []
                          }
                        ],
                        "open_years": [
                          {
                            "year": "2024",
                            "value": "100.0"
                          }
                        ]
                      }
                    }
                  },
                  "ReturnsTheBalanceAtTheEndOfEachPeriodByGranularity": {
                    "summary": "Returns the balance at the end of each period by granularity",
                    "value": {
                      "debit": {
                        "total": "1150.0",
                        "current_assets": [
                          {
                            "ledger_account_id": "502689223693829814",
                            "value": "850.0",
                            "children": [
                              {
                                "ledger_account_id": "502689223704315579",
                                "value": "100.0"
                              }
                            ]
                          }
                        ],
                        "non_current_assets": [
                          {
                            "ledger_account_id": "502689223711655616",
                            "value": "200.0",
                            "children": []
                          }
                        ]
                      },
                      "credit": {
                        "total": "1150.0",
                        "equity": [
                          {
                            "ledger_account_id": "502689223735772879",
                            "value": "600.0",
                            "children": []
                          }
                        ],
                        "provisions": [
                          {
                            "ledger_account_id": "502689223727384266",
                            "value": "150.0",
                            "children": []
                          }
                        ],
                        "non_current_liabilities": [],
                        "current_liabilities": [
                          {
                            "ledger_account_id": "502689223720044229",
                            "value": "300.0",
                            "children": []
                          }
                        ],
                        "open_years": [
                          {
                            "year": "2024",
                            "value": "100.0"
                          }
                        ]
                      },
                      "periods": [
                        {
                          "period": "202505..202505",
                          "debit": {
                            "total": "50.0",
                            "current_assets": [
                              {
                                "ledger_account_id": "502689223693829814",
                                "value": "50.0",
                                "children": []
                              }
                            ],
                            "non_current_assets": []
                          },
                          "credit": {
                            "total": "150.0",
                            "equity": [
                              {
                                "ledger_account_id": "502689223735772879",
                                "value": "50.0",
                                "children": []
                              }
                            ],
                            "provisions": [],
                            "non_current_liabilities": [],
                            "current_liabilities": [],
                            "open_years": [
                              {
                                "year": "2024",
                                "value": "100.0"
                              }
                            ]
                          }
                        },
                        {
                          "period": "202506..202506",
                          "debit": {
                            "total": "1150.0",
                            "current_assets": [
                              {
                                "ledger_account_id": "502689223693829814",
                                "value": "850.0",
                                "children": [
                                  {
                                    "ledger_account_id": "502689223704315579",
                                    "value": "100.0"
                                  }
                                ]
                              }
                            ],
                            "non_current_assets": [
                              {
                                "ledger_account_id": "502689223711655616",
                                "value": "200.0",
                                "children": []
                              }
                            ]
                          },
                          "credit": {
                            "total": "1150.0",
                            "equity": [
                              {
                                "ledger_account_id": "502689223735772879",
                                "value": "600.0",
                                "children": []
                              }
                            ],
                            "provisions": [
                              {
                                "ledger_account_id": "502689223727384266",
                                "value": "150.0",
                                "children": []
                              }
                            ],
                            "non_current_liabilities": [],
                            "current_liabilities": [
                              {
                                "ledger_account_id": "502689223720044229",
                                "value": "300.0",
                                "children": []
                              }
                            ],
                            "open_years": [
                              {
                                "year": "2024",
                                "value": "100.0"
                              }
                            ]
                          }
                        }
                      ]
                    }
                  },
                  "PutsAnAccountThatChangesSignOnTheSideOfItsBalanceAtTheEndOfEachPeriod": {
                    "summary": "Puts an account that changes sign on the side of its balance at the end of each period",
                    "value": {
                      "debit": {
                        "total": "1100.0",
                        "current_assets": [
                          {
                            "ledger_account_id": "502689223804978913",
                            "value": "800.0",
                            "children": [
                              {
                                "ledger_account_id": "502689223814416102",
                                "value": "100.0"
                              }
                            ]
                          }
                        ],
                        "non_current_assets": [
                          {
                            "ledger_account_id": "502689223823853291",
                            "value": "200.0",
                            "children": []
                          }
                        ]
                      },
                      "credit": {
                        "total": "1400.0",
                        "equity": [
                          {
                            "ledger_account_id": "502689223851116282",
                            "value": "550.0",
                            "children": []
                          }
                        ],
                        "provisions": [
                          {
                            "ledger_account_id": "502689223841679093",
                            "value": "150.0",
                            "children": []
                          }
                        ],
                        "non_current_liabilities": [],
                        "current_liabilities": [
                          {
                            "ledger_account_id": "502689223832241904",
                            "value": "300.0",
                            "children": []
                          },
                          {
                            "ledger_account_id": "502689223866844932",
                            "value": "300.0",
                            "children": []
                          }
                        ],
                        "open_years": [
                          {
                            "year": "2024",
                            "value": "100.0"
                          }
                        ]
                      },
                      "periods": [
                        {
                          "period": "202506..202506",
                          "debit": {
                            "total": "1100.0",
                            "current_assets": [
                              {
                                "ledger_account_id": "502689223804978913",
                                "value": "800.0",
                                "children": [
                                  {
                                    "ledger_account_id": "502689223814416102",
                                    "value": "100.0"
                                  }
                                ]
                              }
                            ],
                            "non_current_assets": [
                              {
                                "ledger_account_id": "502689223823853291",
                                "value": "200.0",
                                "children": []
                              }
                            ]
                          },
                          "credit": {
                            "total": "1400.0",
                            "equity": [
                              {
                                "ledger_account_id": "502689223851116282",
                                "value": "550.0",
                                "children": []
                              }
                            ],
                            "provisions": [
                              {
                                "ledger_account_id": "502689223841679093",
                                "value": "150.0",
                                "children": []
                              }
                            ],
                            "non_current_liabilities": [],
                            "current_liabilities": [
                              {
                                "ledger_account_id": "502689223832241904",
                                "value": "300.0",
                                "children": []
                              },
                              {
                                "ledger_account_id": "502689223866844932",
                                "value": "300.0",
                                "children": []
                              }
                            ],
                            "open_years": [
                              {
                                "year": "2024",
                                "value": "100.0"
                              }
                            ]
                          }
                        }
                      ]
                    }
                  },
                  "ReturnsSuccessForFullPeriod": {
                    "summary": "Returns success for full period",
                    "value": {
                      "debit": {
                        "total": "1100.0",
                        "current_assets": [
                          {
                            "ledger_account_id": "502689223990576944",
                            "value": "800.0",
                            "children": [
                              {
                                "ledger_account_id": "502689223998965557",
                                "value": "100.0"
                              }
                            ]
                          }
                        ],
                        "non_current_assets": [
                          {
                            "ledger_account_id": "502689224005257018",
                            "value": "200.0",
                            "children": []
                          }
                        ]
                      },
                      "credit": {
                        "total": "1100.0",
                        "equity": [
                          {
                            "ledger_account_id": "502689224031471433",
                            "value": "550.0",
                            "children": []
                          }
                        ],
                        "provisions": [
                          {
                            "ledger_account_id": "502689224019937092",
                            "value": "150.0",
                            "children": []
                          }
                        ],
                        "non_current_liabilities": [],
                        "current_liabilities": [
                          {
                            "ledger_account_id": "502689224012597055",
                            "value": "300.0",
                            "children": []
                          }
                        ],
                        "open_years": [
                          {
                            "year": "2024",
                            "value": "100.0"
                          }
                        ]
                      }
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "Bad request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/symbolic_error"
                },
                "examples": {
                  "ReturnsErrorForInvalidPeriodFormat": {
                    "summary": "Returns error for invalid period format",
                    "value": {
                      "error": "Period is invalid"
                    }
                  },
                  "ReturnsErrorWhenPeriodExceedsLimit": {
                    "summary": "Returns error when period exceeds limit",
                    "value": {
                      "error": "Period cannot exceed 12 months"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Unauthorized",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/symbolic_error"
                },
                "examples": {
                  "Returns401WhenUserLacksRequiredPermissions": {
                    "summary": "Returns 401 when user lacks required permissions",
                    "value": {
                      "error": "No access to bank"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "Too many requests - rate limit exceeded",
            "content": {
              "application/json": {
                "schema": {
                  "type": "string",
                  "example": "Retry later"
                },
                "examples": {
                  "Returns429WhenExceedingTheRateLimit": {
                    "summary": "Returns 429 when exceeding the rate limit",
                    "value": "Retry later"
                  }
                }
              }
            },
            "headers": {
              "RateLimit-Limit": {
                "description": "The rate limit ceiling for that given request",
                "schema": {
                  "type": "integer",
                  "example": 150
                }
              },
              "RateLimit-Remaining": {
                "description": "The number of requests left for the time window",
                "schema": {
                  "type": "integer",
                  "example": 149
                }
              },
              "RateLimit-Reset": {
                "description": "The time at which the current rate limit window resets in UTC epoch seconds",
                "schema": {
                  "type": "integer",
                  "example": 1609459200
                }
              },
              "Retry-After": {
                "description": "The time at which the current rate limit window resets in UTC epoch seconds",
                "schema": {
                  "type": "integer",
                  "example": 1609459200
                }
              }
            }
          }
        },
        "operationId": "get_administration_id_reports_balance_sheet"
      }
    },
    "/{administration_id}/reports/bank_balance{format}": {
      "get": {
        "summary": "Bank balance report",
        "description": "Get the booked balance of each financial account at the end of the specified period. These are the balances in the bookkeeping, not the balances the bank reports.\n\nWith `granularity`, `periods` also gives the balances at the end of every month, quarter or year in the period.\n\n### Required scope(s)\n `bank`",
        "tags": [
          "Reports"
        ],
        "security": [
          {
            "bearerAuth": [
              "bank"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/administration_id"
          },
          {
            "$ref": "#/components/parameters/format"
          },
          {
            "$ref": "#/components/parameters/period"
          },
          {
            "$ref": "#/components/parameters/granularity"
          }
        ],
        "responses": {
          "200": {
            "description": "A bank balance report",
            "content": {
              "application/json": {
                "schema": {
                  "allOf": [
                    {
                      "$ref": "#/components/schemas/bank_balance_amounts"
                    },
                    {
                      "type": "object",
                      "properties": {
                        "periods": {
                          "type": "array",
                          "description": "Only present when `granularity` is given. One item for each month, quarter or year in `period`, oldest first.",
                          "items": {
                            "allOf": [
                              {
                                "type": "object",
                                "required": [
                                  "period"
                                ],
                                "properties": {
                                  "period": {
                                    "type": "string",
                                    "description": "The period of this item, in the same format as the `period` parameter (e.g. `202501..202503`)."
                                  }
                                }
                              },
                              {
                                "$ref": "#/components/schemas/bank_balance_amounts"
                              }
                            ]
                          }
                        }
                      }
                    }
                  ]
                },
                "examples": {
                  "ReturnsTheBalancesAtTheEndOfEachPeriodByGranularity": {
                    "summary": "Returns the balances at the end of each period by granularity",
                    "value": {
                      "total": "70.0",
                      "financial_accounts": [
                        {
                          "financial_account_id": "502689287699957170",
                          "name": "ING NL28INGB0000000001",
                          "type": "BankAccount",
                          "balance": "70.0"
                        }
                      ],
                      "periods": [
                        {
                          "period": "202505..202505",
                          "total": "100.0",
                          "financial_accounts": [
                            {
                              "financial_account_id": "502689287699957170",
                              "name": "ING NL28INGB0000000001",
                              "type": "BankAccount",
                              "balance": "100.0"
                            }
                          ]
                        },
                        {
                          "period": "202506..202506",
                          "total": "70.0",
                          "financial_accounts": [
                            {
                              "financial_account_id": "502689287699957170",
                              "name": "ING NL28INGB0000000001",
                              "type": "BankAccount",
                              "balance": "70.0"
                            }
                          ]
                        }
                      ]
                    }
                  },
                  "ReturnsTheBalanceOfEachFinancialAccountAtTheEndOfThePeriod": {
                    "summary": "Returns the balance of each financial account at the end of the period",
                    "value": {
                      "total": "70.0",
                      "financial_accounts": [
                        {
                          "financial_account_id": "502689287737705916",
                          "name": "ING NL28INGB0000000001",
                          "type": "BankAccount",
                          "balance": "70.0"
                        }
                      ]
                    }
                  },
                  "LeavesOutFinancialAccountsWithoutABalanceInThePeriod": {
                    "summary": "Leaves out financial accounts without a balance in the period",
                    "value": {
                      "total": "70.0",
                      "financial_accounts": [
                        {
                          "financial_account_id": "502689287774406086",
                          "name": "ING NL28INGB0000000001",
                          "type": "BankAccount",
                          "balance": "70.0"
                        }
                      ]
                    }
                  },
                  "ReturnsSuccessForFullPeriod": {
                    "summary": "Returns success for full period",
                    "value": {
                      "total": "70.0",
                      "financial_accounts": [
                        {
                          "financial_account_id": "502689287825786322",
                          "name": "ING NL28INGB0000000001",
                          "type": "BankAccount",
                          "balance": "70.0"
                        }
                      ]
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "Bad request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/symbolic_error"
                },
                "examples": {
                  "ReturnsErrorWhenPeriodExceedsLimit": {
                    "summary": "Returns error when period exceeds limit",
                    "value": {
                      "error": "Period cannot exceed 12 months"
                    }
                  },
                  "ReturnsErrorForInvalidPeriodFormat": {
                    "summary": "Returns error for invalid period format",
                    "value": {
                      "error": "Period is invalid"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Unauthorized",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/symbolic_error"
                },
                "examples": {
                  "Returns401WhenUserLacksRequiredPermissions": {
                    "summary": "Returns 401 when user lacks required permissions",
                    "value": {
                      "error": "No access to bank"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "Too many requests - rate limit exceeded",
            "content": {
              "application/json": {
                "schema": {
                  "type": "string",
                  "example": "Retry later"
                },
                "examples": {
                  "Returns429WhenExceedingTheRateLimit": {
                    "summary": "Returns 429 when exceeding the rate limit",
                    "value": "Retry later"
                  }
                }
              }
            },
            "headers": {
              "RateLimit-Limit": {
                "description": "The rate limit ceiling for that given request",
                "schema": {
                  "type": "integer",
                  "example": 150
                }
              },
              "RateLimit-Remaining": {
                "description": "The number of requests left for the time window",
                "schema": {
                  "type": "integer",
                  "example": 149
                }
              },
              "RateLimit-Reset": {
                "description": "The time at which the current rate limit window resets in UTC epoch seconds",
                "schema": {
                  "type": "integer",
                  "example": 1609459200
                }
              },
              "Retry-After": {
                "description": "The time at which the current rate limit window resets in UTC epoch seconds",
                "schema": {
                  "type": "integer",
                  "example": 1609459200
                }
              }
            }
          }
        },
        "operationId": "get_administration_id_reports_bank_balance"
      }
    },
    "/{administration_id}/reports/cash_flow{format}": {
      "get": {
        "summary": "Cash flow report",
        "description": "Get the cash flow report for the administration showing cash received and cash paid during the specified period.\n\nThe fields at the top level always cover the whole `period`: `opening_balance` is the balance at its start and `closing_balance` the balance at its end. With `granularity`, `periods` gives the same fields per month, quarter or year. Within a period, a section only lists the ledger accounts with cash received or paid in that period.\n\n### Required scope(s)\n `bank`",
        "tags": [
          "Reports"
        ],
        "security": [
          {
            "bearerAuth": [
              "bank"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/administration_id"
          },
          {
            "$ref": "#/components/parameters/format"
          },
          {
            "$ref": "#/components/parameters/period"
          },
          {
            "$ref": "#/components/parameters/granularity"
          },
          {
            "name": "financial_account_id",
            "in": "query",
            "required": false,
            "description": "Filter the cash flow report by a specific financial account",
            "schema": {
              "$ref": "#/components/schemas/identifier"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "A cash flow report",
            "content": {
              "application/json": {
                "schema": {
                  "allOf": [
                    {
                      "$ref": "#/components/schemas/cash_flow_amounts"
                    },
                    {
                      "type": "object",
                      "properties": {
                        "periods": {
                          "type": "array",
                          "description": "Only present when `granularity` is given. One item for each month, quarter or year in `period`, oldest first.",
                          "items": {
                            "allOf": [
                              {
                                "type": "object",
                                "required": [
                                  "period"
                                ],
                                "properties": {
                                  "period": {
                                    "type": "string",
                                    "description": "The period of this item, in the same format as the `period` parameter (e.g. `202501..202503`)."
                                  }
                                }
                              },
                              {
                                "$ref": "#/components/schemas/cash_flow_amounts"
                              }
                            ]
                          }
                        }
                      }
                    }
                  ]
                },
                "examples": {
                  "ReturnsACashFlowReport": {
                    "summary": "Returns a cash flow report",
                    "value": {
                      "cash_received_by_ledger_account": {
                        "ledger_accounts": [
                          {
                            "ledger_account_id": "502689207958898180",
                            "value": "100.0"
                          }
                        ]
                      },
                      "cash_paid_by_ledger_account": {
                        "ledger_accounts": [
                          {
                            "ledger_account_id": "502689207979869709",
                            "value": "-50.0"
                          }
                        ]
                      },
                      "opening_balance": "0",
                      "closing_balance": "50.0"
                    }
                  },
                  "SplitsTheCashFlowReportIntoPeriodsByGranularity": {
                    "summary": "Splits the cash flow report into periods by granularity",
                    "value": {
                      "cash_received_by_ledger_account": {
                        "ledger_accounts": [
                          {
                            "ledger_account_id": "502689208053270043",
                            "value": "130.0"
                          }
                        ]
                      },
                      "cash_paid_by_ledger_account": {
                        "ledger_accounts": [
                          {
                            "ledger_account_id": "502689208071095844",
                            "value": "-50.0"
                          }
                        ]
                      },
                      "opening_balance": "0",
                      "closing_balance": "80.0",
                      "periods": [
                        {
                          "period": "202505..202505",
                          "cash_received_by_ledger_account": {
                            "ledger_accounts": [
                              {
                                "ledger_account_id": "502689208053270043",
                                "value": "30.0"
                              }
                            ]
                          },
                          "cash_paid_by_ledger_account": {
                            "ledger_accounts": []
                          },
                          "opening_balance": "0.0",
                          "closing_balance": "30.0"
                        },
                        {
                          "period": "202506..202506",
                          "cash_received_by_ledger_account": {
                            "ledger_accounts": [
                              {
                                "ledger_account_id": "502689208053270043",
                                "value": "100.0"
                              }
                            ]
                          },
                          "cash_paid_by_ledger_account": {
                            "ledger_accounts": [
                              {
                                "ledger_account_id": "502689208071095844",
                                "value": "-50.0"
                              }
                            ]
                          },
                          "opening_balance": "30.0",
                          "closing_balance": "80.0"
                        }
                      ]
                    }
                  },
                  "ReturnsSuccessForFullPeriod": {
                    "summary": "Returns success for full period",
                    "value": {
                      "cash_received_by_ledger_account": {
                        "ledger_accounts": [
                          {
                            "ledger_account_id": "502689208282908264",
                            "value": "100.0"
                          }
                        ]
                      },
                      "cash_paid_by_ledger_account": {
                        "ledger_accounts": [
                          {
                            "ledger_account_id": "502689208296539761",
                            "value": "-50.0"
                          }
                        ]
                      },
                      "opening_balance": "0",
                      "closing_balance": "50.0"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "Bad request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/symbolic_error"
                },
                "examples": {
                  "ReturnsErrorForInvalidPeriodFormat": {
                    "summary": "Returns error for invalid period format",
                    "value": {
                      "error": "Period is invalid"
                    }
                  },
                  "ReturnsErrorWhenPeriodExceedsLimit": {
                    "summary": "Returns error when period exceeds limit",
                    "value": {
                      "error": "Period cannot exceed 12 months"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Unauthorized",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/symbolic_error"
                },
                "examples": {
                  "Returns401WhenUserLacksRequiredPermissions": {
                    "summary": "Returns 401 when user lacks required permissions",
                    "value": {
                      "error": "No access to bank"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "Too many requests - rate limit exceeded",
            "content": {
              "application/json": {
                "schema": {
                  "type": "string",
                  "example": "Retry later"
                },
                "examples": {
                  "Returns429WhenExceedingTheRateLimit": {
                    "summary": "Returns 429 when exceeding the rate limit",
                    "value": "Retry later"
                  }
                }
              }
            },
            "headers": {
              "RateLimit-Limit": {
                "description": "The rate limit ceiling for that given request",
                "schema": {
                  "type": "integer",
                  "example": 150
                }
              },
              "RateLimit-Remaining": {
                "description": "The number of requests left for the time window",
                "schema": {
                  "type": "integer",
                  "example": 149
                }
              },
              "RateLimit-Reset": {
                "description": "The time at which the current rate limit window resets in UTC epoch seconds",
                "schema": {
                  "type": "integer",
                  "example": 1609459200
                }
              },
              "Retry-After": {
                "description": "The time at which the current rate limit window resets in UTC epoch seconds",
                "schema": {
                  "type": "integer",
                  "example": 1609459200
                }
              }
            }
          }
        },
        "operationId": "get_administration_id_reports_cash_flow"
      }
    },
    "/{administration_id}/reports/creditors{format}": {
      "get": {
        "summary": "Creditors report",
        "description": "Returns the balance of each creditor at the end of the specified period. The start of the period does not change the result.\n\nWith `granularity`, `periods` also gives the balance of each creditor at the end of every month, quarter or year in the period.\n\n### Required scope(s)\n `documents`",
        "tags": [
          "Reports"
        ],
        "security": [
          {
            "bearerAuth": [
              "documents"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/administration_id"
          },
          {
            "$ref": "#/components/parameters/format"
          },
          {
            "$ref": "#/components/parameters/period"
          },
          {
            "$ref": "#/components/parameters/granularity"
          },
          {
            "$ref": "#/components/parameters/page"
          },
          {
            "$ref": "#/components/parameters/per_page"
          }
        ],
        "responses": {
          "200": {
            "description": "Successful response",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "creditors": {
                      "type": "array",
                      "items": {
                        "$ref": "#/components/schemas/creditors_report_item"
                      }
                    },
                    "periods": {
                      "type": "array",
                      "description": "Only present when `granularity` is given. One item for each month, quarter or year in `period`, oldest first.",
                      "items": {
                        "type": "object",
                        "required": [
                          "period",
                          "creditors"
                        ],
                        "properties": {
                          "period": {
                            "type": "string",
                            "description": "The period of this item, in the same format as the `period` parameter (e.g. `202501..202503`)."
                          },
                          "creditors": {
                            "type": "array",
                            "items": {
                              "$ref": "#/components/schemas/creditors_report_item"
                            }
                          }
                        }
                      }
                    }
                  }
                },
                "examples": {
                  "ReturnsACreditorsReport": {
                    "summary": "Returns a creditors report",
                    "value": {
                      "creditors": [
                        {
                          "contact_id": "502689203109233670",
                          "amount": "200.0"
                        }
                      ]
                    }
                  },
                  "FiltersTheRepordOnASpecificPeriod": {
                    "summary": "Filters the repord on a specific period",
                    "value": {
                      "creditors": [
                        {
                          "contact_id": "502689203146982418",
                          "amount": "100.0"
                        }
                      ]
                    }
                  },
                  "ReturnsACreditorsReportIncludingBookingsWithoutAContact": {
                    "summary": "Returns a creditors report including bookings without a contact",
                    "value": {
                      "creditors": [
                        {
                          "contact_id": "502689203180536856",
                          "amount": "200.0"
                        },
                        {
                          "contact_id": null,
                          "amount": "50.0"
                        }
                      ]
                    }
                  },
                  "ReturnsACreditorsReportWithMultipleContacts": {
                    "summary": "Returns a creditors report with multiple contacts",
                    "value": {
                      "creditors": [
                        {
                          "contact_id": "502689203217237026",
                          "amount": "200.0"
                        },
                        {
                          "contact_id": "502689203225625640",
                          "amount": "100.0"
                        }
                      ]
                    }
                  },
                  "ReturnsTheSecondPageOfTheReport": {
                    "summary": "Returns the second page of the report",
                    "value": {
                      "creditors": [
                        {
                          "contact_id": "502689203262325812",
                          "amount": "100.0"
                        }
                      ]
                    }
                  },
                  "ReturnsTheBalanceAtTheEndOfEachPeriodByGranularity": {
                    "summary": "Returns the balance at the end of each period by granularity",
                    "value": {
                      "creditors": [
                        {
                          "contact_id": "502689203291685946",
                          "amount": "250.0"
                        }
                      ],
                      "periods": [
                        {
                          "period": "202410..202412",
                          "creditors": [
                            {
                              "contact_id": "502689203291685946",
                              "amount": "0.0"
                            }
                          ]
                        },
                        {
                          "period": "202501..202503",
                          "creditors": [
                            {
                              "contact_id": "502689203291685946",
                              "amount": "250.0"
                            }
                          ]
                        }
                      ]
                    }
                  },
                  "ReturnsAnEmptyReportIfNoCreditorsInThePeriodAreFound": {
                    "summary": "Returns an empty report if no creditors in the period are found",
                    "value": {
                      "creditors": []
                    }
                  },
                  "ReturnsSuccessForFullPeriod": {
                    "summary": "Returns success for full period",
                    "value": {
                      "creditors": [
                        {
                          "contact_id": "502689203457360988",
                          "amount": "200.0"
                        }
                      ]
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "Bad request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/symbolic_error"
                },
                "examples": {
                  "ReturnsErrorWhenPeriodExceedsLimit": {
                    "summary": "Returns error when period exceeds limit",
                    "value": {
                      "error": "Period cannot exceed 12 months"
                    }
                  },
                  "ReturnsErrorForInvalidPeriodFormat": {
                    "summary": "Returns error for invalid period format",
                    "value": {
                      "error": "Period is invalid"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Unauthorized",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/symbolic_error"
                },
                "examples": {
                  "Returns401WhenUserLacksRequiredPermissions": {
                    "summary": "Returns 401 when user lacks required permissions",
                    "value": {
                      "error": "No access to documents"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "Too many requests - rate limit exceeded",
            "content": {
              "application/json": {
                "schema": {
                  "type": "string",
                  "example": "Retry later"
                },
                "examples": {
                  "Returns429WhenExceedingTheRateLimit": {
                    "summary": "Returns 429 when exceeding the rate limit",
                    "value": "Retry later"
                  }
                }
              }
            },
            "headers": {
              "RateLimit-Limit": {
                "description": "The rate limit ceiling for that given request",
                "schema": {
                  "type": "integer",
                  "example": 150
                }
              },
              "RateLimit-Remaining": {
                "description": "The number of requests left for the time window",
                "schema": {
                  "type": "integer",
                  "example": 149
                }
              },
              "RateLimit-Reset": {
                "description": "The time at which the current rate limit window resets in UTC epoch seconds",
                "schema": {
                  "type": "integer",
                  "example": 1609459200
                }
              },
              "Retry-After": {
                "description": "The time at which the current rate limit window resets in UTC epoch seconds",
                "schema": {
                  "type": "integer",
                  "example": 1609459200
                }
              }
            }
          }
        },
        "operationId": "get_administration_id_reports_creditors"
      }
    },
    "/{administration_id}/reports/creditors_aging{format}": {
      "get": {
        "summary": "Creditors aging report",
        "description": "Returns a creditors aging report for the specified administration.\n\n### Required scope(s)\n `documents`",
        "tags": [
          "Reports"
        ],
        "security": [
          {
            "bearerAuth": [
              "documents"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/administration_id"
          },
          {
            "$ref": "#/components/parameters/format"
          },
          {
            "$ref": "#/components/parameters/period_until"
          },
          {
            "$ref": "#/components/parameters/page"
          },
          {
            "$ref": "#/components/parameters/per_page"
          }
        ],
        "responses": {
          "200": {
            "description": "Successful response",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "creditors": {
                      "type": "array",
                      "items": {
                        "$ref": "#/components/schemas/aging_report_item"
                      }
                    }
                  }
                },
                "examples": {
                  "ReturnsACreditorsAgingReportWithMultipleContacts": {
                    "summary": "Returns a creditors aging report with multiple contacts",
                    "value": {
                      "creditors": [
                        {
                          "contact_id": "502689183890933112",
                          "amount": "600.0",
                          "aging_buckets": [
                            {
                              "name": "0 - 30 dagen",
                              "amount": "100.0"
                            },
                            {
                              "name": "30 - 60 dagen",
                              "amount": "200.0"
                            },
                            {
                              "name": "Ouder",
                              "amount": "300.0"
                            },
                            {
                              "name": "Totaal",
                              "amount": "600.0"
                            }
                          ]
                        },
                        {
                          "contact_id": "502689183908758918",
                          "amount": "150.0",
                          "aging_buckets": [
                            {
                              "name": "0 - 30 dagen",
                              "amount": "150.0"
                            },
                            {
                              "name": "30 - 60 dagen",
                              "amount": "0"
                            },
                            {
                              "name": "Ouder",
                              "amount": "0.0"
                            },
                            {
                              "name": "Totaal",
                              "amount": "150.0"
                            }
                          ]
                        }
                      ]
                    }
                  },
                  "ReturnsTheSecondPageOfTheReport": {
                    "summary": "Returns the second page of the report",
                    "value": {
                      "creditors": [
                        {
                          "contact_id": "502689183959090586",
                          "amount": "150.0",
                          "aging_buckets": [
                            {
                              "name": "0 - 30 dagen",
                              "amount": "150.0"
                            },
                            {
                              "name": "30 - 60 dagen",
                              "amount": "0"
                            },
                            {
                              "name": "Ouder",
                              "amount": "0.0"
                            },
                            {
                              "name": "Totaal",
                              "amount": "150.0"
                            }
                          ]
                        }
                      ]
                    }
                  },
                  "ReturnsACreditorsAgingReport": {
                    "summary": "Returns a creditors aging report",
                    "value": {
                      "creditors": [
                        {
                          "contact_id": "502689183995790752",
                          "amount": "600.0",
                          "aging_buckets": [
                            {
                              "name": "0 - 30 dagen",
                              "amount": "100.0"
                            },
                            {
                              "name": "30 - 60 dagen",
                              "amount": "200.0"
                            },
                            {
                              "name": "Ouder",
                              "amount": "300.0"
                            },
                            {
                              "name": "Totaal",
                              "amount": "600.0"
                            }
                          ]
                        }
                      ]
                    }
                  },
                  "ReturnsAnEmptyReportIfNoCreditorsAreFound": {
                    "summary": "Returns an empty report if no creditors are found",
                    "value": {
                      "creditors": []
                    }
                  },
                  "ExcludesContactsWithZeroBalance": {
                    "summary": "Excludes contacts with zero balance",
                    "value": {
                      "creditors": [
                        {
                          "contact_id": "502689184081774021",
                          "amount": "600.0",
                          "aging_buckets": [
                            {
                              "name": "0 - 30 dagen",
                              "amount": "100.0"
                            },
                            {
                              "name": "30 - 60 dagen",
                              "amount": "200.0"
                            },
                            {
                              "name": "Ouder",
                              "amount": "300.0"
                            },
                            {
                              "name": "Totaal",
                              "amount": "600.0"
                            }
                          ]
                        }
                      ]
                    }
                  },
                  "ReturnsACreditorsAgingReportWithAPeriod": {
                    "summary": "Returns a creditors aging report with a period",
                    "value": {
                      "creditors": [
                        {
                          "contact_id": "502689184149931485",
                          "amount": "500.0",
                          "aging_buckets": [
                            {
                              "name": "0 - 30 dagen",
                              "amount": "200.0"
                            },
                            {
                              "name": "30 - 60 dagen",
                              "amount": "0"
                            },
                            {
                              "name": "Ouder",
                              "amount": "300.0"
                            },
                            {
                              "name": "Totaal",
                              "amount": "500.0"
                            }
                          ]
                        }
                      ]
                    }
                  },
                  "RequestsWithADifferentPage": {
                    "summary": "Requests with a different page",
                    "value": {
                      "creditors": []
                    }
                  },
                  "RequestsWithAPageSizeLargerThanDefault": {
                    "summary": "Requests with a page size larger than default",
                    "value": {
                      "creditors": [
                        {
                          "contact_id": "502689184507495985",
                          "amount": "600.0",
                          "aging_buckets": [
                            {
                              "name": "0 - 30 dagen",
                              "amount": "100.0"
                            },
                            {
                              "name": "30 - 60 dagen",
                              "amount": "200.0"
                            },
                            {
                              "name": "Ouder",
                              "amount": "300.0"
                            },
                            {
                              "name": "Totaal",
                              "amount": "600.0"
                            }
                          ]
                        }
                      ]
                    }
                  },
                  "RequestsWithAPageSizeSmallerThanDefault": {
                    "summary": "Requests with a page size smaller than default",
                    "value": {
                      "creditors": [
                        {
                          "contact_id": "502689184594527821",
                          "amount": "600.0",
                          "aging_buckets": [
                            {
                              "name": "0 - 30 dagen",
                              "amount": "100.0"
                            },
                            {
                              "name": "30 - 60 dagen",
                              "amount": "200.0"
                            },
                            {
                              "name": "Ouder",
                              "amount": "300.0"
                            },
                            {
                              "name": "Totaal",
                              "amount": "600.0"
                            }
                          ]
                        }
                      ]
                    }
                  },
                  "FetchesWithoutPageAndPerPageAttributesUsingDefaultValues": {
                    "summary": "Fetches without page and per page attributes, using default values",
                    "value": {
                      "creditors": [
                        {
                          "contact_id": "502689184637519451",
                          "amount": "600.0",
                          "aging_buckets": [
                            {
                              "name": "0 - 30 dagen",
                              "amount": "100.0"
                            },
                            {
                              "name": "30 - 60 dagen",
                              "amount": "200.0"
                            },
                            {
                              "name": "Ouder",
                              "amount": "300.0"
                            },
                            {
                              "name": "Totaal",
                              "amount": "600.0"
                            }
                          ]
                        }
                      ]
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "Bad request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/symbolic_error"
                },
                "examples": {
                  "Returns400WhenPerPageIsInvalid": {
                    "summary": "Returns 400 when per page is invalid",
                    "value": {
                      "error": "per_page is invalid, per_page does not have a valid value"
                    }
                  },
                  "Returns400WhenPerPageExceedsMaximum": {
                    "summary": "Returns 400 when per page exceeds maximum",
                    "value": {
                      "error": "per_page does not have a valid value"
                    }
                  },
                  "Returns400WhenPageIsInvalid": {
                    "summary": "Returns 400 when page is invalid",
                    "value": {
                      "error": "page is invalid"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Unauthorized",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/symbolic_error"
                },
                "examples": {
                  "Returns401WhenUserLacksRequiredPermissions": {
                    "summary": "Returns 401 when user lacks required permissions",
                    "value": {
                      "error": "No access to documents"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "Too many requests - rate limit exceeded",
            "content": {
              "application/json": {
                "schema": {
                  "type": "string",
                  "example": "Retry later"
                },
                "examples": {
                  "Returns429WhenExceedingTheRateLimit": {
                    "summary": "Returns 429 when exceeding the rate limit",
                    "value": "Retry later"
                  }
                }
              }
            },
            "headers": {
              "RateLimit-Limit": {
                "description": "The rate limit ceiling for that given request",
                "schema": {
                  "type": "integer",
                  "example": 150
                }
              },
              "RateLimit-Remaining": {
                "description": "The number of requests left for the time window",
                "schema": {
                  "type": "integer",
                  "example": 149
                }
              },
              "RateLimit-Reset": {
                "description": "The time at which the current rate limit window resets in UTC epoch seconds",
                "schema": {
                  "type": "integer",
                  "example": 1609459200
                }
              },
              "Retry-After": {
                "description": "The time at which the current rate limit window resets in UTC epoch seconds",
                "schema": {
                  "type": "integer",
                  "example": 1609459200
                }
              }
            }
          }
        },
        "operationId": "get_administration_id_reports_creditors_aging"
      }
    },
    "/{administration_id}/reports/debtors{format}": {
      "get": {
        "summary": "Debtors report",
        "description": "Returns the balance of each debtor at the end of the specified period. The start of the period does not change the result.\n\nWith `granularity`, `periods` also gives the balance of each debtor at the end of every month, quarter or year in the period.\n\n### Required scope(s)\n `sales_invoices`",
        "tags": [
          "Reports"
        ],
        "security": [
          {
            "bearerAuth": [
              "sales_invoices"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/administration_id"
          },
          {
            "$ref": "#/components/parameters/format"
          },
          {
            "$ref": "#/components/parameters/period"
          },
          {
            "$ref": "#/components/parameters/granularity"
          },
          {
            "$ref": "#/components/parameters/page"
          },
          {
            "$ref": "#/components/parameters/per_page"
          }
        ],
        "responses": {
          "200": {
            "description": "Successful response",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "debtors": {
                      "type": "array",
                      "items": {
                        "$ref": "#/components/schemas/debtors_report_item"
                      }
                    },
                    "periods": {
                      "type": "array",
                      "description": "Only present when `granularity` is given. One item for each month, quarter or year in `period`, oldest first.",
                      "items": {
                        "type": "object",
                        "required": [
                          "period",
                          "debtors"
                        ],
                        "properties": {
                          "period": {
                            "type": "string",
                            "description": "The period of this item, in the same format as the `period` parameter (e.g. `202501..202503`)."
                          },
                          "debtors": {
                            "type": "array",
                            "items": {
                              "$ref": "#/components/schemas/debtors_report_item"
                            }
                          }
                        }
                      }
                    }
                  }
                },
                "examples": {
                  "ReturnsTheSecondPageOfTheReport": {
                    "summary": "Returns the second page of the report",
                    "value": {
                      "debtors": [
                        {
                          "contact_id": "502689267721438840",
                          "amount": "100.0"
                        }
                      ]
                    }
                  },
                  "ReturnsTheBalanceAtTheEndOfEachPeriodByGranularity": {
                    "summary": "Returns the balance at the end of each period by granularity",
                    "value": {
                      "debtors": [
                        {
                          "contact_id": "502689267758139006",
                          "amount": "250.0"
                        }
                      ],
                      "periods": [
                        {
                          "period": "202410..202412",
                          "debtors": [
                            {
                              "contact_id": "502689267758139006",
                              "amount": "0.0"
                            }
                          ]
                        },
                        {
                          "period": "202501..202503",
                          "debtors": [
                            {
                              "contact_id": "502689267758139006",
                              "amount": "250.0"
                            }
                          ]
                        }
                      ]
                    }
                  },
                  "ReturnsAnEmptyReportIfNoDebtorsInThePeriodAreFound": {
                    "summary": "Returns an empty report if no debtors in the period are found",
                    "value": {
                      "debtors": []
                    }
                  },
                  "ReturnsADebtorsReportIncludingBookingsWithoutAContact": {
                    "summary": "Returns a debtors report including bookings without a contact",
                    "value": {
                      "debtors": [
                        {
                          "contact_id": "502689267846219406",
                          "amount": "200.0"
                        },
                        {
                          "contact_id": null,
                          "amount": "50.0"
                        }
                      ]
                    }
                  },
                  "ReturnsADebtorsReportWithMultipleContacts": {
                    "summary": "Returns a debtors report with multiple contacts",
                    "value": {
                      "debtors": [
                        {
                          "contact_id": "502689267881871000",
                          "amount": "200.0"
                        },
                        {
                          "contact_id": "502689267899696798",
                          "amount": "100.0"
                        }
                      ]
                    }
                  },
                  "ReturnsADebtorsReport": {
                    "summary": "Returns a debtors report",
                    "value": {
                      "debtors": [
                        {
                          "contact_id": "502689267938494116",
                          "amount": "200.0"
                        }
                      ]
                    }
                  },
                  "FiltersTheRepordOnASpecificPeriod": {
                    "summary": "Filters the repord on a specific period",
                    "value": {
                      "debtors": [
                        {
                          "contact_id": "502689267982534320",
                          "amount": "100.0"
                        }
                      ]
                    }
                  },
                  "ReturnsSuccessForFullPeriod": {
                    "summary": "Returns success for full period",
                    "value": {
                      "debtors": [
                        {
                          "contact_id": "502689268010845878",
                          "amount": "200.0"
                        }
                      ]
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "Bad request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/symbolic_error"
                },
                "examples": {
                  "ReturnsErrorWhenPeriodExceedsLimit": {
                    "summary": "Returns error when period exceeds limit",
                    "value": {
                      "error": "Period cannot exceed 12 months"
                    }
                  },
                  "ReturnsErrorForInvalidPeriodFormat": {
                    "summary": "Returns error for invalid period format",
                    "value": {
                      "error": "Period is invalid"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Unauthorized",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/symbolic_error"
                },
                "examples": {
                  "Returns401WhenUserLacksRequiredPermissions": {
                    "summary": "Returns 401 when user lacks required permissions",
                    "value": {
                      "error": "No access to sales_invoices"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "Too many requests - rate limit exceeded",
            "content": {
              "application/json": {
                "schema": {
                  "type": "string",
                  "example": "Retry later"
                },
                "examples": {
                  "Returns429WhenExceedingTheRateLimit": {
                    "summary": "Returns 429 when exceeding the rate limit",
                    "value": "Retry later"
                  }
                }
              }
            },
            "headers": {
              "RateLimit-Limit": {
                "description": "The rate limit ceiling for that given request",
                "schema": {
                  "type": "integer",
                  "example": 150
                }
              },
              "RateLimit-Remaining": {
                "description": "The number of requests left for the time window",
                "schema": {
                  "type": "integer",
                  "example": 149
                }
              },
              "RateLimit-Reset": {
                "description": "The time at which the current rate limit window resets in UTC epoch seconds",
                "schema": {
                  "type": "integer",
                  "example": 1609459200
                }
              },
              "Retry-After": {
                "description": "The time at which the current rate limit window resets in UTC epoch seconds",
                "schema": {
                  "type": "integer",
                  "example": 1609459200
                }
              }
            }
          }
        },
        "operationId": "get_administration_id_reports_debtors"
      }
    },
    "/{administration_id}/reports/debtors_aging{format}": {
      "get": {
        "summary": "Debtors aging report",
        "description": "Returns a debtors aging report for the specified administration.\n\n### Required scope(s)\n `sales_invoices`",
        "tags": [
          "Reports"
        ],
        "security": [
          {
            "bearerAuth": [
              "sales_invoices"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/administration_id"
          },
          {
            "$ref": "#/components/parameters/format"
          },
          {
            "$ref": "#/components/parameters/period_until"
          },
          {
            "$ref": "#/components/parameters/page"
          },
          {
            "$ref": "#/components/parameters/per_page"
          }
        ],
        "responses": {
          "200": {
            "description": "Successful response",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "debtors": {
                      "type": "array",
                      "items": {
                        "$ref": "#/components/schemas/aging_report_item"
                      }
                    }
                  }
                },
                "examples": {
                  "ReturnsADebtorsAgingReportWithAPeriod": {
                    "summary": "Returns a debtors aging report with a period",
                    "value": {
                      "debtors": [
                        {
                          "contact_id": "502689282537817441",
                          "amount": "500.0",
                          "aging_buckets": [
                            {
                              "name": "0 - 30 dagen",
                              "amount": "200.0"
                            },
                            {
                              "name": "30 - 60 dagen",
                              "amount": "0"
                            },
                            {
                              "name": "Ouder",
                              "amount": "300.0"
                            },
                            {
                              "name": "Totaal",
                              "amount": "500.0"
                            }
                          ]
                        }
                      ]
                    }
                  },
                  "ReturnsADebtorsAgingReport": {
                    "summary": "Returns a debtors aging report",
                    "value": {
                      "debtors": [
                        {
                          "contact_id": "502689282647917935",
                          "amount": "600.0",
                          "aging_buckets": [
                            {
                              "name": "0 - 30 dagen",
                              "amount": "100.0"
                            },
                            {
                              "name": "30 - 60 dagen",
                              "amount": "200.0"
                            },
                            {
                              "name": "Ouder",
                              "amount": "300.0"
                            },
                            {
                              "name": "Totaal",
                              "amount": "600.0"
                            }
                          ]
                        }
                      ]
                    }
                  },
                  "ReturnsAnEmptyReportIfNoDebtorsAreFound": {
                    "summary": "Returns an empty report if no debtors are found",
                    "value": {
                      "debtors": []
                    }
                  },
                  "ReturnsADebtorsAgingReportWithMultipleContacts": {
                    "summary": "Returns a debtors aging report with multiple contacts",
                    "value": {
                      "debtors": [
                        {
                          "contact_id": "502689282877556130",
                          "amount": "600.0",
                          "aging_buckets": [
                            {
                              "name": "0 - 30 dagen",
                              "amount": "100.0"
                            },
                            {
                              "name": "30 - 60 dagen",
                              "amount": "200.0"
                            },
                            {
                              "name": "Ouder",
                              "amount": "300.0"
                            },
                            {
                              "name": "Totaal",
                              "amount": "600.0"
                            }
                          ]
                        },
                        {
                          "contact_id": "502689282897479088",
                          "amount": "150.0",
                          "aging_buckets": [
                            {
                              "name": "0 - 30 dagen",
                              "amount": "150.0"
                            },
                            {
                              "name": "30 - 60 dagen",
                              "amount": "0"
                            },
                            {
                              "name": "Ouder",
                              "amount": "0.0"
                            },
                            {
                              "name": "Totaal",
                              "amount": "150.0"
                            }
                          ]
                        }
                      ]
                    }
                  },
                  "ExcludesContactsWithZeroBalance": {
                    "summary": "Excludes contacts with zero balance",
                    "value": {
                      "debtors": [
                        {
                          "contact_id": "502689282961442230",
                          "amount": "600.0",
                          "aging_buckets": [
                            {
                              "name": "0 - 30 dagen",
                              "amount": "100.0"
                            },
                            {
                              "name": "30 - 60 dagen",
                              "amount": "200.0"
                            },
                            {
                              "name": "Ouder",
                              "amount": "300.0"
                            },
                            {
                              "name": "Totaal",
                              "amount": "600.0"
                            }
                          ]
                        }
                      ]
                    }
                  },
                  "ReturnsTheSecondPageOfTheReport": {
                    "summary": "Returns the second page of the report",
                    "value": {
                      "debtors": [
                        {
                          "contact_id": "502689283054765532",
                          "amount": "150.0",
                          "aging_buckets": [
                            {
                              "name": "0 - 30 dagen",
                              "amount": "150.0"
                            },
                            {
                              "name": "30 - 60 dagen",
                              "amount": "0"
                            },
                            {
                              "name": "Ouder",
                              "amount": "0.0"
                            },
                            {
                              "name": "Totaal",
                              "amount": "150.0"
                            }
                          ]
                        }
                      ]
                    }
                  },
                  "RequestsWithADifferentPage": {
                    "summary": "Requests with a different page",
                    "value": {
                      "debtors": []
                    }
                  },
                  "FetchesWithoutPageAndPerPageAttributesUsingDefaultValues": {
                    "summary": "Fetches without page and per page attributes, using default values",
                    "value": {
                      "debtors": [
                        {
                          "contact_id": "502689283249800716",
                          "amount": "600.0",
                          "aging_buckets": [
                            {
                              "name": "0 - 30 dagen",
                              "amount": "100.0"
                            },
                            {
                              "name": "30 - 60 dagen",
                              "amount": "200.0"
                            },
                            {
                              "name": "Ouder",
                              "amount": "300.0"
                            },
                            {
                              "name": "Totaal",
                              "amount": "600.0"
                            }
                          ]
                        }
                      ]
                    }
                  },
                  "RequestsWithAPageSizeSmallerThanDefault": {
                    "summary": "Requests with a page size smaller than default",
                    "value": {
                      "debtors": [
                        {
                          "contact_id": "502689283295938074",
                          "amount": "600.0",
                          "aging_buckets": [
                            {
                              "name": "0 - 30 dagen",
                              "amount": "100.0"
                            },
                            {
                              "name": "30 - 60 dagen",
                              "amount": "200.0"
                            },
                            {
                              "name": "Ouder",
                              "amount": "300.0"
                            },
                            {
                              "name": "Totaal",
                              "amount": "600.0"
                            }
                          ]
                        }
                      ]
                    }
                  },
                  "RequestsWithAPageSizeLargerThanDefault": {
                    "summary": "Requests with a page size larger than default",
                    "value": {
                      "debtors": [
                        {
                          "contact_id": "502689283505653316",
                          "amount": "600.0",
                          "aging_buckets": [
                            {
                              "name": "0 - 30 dagen",
                              "amount": "100.0"
                            },
                            {
                              "name": "30 - 60 dagen",
                              "amount": "200.0"
                            },
                            {
                              "name": "Ouder",
                              "amount": "300.0"
                            },
                            {
                              "name": "Totaal",
                              "amount": "600.0"
                            }
                          ]
                        }
                      ]
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "Bad request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/symbolic_error"
                },
                "examples": {
                  "Returns400WhenPageIsInvalid": {
                    "summary": "Returns 400 when page is invalid",
                    "value": {
                      "error": "page is invalid"
                    }
                  },
                  "Returns400WhenPerPageIsInvalid": {
                    "summary": "Returns 400 when per page is invalid",
                    "value": {
                      "error": "per_page is invalid, per_page does not have a valid value"
                    }
                  },
                  "Returns400WhenPerPageExceedsMaximum": {
                    "summary": "Returns 400 when per page exceeds maximum",
                    "value": {
                      "error": "per_page does not have a valid value"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Unauthorized",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/symbolic_error"
                },
                "examples": {
                  "Returns401WhenUserLacksRequiredPermissions": {
                    "summary": "Returns 401 when user lacks required permissions",
                    "value": {
                      "error": "No access to sales_invoices"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "Too many requests - rate limit exceeded",
            "content": {
              "application/json": {
                "schema": {
                  "type": "string",
                  "example": "Retry later"
                },
                "examples": {
                  "Returns429WhenExceedingTheRateLimit": {
                    "summary": "Returns 429 when exceeding the rate limit",
                    "value": "Retry later"
                  }
                }
              }
            },
            "headers": {
              "RateLimit-Limit": {
                "description": "The rate limit ceiling for that given request",
                "schema": {
                  "type": "integer",
                  "example": 150
                }
              },
              "RateLimit-Remaining": {
                "description": "The number of requests left for the time window",
                "schema": {
                  "type": "integer",
                  "example": 149
                }
              },
              "RateLimit-Reset": {
                "description": "The time at which the current rate limit window resets in UTC epoch seconds",
                "schema": {
                  "type": "integer",
                  "example": 1609459200
                }
              },
              "Retry-After": {
                "description": "The time at which the current rate limit window resets in UTC epoch seconds",
                "schema": {
                  "type": "integer",
                  "example": 1609459200
                }
              }
            }
          }
        },
        "operationId": "get_administration_id_reports_debtors_aging"
      }
    },
    "/{administration_id}/reports/expenses_by_contact{format}": {
      "get": {
        "summary": "Expenses by contact report",
        "description": "Returns a expenses by contact report for the specified administration.\n\nWith `granularity`, `periods` splits the amounts per month, quarter or year. Within a period, only the contacts on this page with bookings in that period are listed.\n\n### Required scope(s)\n `documents`",
        "tags": [
          "Reports"
        ],
        "security": [
          {
            "bearerAuth": [
              "documents"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/administration_id"
          },
          {
            "$ref": "#/components/parameters/format"
          },
          {
            "$ref": "#/components/parameters/period"
          },
          {
            "$ref": "#/components/parameters/granularity"
          },
          {
            "$ref": "#/components/parameters/page"
          },
          {
            "$ref": "#/components/parameters/per_page"
          }
        ],
        "responses": {
          "200": {
            "description": "Successful response",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "expenses_by_contact": {
                      "type": "array",
                      "items": {
                        "$ref": "#/components/schemas/contact_report_item"
                      }
                    },
                    "periods": {
                      "type": "array",
                      "description": "Only present when `granularity` is given. One item for each month, quarter or year in `period`, oldest first.",
                      "items": {
                        "type": "object",
                        "required": [
                          "period",
                          "expenses_by_contact"
                        ],
                        "properties": {
                          "period": {
                            "type": "string",
                            "description": "The period of this item, in the same format as the `period` parameter (e.g. `202501..202503`)."
                          },
                          "expenses_by_contact": {
                            "type": "array",
                            "items": {
                              "$ref": "#/components/schemas/contact_report_item"
                            }
                          }
                        }
                      }
                    }
                  }
                },
                "examples": {
                  "SplitsTheExpensesByContactReportIntoPeriodsByGranularity": {
                    "summary": "Splits the expenses by contact report into periods by granularity",
                    "value": {
                      "expenses_by_contact": [
                        {
                          "contact_id": "502689218718336041",
                          "amount": "30.0"
                        }
                      ],
                      "periods": [
                        {
                          "period": "202501..202501",
                          "expenses_by_contact": [
                            {
                              "contact_id": "502689218718336041",
                              "amount": "80.0"
                            }
                          ]
                        },
                        {
                          "period": "202502..202502",
                          "expenses_by_contact": [
                            {
                              "contact_id": "502689218718336041",
                              "amount": "-50.0"
                            }
                          ]
                        }
                      ]
                    }
                  },
                  "ReturnsAExpensesByContactReport": {
                    "summary": "Returns a expenses by contact report",
                    "value": {
                      "expenses_by_contact": [
                        {
                          "contact_id": "502689218786493492",
                          "amount": "30.0"
                        }
                      ]
                    }
                  },
                  "ReturnsSuccessForFullPeriod": {
                    "summary": "Returns success for full period",
                    "value": {
                      "expenses_by_contact": [
                        {
                          "contact_id": "502689218978382933",
                          "amount": "30.0"
                        }
                      ]
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "Bad request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/symbolic_error"
                },
                "examples": {
                  "ReturnsErrorForInvalidPeriodFormat": {
                    "summary": "Returns error for invalid period format",
                    "value": {
                      "error": "Period is invalid"
                    }
                  },
                  "ReturnsErrorWhenPeriodExceedsLimit": {
                    "summary": "Returns error when period exceeds limit",
                    "value": {
                      "error": "Period cannot exceed 12 months"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Unauthorized",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/symbolic_error"
                },
                "examples": {
                  "Returns401WhenUserLacksRequiredPermissions": {
                    "summary": "Returns 401 when user lacks required permissions",
                    "value": {
                      "error": "No access to documents"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "Too many requests - rate limit exceeded",
            "content": {
              "application/json": {
                "schema": {
                  "type": "string",
                  "example": "Retry later"
                },
                "examples": {
                  "Returns429WhenExceedingTheRateLimit": {
                    "summary": "Returns 429 when exceeding the rate limit",
                    "value": "Retry later"
                  }
                }
              }
            },
            "headers": {
              "RateLimit-Limit": {
                "description": "The rate limit ceiling for that given request",
                "schema": {
                  "type": "integer",
                  "example": 150
                }
              },
              "RateLimit-Remaining": {
                "description": "The number of requests left for the time window",
                "schema": {
                  "type": "integer",
                  "example": 149
                }
              },
              "RateLimit-Reset": {
                "description": "The time at which the current rate limit window resets in UTC epoch seconds",
                "schema": {
                  "type": "integer",
                  "example": 1609459200
                }
              },
              "Retry-After": {
                "description": "The time at which the current rate limit window resets in UTC epoch seconds",
                "schema": {
                  "type": "integer",
                  "example": 1609459200
                }
              }
            }
          }
        },
        "operationId": "get_administration_id_reports_expenses_by_contact"
      }
    },
    "/{administration_id}/reports/expenses_by_project{format}": {
      "get": {
        "summary": "Expenses by project report",
        "description": "Returns a expenses by project report for the specified administration.\n\nWith `granularity`, `periods` splits the amounts per month, quarter or year. Within a period, only the projects on this page with bookings in that period are listed.\n\n### Required scope(s)\n `documents`",
        "tags": [
          "Reports"
        ],
        "security": [
          {
            "bearerAuth": [
              "documents"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/administration_id"
          },
          {
            "$ref": "#/components/parameters/format"
          },
          {
            "$ref": "#/components/parameters/period"
          },
          {
            "$ref": "#/components/parameters/granularity"
          },
          {
            "$ref": "#/components/parameters/page"
          },
          {
            "$ref": "#/components/parameters/per_page"
          }
        ],
        "responses": {
          "200": {
            "description": "Successful response",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "expenses_by_project": {
                      "type": "array",
                      "items": {
                        "$ref": "#/components/schemas/project_report_item"
                      }
                    },
                    "periods": {
                      "type": "array",
                      "description": "Only present when `granularity` is given. One item for each month, quarter or year in `period`, oldest first.",
                      "items": {
                        "type": "object",
                        "required": [
                          "period",
                          "expenses_by_project"
                        ],
                        "properties": {
                          "period": {
                            "type": "string",
                            "description": "The period of this item, in the same format as the `period` parameter (e.g. `202501..202503`)."
                          },
                          "expenses_by_project": {
                            "type": "array",
                            "items": {
                              "$ref": "#/components/schemas/project_report_item"
                            }
                          }
                        }
                      }
                    }
                  }
                },
                "examples": {
                  "ReturnsAExpensesByProjectReport": {
                    "summary": "Returns a expenses by project report",
                    "value": {
                      "expenses_by_project": [
                        {
                          "project_id": null,
                          "amount": "100.0"
                        },
                        {
                          "project_id": "502689241837340425",
                          "amount": "30.0"
                        }
                      ]
                    }
                  },
                  "SplitsTheExpensesByProjectReportIntoPeriodsByGranularity": {
                    "summary": "Splits the expenses by project report into periods by granularity",
                    "value": {
                      "expenses_by_project": [
                        {
                          "project_id": null,
                          "amount": "100.0"
                        },
                        {
                          "project_id": "502689241885574936",
                          "amount": "30.0"
                        }
                      ],
                      "periods": [
                        {
                          "period": "202501..202501",
                          "expenses_by_project": [
                            {
                              "project_id": "502689241885574936",
                              "amount": "80.0"
                            }
                          ]
                        },
                        {
                          "period": "202502..202502",
                          "expenses_by_project": [
                            {
                              "project_id": null,
                              "amount": "100.0"
                            },
                            {
                              "project_id": "502689241885574936",
                              "amount": "-50.0"
                            }
                          ]
                        }
                      ]
                    }
                  },
                  "ReturnsSuccessForFullPeriod": {
                    "summary": "Returns success for full period",
                    "value": {
                      "expenses_by_project": [
                        {
                          "project_id": null,
                          "amount": "100.0"
                        },
                        {
                          "project_id": "502689242007209797",
                          "amount": "30.0"
                        }
                      ]
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "Bad request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/symbolic_error"
                },
                "examples": {
                  "ReturnsErrorForInvalidPeriodFormat": {
                    "summary": "Returns error for invalid period format",
                    "value": {
                      "error": "Period is invalid"
                    }
                  },
                  "ReturnsErrorWhenPeriodExceedsLimit": {
                    "summary": "Returns error when period exceeds limit",
                    "value": {
                      "error": "Period cannot exceed 12 months"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Unauthorized",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/symbolic_error"
                },
                "examples": {
                  "Returns401WhenUserLacksRequiredPermissions": {
                    "summary": "Returns 401 when user lacks required permissions",
                    "value": {
                      "error": "No access to documents"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "Too many requests - rate limit exceeded",
            "content": {
              "application/json": {
                "schema": {
                  "type": "string",
                  "example": "Retry later"
                },
                "examples": {
                  "Returns429WhenExceedingTheRateLimit": {
                    "summary": "Returns 429 when exceeding the rate limit",
                    "value": "Retry later"
                  }
                }
              }
            },
            "headers": {
              "RateLimit-Limit": {
                "description": "The rate limit ceiling for that given request",
                "schema": {
                  "type": "integer",
                  "example": 150
                }
              },
              "RateLimit-Remaining": {
                "description": "The number of requests left for the time window",
                "schema": {
                  "type": "integer",
                  "example": 149
                }
              },
              "RateLimit-Reset": {
                "description": "The time at which the current rate limit window resets in UTC epoch seconds",
                "schema": {
                  "type": "integer",
                  "example": 1609459200
                }
              },
              "Retry-After": {
                "description": "The time at which the current rate limit window resets in UTC epoch seconds",
                "schema": {
                  "type": "integer",
                  "example": 1609459200
                }
              }
            }
          }
        },
        "operationId": "get_administration_id_reports_expenses_by_project"
      }
    },
    "/{administration_id}/reports/export/auditfile{format}": {
      "post": {
        "summary": "Export auditfile",
        "description": "Queue the export of an auditfile (XAF XML format) for the specified year.\nThe auditfile will be added to your [downloads](../downloads) when ready.\n\nThe administration must not have any ledger accounts with missing or duplicate account IDs,\nand the specified year must contain journal entries.\n\n\n### Required scope(s)\n All of: `bank`, `documents`, `estimates`, `sales_invoices` and `settings`",
        "tags": [
          "Reports"
        ],
        "security": [
          {
            "bearerAuth": [
              "bank",
              "documents",
              "estimates",
              "sales_invoices",
              "settings"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/administration_id"
          },
          {
            "$ref": "#/components/parameters/format"
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/*": {
              "schema": {
                "type": "object",
                "required": [
                  "year"
                ],
                "properties": {
                  "year": {
                    "type": "string",
                    "description": "The year for which to generate the auditfile",
                    "example": "2024"
                  },
                  "version": {
                    "type": "string",
                    "description": "The XAF version of the auditfile",
                    "enum": [
                      "3.2",
                      "4.0"
                    ],
                    "default": "3.2"
                  }
                }
              },
              "examples": {
                "AcceptsVersion40Parameter": {
                  "summary": "Accepts version 4.0 parameter",
                  "value": {
                    "year": "2024",
                    "version": "4.0"
                  }
                },
                "Answers204WhenTheSameExportIsAlreadyBeingPrepared": {
                  "summary": "Answers 204 when the same export is already being prepared",
                  "value": {
                    "year": "2024"
                  }
                },
                "PreparesAnAuditfileExportAndReturns204": {
                  "summary": "Prepares an auditfile export and returns 204",
                  "value": {
                    "year": "2024"
                  }
                },
                "AcceptsVersion32Parameter": {
                  "summary": "Accepts version 3.2 parameter",
                  "value": {
                    "year": "2024",
                    "version": "3.2"
                  }
                },
                "UsesDefaultVersion32WhenVersionIsNotSpecified": {
                  "summary": "Uses default version 3.2 when version is not specified",
                  "value": {
                    "year": "2024"
                  }
                }
              }
            }
          }
        },
        "responses": {
          "204": {
            "$ref": "#/components/responses/204_no_content"
          },
          "400": {
            "description": "Bad request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/symbolic_error"
                },
                "examples": {
                  "Returns400WhenPeriodContainsNoJournalEntries": {
                    "summary": "Returns 400 when period contains no journal entries",
                    "value": {
                      "error": "Period contains no journal entries",
                      "symbolic": {
                        "period": "contains_no_journal_entries"
                      }
                    }
                  },
                  "Returns400ForInvalidVersion": {
                    "summary": "Returns 400 for invalid version",
                    "value": {
                      "error": "version does not have a valid value"
                    }
                  },
                  "Returns400WhenLedgerAccountsHaveDuplicateAccountIds": {
                    "summary": "Returns 400 when ledger accounts have duplicate account ids",
                    "value": {
                      "error": "Missing or duplicate account IDs",
                      "symbolic": {
                        "base": "missing_or_duplicate_account_ids"
                      }
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Unauthorized",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/symbolic_error"
                },
                "examples": {
                  "Returns401WhenUserLacksRequiredPermissions": {
                    "summary": "Returns 401 when user lacks required permissions",
                    "value": {
                      "error": "No access to contacts, documents, estimates, sales_invoices, bank and settings"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "Too many requests - rate limit exceeded",
            "content": {
              "application/json": {
                "schema": {
                  "type": "string",
                  "example": "Retry later"
                },
                "examples": {
                  "Returns429WhenExceedingTheRateLimit": {
                    "summary": "Returns 429 when exceeding the rate limit",
                    "value": "Retry later"
                  }
                }
              }
            },
            "headers": {
              "RateLimit-Limit": {
                "description": "The rate limit ceiling for that given request",
                "schema": {
                  "type": "integer",
                  "example": 150
                }
              },
              "RateLimit-Remaining": {
                "description": "The number of requests left for the time window",
                "schema": {
                  "type": "integer",
                  "example": 149
                }
              },
              "RateLimit-Reset": {
                "description": "The time at which the current rate limit window resets in UTC epoch seconds",
                "schema": {
                  "type": "integer",
                  "example": 1609459200
                }
              },
              "Retry-After": {
                "description": "The time at which the current rate limit window resets in UTC epoch seconds",
                "schema": {
                  "type": "integer",
                  "example": 1609459200
                }
              }
            }
          }
        },
        "operationId": "post_administration_id_reports_export_auditfile"
      }
    },
    "/{administration_id}/reports/export/brugstaat{format}": {
      "post": {
        "summary": "Export brugstaat",
        "description": "Queue the export of a brugstaat XML file for the specified year. The file will be added to your [downloads](../downloads) when ready.\n\nAll ledger accounts must have valid RGS taxonomy codes assigned.\n\n\n### Required scope(s)\n All of: `bank`, `documents` and `sales_invoices`",
        "tags": [
          "Reports"
        ],
        "security": [
          {
            "bearerAuth": [
              "bank",
              "documents",
              "sales_invoices"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/administration_id"
          },
          {
            "$ref": "#/components/parameters/format"
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/*": {
              "schema": {
                "type": "object",
                "required": [
                  "year"
                ],
                "properties": {
                  "year": {
                    "type": "string",
                    "description": "The year for which to generate the brugstaat",
                    "example": "2024"
                  }
                }
              },
              "examples": {
                "GeneratesABrugstaatAndReturns204": {
                  "summary": "Generates a brugstaat and returns 204",
                  "value": {
                    "year": "2024"
                  }
                }
              }
            }
          }
        },
        "responses": {
          "204": {
            "$ref": "#/components/responses/204_no_content"
          },
          "400": {
            "description": "Bad request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/symbolic_error"
                },
                "examples": {
                  "Returns400WhenLedgerAccountsHaveInvalidTaxonomyCodes": {
                    "summary": "Returns 400 when ledger accounts have invalid taxonomy codes",
                    "value": {
                      "error": "Not all categories are linked to a RGS code. This is mandatory before downloading a RGS Brugstaat"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Unauthorized",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/symbolic_error"
                },
                "examples": {
                  "Returns401WhenUserLacksRequiredPermissions": {
                    "summary": "Returns 401 when user lacks required permissions",
                    "value": {
                      "error": "No access to documents, sales_invoices and bank"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "Too many requests - rate limit exceeded",
            "content": {
              "application/json": {
                "schema": {
                  "type": "string",
                  "example": "Retry later"
                },
                "examples": {
                  "Returns429WhenExceedingTheRateLimit": {
                    "summary": "Returns 429 when exceeding the rate limit",
                    "value": "Retry later"
                  }
                }
              }
            },
            "headers": {
              "RateLimit-Limit": {
                "description": "The rate limit ceiling for that given request",
                "schema": {
                  "type": "integer",
                  "example": 150
                }
              },
              "RateLimit-Remaining": {
                "description": "The number of requests left for the time window",
                "schema": {
                  "type": "integer",
                  "example": 149
                }
              },
              "RateLimit-Reset": {
                "description": "The time at which the current rate limit window resets in UTC epoch seconds",
                "schema": {
                  "type": "integer",
                  "example": 1609459200
                }
              },
              "Retry-After": {
                "description": "The time at which the current rate limit window resets in UTC epoch seconds",
                "schema": {
                  "type": "integer",
                  "example": 1609459200
                }
              }
            }
          }
        },
        "operationId": "post_administration_id_reports_export_brugstaat"
      }
    },
    "/{administration_id}/reports/export/ledger_accounts{format}": {
      "post": {
        "summary": "Export ledger accounts",
        "description": "Queue the export of ledger accounts (grootboekkaarten) to an Excel file for the specified year. This file contains\nall bookings and can be used for manual audits. The file will be added to your [downloads](../downloads) when ready.\n\nThe specified year must contain journal entries.\n\n\n### Required scope(s)\n `documents` and `sales_invoices`",
        "tags": [
          "Reports"
        ],
        "security": [
          {
            "bearerAuth": [
              "documents",
              "sales_invoices"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/administration_id"
          },
          {
            "$ref": "#/components/parameters/format"
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/*": {
              "schema": {
                "type": "object",
                "required": [
                  "year"
                ],
                "properties": {
                  "year": {
                    "type": "string",
                    "description": "The year for which to generate the ledger accounts",
                    "example": "2024"
                  }
                }
              },
              "examples": {
                "Answers204WhenTheSameExportIsAlreadyBeingPrepared": {
                  "summary": "Answers 204 when the same export is already being prepared",
                  "value": {
                    "year": "2024"
                  }
                },
                "PreparesALedgerAccountsExportAndReturns204": {
                  "summary": "Prepares a ledger accounts export and returns 204",
                  "value": {
                    "year": "2024"
                  }
                }
              }
            }
          }
        },
        "responses": {
          "204": {
            "$ref": "#/components/responses/204_no_content"
          },
          "400": {
            "description": "Bad request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/symbolic_error"
                },
                "examples": {
                  "Returns400WhenPeriodContainsNoJournalEntries": {
                    "summary": "Returns 400 when period contains no journal entries",
                    "value": {
                      "error": "Period contains no journal entries",
                      "symbolic": {
                        "period": "contains_no_journal_entries"
                      }
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Unauthorized",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/symbolic_error"
                },
                "examples": {
                  "Returns401WhenUserLacksRequiredPermissions": {
                    "summary": "Returns 401 when user lacks required permissions",
                    "value": {
                      "error": "No access to sales_invoices and documents"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "Too many requests - rate limit exceeded",
            "content": {
              "application/json": {
                "schema": {
                  "type": "string",
                  "example": "Retry later"
                },
                "examples": {
                  "Returns429WhenExceedingTheRateLimit": {
                    "summary": "Returns 429 when exceeding the rate limit",
                    "value": "Retry later"
                  }
                }
              }
            },
            "headers": {
              "RateLimit-Limit": {
                "description": "The rate limit ceiling for that given request",
                "schema": {
                  "type": "integer",
                  "example": 150
                }
              },
              "RateLimit-Remaining": {
                "description": "The number of requests left for the time window",
                "schema": {
                  "type": "integer",
                  "example": 149
                }
              },
              "RateLimit-Reset": {
                "description": "The time at which the current rate limit window resets in UTC epoch seconds",
                "schema": {
                  "type": "integer",
                  "example": 1609459200
                }
              },
              "Retry-After": {
                "description": "The time at which the current rate limit window resets in UTC epoch seconds",
                "schema": {
                  "type": "integer",
                  "example": 1609459200
                }
              }
            }
          }
        },
        "operationId": "post_administration_id_reports_export_ledger_accounts"
      }
    },
    "/{administration_id}/reports/general_ledger{format}": {
      "get": {
        "summary": "General ledger report",
        "description": "Get the general ledger report for the administration showing all ledger accounts with their balances and movements during the specified period.\n\nWith `granularity`, `periods` gives the same report for every month, quarter or year in the period: the debit and credit sums of that period, and the balance at its start and end. Within a period, only the ledger accounts with a balance or bookings are listed. Profit and loss accounts start at zero in every period, so their `final_balance` in a period is the result of that period alone; balance sheet accounts carry their balance over. The debit and credit sums leave out the bookings of a fiscal year ending, but the start balance of the next period includes them, so a period does not always start at the `final_balance` of the period before it.\n\n### Required scope(s)\n `bank`",
        "tags": [
          "Reports"
        ],
        "security": [
          {
            "bearerAuth": [
              "bank"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/administration_id"
          },
          {
            "$ref": "#/components/parameters/format"
          },
          {
            "$ref": "#/components/parameters/period"
          },
          {
            "$ref": "#/components/parameters/granularity"
          }
        ],
        "responses": {
          "200": {
            "description": "A general ledger report",
            "content": {
              "application/json": {
                "schema": {
                  "allOf": [
                    {
                      "$ref": "#/components/schemas/general_ledger_amounts"
                    },
                    {
                      "type": "object",
                      "properties": {
                        "periods": {
                          "type": "array",
                          "description": "Only present when `granularity` is given. One item for each month, quarter or year in `period`, oldest first.",
                          "items": {
                            "allOf": [
                              {
                                "type": "object",
                                "required": [
                                  "period"
                                ],
                                "properties": {
                                  "period": {
                                    "type": "string",
                                    "description": "The period of this item, in the same format as the `period` parameter (e.g. `202501..202503`)."
                                  }
                                }
                              },
                              {
                                "$ref": "#/components/schemas/general_ledger_amounts"
                              }
                            ]
                          }
                        }
                      }
                    }
                  ]
                },
                "examples": {
                  "CutsTheFirstQuarterOffAtTheStartOfAPeriodThatDoesNotBeginOnAQuarter": {
                    "summary": "Cuts the first quarter off at the start of a period that does not begin on a quarter",
                    "value": {
                      "debit_sums": {
                        "ledger_accounts": [
                          {
                            "ledger_account_id": "502689313872414124",
                            "value": "150.0"
                          }
                        ]
                      },
                      "credit_sums": {
                        "ledger_accounts": []
                      },
                      "start_balance": {
                        "ledger_accounts": [
                          {
                            "ledger_account_id": "502689313872414124",
                            "value": "300.0"
                          }
                        ]
                      },
                      "final_balance": {
                        "ledger_accounts": [
                          {
                            "ledger_account_id": "502689313872414124",
                            "value": "450.0"
                          }
                        ]
                      },
                      "periods": [
                        {
                          "period": "202502..202503",
                          "debit_sums": {
                            "ledger_accounts": [
                              {
                                "ledger_account_id": "502689313872414124",
                                "value": "100.0"
                              }
                            ]
                          },
                          "credit_sums": {
                            "ledger_accounts": []
                          },
                          "start_balance": {
                            "ledger_accounts": [
                              {
                                "ledger_account_id": "502689313872414124",
                                "value": "300.0"
                              }
                            ]
                          },
                          "final_balance": {
                            "ledger_accounts": [
                              {
                                "ledger_account_id": "502689313872414124",
                                "value": "400.0"
                              }
                            ]
                          }
                        },
                        {
                          "period": "202504..202504",
                          "debit_sums": {
                            "ledger_accounts": [
                              {
                                "ledger_account_id": "502689313872414124",
                                "value": "50.0"
                              }
                            ]
                          },
                          "credit_sums": {
                            "ledger_accounts": []
                          },
                          "start_balance": {
                            "ledger_accounts": [
                              {
                                "ledger_account_id": "502689313872414124",
                                "value": "400.0"
                              }
                            ]
                          },
                          "final_balance": {
                            "ledger_accounts": [
                              {
                                "ledger_account_id": "502689313872414124",
                                "value": "450.0"
                              }
                            ]
                          }
                        }
                      ]
                    }
                  },
                  "ReturnsGeneralLedgerData": {
                    "summary": "Returns general ledger data",
                    "value": {
                      "debit_sums": {
                        "ledger_accounts": [
                          {
                            "ledger_account_id": "502689313956300225",
                            "value": "1000.0"
                          }
                        ]
                      },
                      "credit_sums": {
                        "ledger_accounts": [
                          {
                            "ledger_account_id": "502689313956300225",
                            "value": "500.0"
                          }
                        ]
                      },
                      "start_balance": {
                        "ledger_accounts": [
                          {
                            "ledger_account_id": "502689313956300225",
                            "value": "300.0"
                          }
                        ]
                      },
                      "final_balance": {
                        "ledger_accounts": [
                          {
                            "ledger_account_id": "502689313956300225",
                            "value": "800.0"
                          }
                        ]
                      }
                    }
                  },
                  "SplitsTheGeneralLedgerIntoPeriodsByGranularity": {
                    "summary": "Splits the general ledger into periods by granularity",
                    "value": {
                      "debit_sums": {
                        "ledger_accounts": [
                          {
                            "ledger_account_id": "502689313995097550",
                            "value": "1200.0"
                          }
                        ]
                      },
                      "credit_sums": {
                        "ledger_accounts": [
                          {
                            "ledger_account_id": "502689313995097550",
                            "value": "500.0"
                          }
                        ]
                      },
                      "start_balance": {
                        "ledger_accounts": [
                          {
                            "ledger_account_id": "502689313995097550",
                            "value": "300.0"
                          }
                        ]
                      },
                      "final_balance": {
                        "ledger_accounts": [
                          {
                            "ledger_account_id": "502689313995097550",
                            "value": "1000.0"
                          }
                        ]
                      },
                      "periods": [
                        {
                          "period": "202505..202505",
                          "debit_sums": {
                            "ledger_accounts": [
                              {
                                "ledger_account_id": "502689313995097550",
                                "value": "200.0"
                              }
                            ]
                          },
                          "credit_sums": {
                            "ledger_accounts": []
                          },
                          "start_balance": {
                            "ledger_accounts": [
                              {
                                "ledger_account_id": "502689313995097550",
                                "value": "300.0"
                              }
                            ]
                          },
                          "final_balance": {
                            "ledger_accounts": [
                              {
                                "ledger_account_id": "502689313995097550",
                                "value": "500.0"
                              }
                            ]
                          }
                        },
                        {
                          "period": "202506..202506",
                          "debit_sums": {
                            "ledger_accounts": [
                              {
                                "ledger_account_id": "502689313995097550",
                                "value": "1000.0"
                              }
                            ]
                          },
                          "credit_sums": {
                            "ledger_accounts": [
                              {
                                "ledger_account_id": "502689313995097550",
                                "value": "500.0"
                              }
                            ]
                          },
                          "start_balance": {
                            "ledger_accounts": [
                              {
                                "ledger_account_id": "502689313995097550",
                                "value": "500.0"
                              }
                            ]
                          },
                          "final_balance": {
                            "ledger_accounts": [
                              {
                                "ledger_account_id": "502689313995097550",
                                "value": "1000.0"
                              }
                            ]
                          }
                        }
                      ]
                    }
                  },
                  "ReturnsSuccessForFullPeriod": {
                    "summary": "Returns success for full period",
                    "value": {
                      "debit_sums": {
                        "ledger_accounts": [
                          {
                            "ledger_account_id": "502689314094712300",
                            "value": "1000.0"
                          }
                        ]
                      },
                      "credit_sums": {
                        "ledger_accounts": [
                          {
                            "ledger_account_id": "502689314094712300",
                            "value": "500.0"
                          }
                        ]
                      },
                      "start_balance": {
                        "ledger_accounts": [
                          {
                            "ledger_account_id": "502689314094712300",
                            "value": "300.0"
                          }
                        ]
                      },
                      "final_balance": {
                        "ledger_accounts": [
                          {
                            "ledger_account_id": "502689314094712300",
                            "value": "800.0"
                          }
                        ]
                      }
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "Bad request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/symbolic_error"
                },
                "examples": {
                  "ReturnsErrorForInvalidPeriodFormat": {
                    "summary": "Returns error for invalid period format",
                    "value": {
                      "error": "Period is invalid"
                    }
                  },
                  "ReturnsErrorWhenPeriodExceedsLimit": {
                    "summary": "Returns error when period exceeds limit",
                    "value": {
                      "error": "Period cannot exceed 12 months"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Unauthorized",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/symbolic_error"
                },
                "examples": {
                  "Returns401WhenUserLacksRequiredPermissions": {
                    "summary": "Returns 401 when user lacks required permissions",
                    "value": {
                      "error": "No access to bank"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "Too many requests - rate limit exceeded",
            "content": {
              "application/json": {
                "schema": {
                  "type": "string",
                  "example": "Retry later"
                },
                "examples": {
                  "Returns429WhenExceedingTheRateLimit": {
                    "summary": "Returns 429 when exceeding the rate limit",
                    "value": "Retry later"
                  }
                }
              }
            },
            "headers": {
              "RateLimit-Limit": {
                "description": "The rate limit ceiling for that given request",
                "schema": {
                  "type": "integer",
                  "example": 150
                }
              },
              "RateLimit-Remaining": {
                "description": "The number of requests left for the time window",
                "schema": {
                  "type": "integer",
                  "example": 149
                }
              },
              "RateLimit-Reset": {
                "description": "The time at which the current rate limit window resets in UTC epoch seconds",
                "schema": {
                  "type": "integer",
                  "example": 1609459200
                }
              },
              "Retry-After": {
                "description": "The time at which the current rate limit window resets in UTC epoch seconds",
                "schema": {
                  "type": "integer",
                  "example": 1609459200
                }
              }
            }
          }
        },
        "operationId": "get_administration_id_reports_general_ledger"
      }
    },
    "/{administration_id}/reports/journal_entries{format}": {
      "get": {
        "summary": "Journal entries report",
        "description": "Get the journal entries report showing all bookings within the specified period.\nThis endpoint allows filtering by various criteria including project, contact, ledger account, and account types.\n\n**Requirements:**\n- At least one of project_id, contact_id, or ledger_account_id is required\n- When account_type is provided, either contact_id or project_id must also be specified\n\n**Example Use Cases:**\n- To get a report for revenue by project detail, use account_type parameter with value \"revenue\" and the required project_id\n- To get a report for revenue by contact detail, use account_type parameter with value \"revenue\" and the required contact_id\n- To get a report for expenses by project detail, make one request for account_type \"expenses\" and one for \"direct_costs\", both with the required project_id\n- To get a report for expenses by contact detail, make one request for account_type \"expenses\" and one for \"direct_costs\", both with the required contact_id\n\n\n### Required scope(s)\n `documents` and `sales_invoices`",
        "tags": [
          "Reports"
        ],
        "security": [
          {
            "bearerAuth": [
              "documents",
              "sales_invoices"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/administration_id"
          },
          {
            "$ref": "#/components/parameters/format"
          },
          {
            "$ref": "#/components/parameters/period"
          },
          {
            "$ref": "#/components/parameters/page"
          },
          {
            "$ref": "#/components/parameters/per_page"
          },
          {
            "name": "project_id",
            "in": "query",
            "required": false,
            "description": "Filter by project ID, use \"null\" to filter entries without project",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "contact_id",
            "in": "query",
            "required": false,
            "description": "Filter by contact ID, use \"null\" to filter entries without contact",
            "schema": {
              "type": "string"
            },
            "examples": {
              "ReturnsA200IfTheAccountTypesArePresentAndAContactIdIsPresent": {
                "summary": "Returns a 200 if the account types are present and a contact id is present",
                "value": "123"
              }
            }
          },
          {
            "name": "ledger_account_id",
            "in": "query",
            "required": false,
            "description": "Filter by ledger account ID",
            "schema": {
              "$ref": "#/components/schemas/identifier"
            },
            "examples": {
              "ReturnsAJournalEntriesReportWithSpecificPeriod": {
                "summary": "Returns a journal entries report with specific period",
                "value": "123"
              }
            }
          },
          {
            "name": "account_type",
            "in": "query",
            "required": false,
            "description": "Filter by ledger account type\n",
            "schema": {
              "type": "string",
              "enum": [
                "non_current_assets",
                "current_assets",
                "equity",
                "non_current_liabilities",
                "current_liabilities",
                "revenue",
                "direct_costs",
                "expenses",
                "other_income_expenses",
                "other",
                "temporary",
                "provisions"
              ]
            },
            "examples": {
              "ReturnsA200IfTheAccountTypesArePresentAndAContactIdIsPresent": {
                "summary": "Returns a 200 if the account types are present and a contact id is present",
                "value": "revenue"
              }
            }
          }
        ],
        "responses": {
          "200": {
            "description": "A paginated list of journal entries (bookings)",
            "headers": {
              "X-Total-Count": {
                "$ref": "#/components/headers/x-total-count"
              },
              "Link": {
                "$ref": "#/components/headers/link"
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "type": "object",
                    "properties": {
                      "id": {
                        "type": "string",
                        "description": "Unique identifier for the journal entry"
                      },
                      "date": {
                        "type": "string",
                        "format": "date",
                        "description": "Date of the journal entry"
                      },
                      "document_type": {
                        "type": "string",
                        "description": "Type of document this entry relates to"
                      },
                      "document_id": {
                        "$ref": "#/components/schemas/identifier",
                        "description": "ID of the related document"
                      },
                      "ledger_account_id": {
                        "$ref": "#/components/schemas/identifier",
                        "description": "ID of the ledger account"
                      },
                      "project_id": {
                        "$ref": "#/components/schemas/identifier_nullable",
                        "description": "ID of the related project, if any"
                      },
                      "contact_id": {
                        "$ref": "#/components/schemas/identifier_nullable",
                        "description": "ID of the related contact, if any"
                      },
                      "tax_rate_id": {
                        "$ref": "#/components/schemas/identifier_nullable",
                        "description": "ID of the applied tax rate, if any"
                      },
                      "financial_account_id": {
                        "$ref": "#/components/schemas/identifier_nullable",
                        "description": "ID of the financial account, if any"
                      },
                      "amount": {
                        "type": "string",
                        "description": "Amount of the journal entry in the administration's currency"
                      },
                      "description": {
                        "type": "string",
                        "description": "Description of the journal entry"
                      }
                    }
                  }
                },
                "examples": {
                  "ReturnsAJournalEntriesReportWithSpecificPeriod": {
                    "summary": "Returns a journal entries report with specific period",
                    "value": [
                      {
                        "id": "je_6",
                        "date": "2025-06-14",
                        "document_type": "Document",
                        "document_id": "502689201557341750",
                        "ledger_account_id": "123",
                        "project_id": null,
                        "contact_id": null,
                        "tax_rate_id": null,
                        "financial_account_id": null,
                        "amount": "500.0",
                        "description": "Large customer payment"
                      },
                      {
                        "id": "je_5",
                        "date": "2025-06-12",
                        "document_type": "Document",
                        "document_id": "502689201552098866",
                        "ledger_account_id": "123",
                        "project_id": null,
                        "contact_id": null,
                        "tax_rate_id": null,
                        "financial_account_id": null,
                        "amount": "-75.0",
                        "description": "Credit note"
                      },
                      {
                        "id": "je_3",
                        "date": "2025-06-10",
                        "document_type": "Document",
                        "document_id": "502689201543710250",
                        "ledger_account_id": "123",
                        "project_id": null,
                        "contact_id": null,
                        "tax_rate_id": null,
                        "financial_account_id": null,
                        "amount": "250.0",
                        "description": "Product sales"
                      },
                      {
                        "id": "je_4",
                        "date": "2025-06-08",
                        "document_type": "Document",
                        "document_id": "502689201547904558",
                        "ledger_account_id": "123",
                        "project_id": null,
                        "contact_id": null,
                        "tax_rate_id": null,
                        "financial_account_id": null,
                        "amount": "-25.0",
                        "description": "Sales return"
                      },
                      {
                        "id": "je_2",
                        "date": "2025-06-05",
                        "document_type": "Document",
                        "document_id": "502689201538467366",
                        "ledger_account_id": "123",
                        "project_id": null,
                        "contact_id": null,
                        "tax_rate_id": null,
                        "financial_account_id": null,
                        "amount": "50.0",
                        "description": "Service income"
                      },
                      {
                        "id": "je_7",
                        "date": "2025-06-03",
                        "document_type": "Document",
                        "document_id": "502689201560487482",
                        "ledger_account_id": "123",
                        "project_id": null,
                        "contact_id": null,
                        "tax_rate_id": null,
                        "financial_account_id": null,
                        "amount": "15.5",
                        "description": "Small miscellaneous income"
                      },
                      {
                        "id": "je_1",
                        "date": "2025-06-01",
                        "document_type": "Document",
                        "document_id": "502689201532175906",
                        "ledger_account_id": "123",
                        "project_id": null,
                        "contact_id": null,
                        "tax_rate_id": null,
                        "financial_account_id": null,
                        "amount": "100.0",
                        "description": "Revenue from sales"
                      }
                    ]
                  },
                  "ReturnsA200IfTheAccountTypesArePresentAndAContactIdIsPresent": {
                    "summary": "Returns a 200 if the account types are present and a contact id is present",
                    "value": []
                  },
                  "ReturnsAJournalEntriesReportWithPagination": {
                    "summary": "Returns a journal entries report with pagination",
                    "value": [
                      {
                        "id": "je_6",
                        "date": "2025-06-14",
                        "document_type": "Document",
                        "document_id": "502689201810048694",
                        "ledger_account_id": "123",
                        "project_id": null,
                        "contact_id": null,
                        "tax_rate_id": null,
                        "financial_account_id": null,
                        "amount": "500.0",
                        "description": "Large customer payment"
                      },
                      {
                        "id": "je_5",
                        "date": "2025-06-12",
                        "document_type": "Document",
                        "document_id": "502689201805854386",
                        "ledger_account_id": "123",
                        "project_id": null,
                        "contact_id": null,
                        "tax_rate_id": null,
                        "financial_account_id": null,
                        "amount": "-75.0",
                        "description": "Credit note"
                      },
                      {
                        "id": "je_3",
                        "date": "2025-06-10",
                        "document_type": "Document",
                        "document_id": "502689201798514346",
                        "ledger_account_id": "123",
                        "project_id": null,
                        "contact_id": null,
                        "tax_rate_id": null,
                        "financial_account_id": null,
                        "amount": "250.0",
                        "description": "Product sales"
                      },
                      {
                        "id": "je_4",
                        "date": "2025-06-08",
                        "document_type": "Document",
                        "document_id": "502689201802708654",
                        "ledger_account_id": "123",
                        "project_id": null,
                        "contact_id": null,
                        "tax_rate_id": null,
                        "financial_account_id": null,
                        "amount": "-25.0",
                        "description": "Sales return"
                      },
                      {
                        "id": "je_2",
                        "date": "2025-06-05",
                        "document_type": "Document",
                        "document_id": "502689201793271462",
                        "ledger_account_id": "123",
                        "project_id": null,
                        "contact_id": null,
                        "tax_rate_id": null,
                        "financial_account_id": null,
                        "amount": "50.0",
                        "description": "Service income"
                      }
                    ]
                  },
                  "ReturnsSuccessForFullPeriod": {
                    "summary": "Returns success for full period",
                    "value": [
                      {
                        "id": "je_6",
                        "date": "2025-06-14",
                        "document_type": "Document",
                        "document_id": "502689202207459126",
                        "ledger_account_id": "123",
                        "project_id": null,
                        "contact_id": null,
                        "tax_rate_id": null,
                        "financial_account_id": null,
                        "amount": "500.0",
                        "description": "Large customer payment"
                      },
                      {
                        "id": "je_5",
                        "date": "2025-06-12",
                        "document_type": "Document",
                        "document_id": "502689202200119090",
                        "ledger_account_id": "123",
                        "project_id": null,
                        "contact_id": null,
                        "tax_rate_id": null,
                        "financial_account_id": null,
                        "amount": "-75.0",
                        "description": "Credit note"
                      },
                      {
                        "id": "je_3",
                        "date": "2025-06-10",
                        "document_type": "Document",
                        "document_id": "502689202186487594",
                        "ledger_account_id": "123",
                        "project_id": null,
                        "contact_id": null,
                        "tax_rate_id": null,
                        "financial_account_id": null,
                        "amount": "250.0",
                        "description": "Product sales"
                      },
                      {
                        "id": "je_4",
                        "date": "2025-06-08",
                        "document_type": "Document",
                        "document_id": "502689202192779054",
                        "ledger_account_id": "123",
                        "project_id": null,
                        "contact_id": null,
                        "tax_rate_id": null,
                        "financial_account_id": null,
                        "amount": "-25.0",
                        "description": "Sales return"
                      },
                      {
                        "id": "je_2",
                        "date": "2025-06-05",
                        "document_type": "Document",
                        "document_id": "502689202181244710",
                        "ledger_account_id": "123",
                        "project_id": null,
                        "contact_id": null,
                        "tax_rate_id": null,
                        "financial_account_id": null,
                        "amount": "50.0",
                        "description": "Service income"
                      },
                      {
                        "id": "je_7",
                        "date": "2025-06-03",
                        "document_type": "Document",
                        "document_id": "502689202212702010",
                        "ledger_account_id": "123",
                        "project_id": null,
                        "contact_id": null,
                        "tax_rate_id": null,
                        "financial_account_id": null,
                        "amount": "15.5",
                        "description": "Small miscellaneous income"
                      },
                      {
                        "id": "je_1",
                        "date": "2025-06-01",
                        "document_type": "Document",
                        "document_id": "502689202173904674",
                        "ledger_account_id": "123",
                        "project_id": null,
                        "contact_id": null,
                        "tax_rate_id": null,
                        "financial_account_id": null,
                        "amount": "100.0",
                        "description": "Revenue from sales"
                      },
                      {
                        "id": "je_8",
                        "date": "2025-05-25",
                        "document_type": "Document",
                        "document_id": "502689202220042046",
                        "ledger_account_id": "123",
                        "project_id": null,
                        "contact_id": null,
                        "tax_rate_id": null,
                        "financial_account_id": null,
                        "amount": "300.0",
                        "description": "Previous month revenue"
                      }
                    ]
                  }
                }
              }
            }
          },
          "400": {
            "description": "Bad request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/symbolic_error"
                },
                "examples": {
                  "ReturnsA400IfTheAccountTypeIsPresentButNoContactIdOrProjectIdIsPresent": {
                    "summary": "Returns a 400 if the account type is present but no contact id or project id is present",
                    "value": {
                      "error": "when account_type is present, a contact_id or project_id is required"
                    }
                  },
                  "ReturnsA400IfNoProjectContactOrLedgerAccountIsPresent": {
                    "summary": "Returns a 400 if no project, contact or ledger account is present",
                    "value": {
                      "error": "at least a contact_id, project_id or ledger_account_id is required"
                    }
                  },
                  "ReturnsErrorForInvalidPeriodFormat": {
                    "summary": "Returns error for invalid period format",
                    "value": {
                      "error": "Period is invalid"
                    }
                  },
                  "ReturnsErrorWhenPeriodExceedsLimit": {
                    "summary": "Returns error when period exceeds limit",
                    "value": {
                      "error": "Period cannot exceed 12 months"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Unauthorized",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/symbolic_error"
                },
                "examples": {
                  "Returns401WhenUserLacksRequiredPermissions": {
                    "summary": "Returns 401 when user lacks required permissions",
                    "value": {
                      "error": "No access to sales_invoices and documents"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "Too many requests - rate limit exceeded",
            "content": {
              "application/json": {
                "schema": {
                  "type": "string",
                  "example": "Retry later"
                },
                "examples": {
                  "Returns429WhenExceedingTheRateLimit": {
                    "summary": "Returns 429 when exceeding the rate limit",
                    "value": "Retry later"
                  }
                }
              }
            },
            "headers": {
              "RateLimit-Limit": {
                "description": "The rate limit ceiling for that given request",
                "schema": {
                  "type": "integer",
                  "example": 150
                }
              },
              "RateLimit-Remaining": {
                "description": "The number of requests left for the time window",
                "schema": {
                  "type": "integer",
                  "example": 149
                }
              },
              "RateLimit-Reset": {
                "description": "The time at which the current rate limit window resets in UTC epoch seconds",
                "schema": {
                  "type": "integer",
                  "example": 1609459200
                }
              },
              "Retry-After": {
                "description": "The time at which the current rate limit window resets in UTC epoch seconds",
                "schema": {
                  "type": "integer",
                  "example": 1609459200
                }
              }
            }
          }
        },
        "operationId": "get_administration_id_reports_journal_entries"
      }
    },
    "/{administration_id}/reports/ledger_accounts/{ledger_account_id}{format}": {
      "get": {
        "summary": "Ledger account report",
        "description": "This endpoint is deprecated and should no longer be used. It has been replaced by the `Journal entries report`.\n\n### Required scope(s)\n `documents` and `sales_invoices`",
        "deprecated": true,
        "x-sunset": "2025-12-31",
        "tags": [
          "Reports"
        ],
        "security": [
          {
            "bearerAuth": [
              "documents",
              "sales_invoices"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/administration_id"
          },
          {
            "$ref": "#/components/parameters/format"
          },
          {
            "name": "ledger_account_id",
            "in": "path",
            "required": true,
            "description": "The ID of the ledger account to get the report for",
            "schema": {
              "$ref": "#/components/schemas/identifier"
            }
          },
          {
            "$ref": "#/components/parameters/period"
          },
          {
            "$ref": "#/components/parameters/page"
          },
          {
            "$ref": "#/components/parameters/per_page"
          }
        ],
        "responses": {
          "200": {
            "description": "A paginated list of ledger account bookings (journal entries)",
            "headers": {
              "X-Total-Count": {
                "$ref": "#/components/headers/x-total-count"
              },
              "Link": {
                "$ref": "#/components/headers/link"
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "type": "object",
                    "properties": {
                      "id": {
                        "type": "string"
                      },
                      "date": {
                        "type": "string",
                        "format": "date"
                      },
                      "document_type": {
                        "type": "string"
                      },
                      "document_id": {
                        "$ref": "#/components/schemas/identifier"
                      },
                      "ledger_account_id": {
                        "$ref": "#/components/schemas/identifier"
                      },
                      "project_id": {
                        "$ref": "#/components/schemas/identifier_nullable"
                      },
                      "contact_id": {
                        "$ref": "#/components/schemas/identifier_nullable"
                      },
                      "tax_rate_id": {
                        "$ref": "#/components/schemas/identifier_nullable"
                      },
                      "financial_account_id": {
                        "$ref": "#/components/schemas/identifier_nullable"
                      },
                      "amount": {
                        "type": "string"
                      },
                      "description": {
                        "type": "string"
                      }
                    }
                  }
                },
                "examples": {
                  "ReturnsALedgerAccountReportWithPagination": {
                    "summary": "Returns a ledger account report with pagination",
                    "value": [
                      {
                        "id": "je_6",
                        "date": "2025-06-14",
                        "document_type": "Document",
                        "document_id": "502689293208126928",
                        "ledger_account_id": "123",
                        "project_id": null,
                        "contact_id": null,
                        "tax_rate_id": null,
                        "financial_account_id": null,
                        "amount": "500.0",
                        "description": "Large customer payment"
                      },
                      {
                        "id": "je_5",
                        "date": "2025-06-12",
                        "document_type": "Document",
                        "document_id": "502689293203932620",
                        "ledger_account_id": "123",
                        "project_id": null,
                        "contact_id": null,
                        "tax_rate_id": null,
                        "financial_account_id": null,
                        "amount": "-75.0",
                        "description": "Credit note"
                      },
                      {
                        "id": "je_3",
                        "date": "2025-06-10",
                        "document_type": "Document",
                        "document_id": "502689293195544004",
                        "ledger_account_id": "123",
                        "project_id": null,
                        "contact_id": null,
                        "tax_rate_id": null,
                        "financial_account_id": null,
                        "amount": "250.0",
                        "description": "Product sales"
                      },
                      {
                        "id": "je_4",
                        "date": "2025-06-08",
                        "document_type": "Document",
                        "document_id": "502689293199738312",
                        "ledger_account_id": "123",
                        "project_id": null,
                        "contact_id": null,
                        "tax_rate_id": null,
                        "financial_account_id": null,
                        "amount": "-25.0",
                        "description": "Sales return"
                      },
                      {
                        "id": "je_2",
                        "date": "2025-06-05",
                        "document_type": "Document",
                        "document_id": "502689293191349696",
                        "ledger_account_id": "123",
                        "project_id": null,
                        "contact_id": null,
                        "tax_rate_id": null,
                        "financial_account_id": null,
                        "amount": "50.0",
                        "description": "Service income"
                      }
                    ]
                  },
                  "ReturnsALedgerAccountReport": {
                    "summary": "Returns a ledger account report",
                    "value": [
                      {
                        "id": "je_6",
                        "date": "2025-06-14",
                        "document_type": "Document",
                        "document_id": "502689293261604336",
                        "ledger_account_id": "123",
                        "project_id": null,
                        "contact_id": null,
                        "tax_rate_id": null,
                        "financial_account_id": null,
                        "amount": "500.0",
                        "description": "Large customer payment"
                      },
                      {
                        "id": "je_5",
                        "date": "2025-06-12",
                        "document_type": "Document",
                        "document_id": "502689293258458604",
                        "ledger_account_id": "123",
                        "project_id": null,
                        "contact_id": null,
                        "tax_rate_id": null,
                        "financial_account_id": null,
                        "amount": "-75.0",
                        "description": "Credit note"
                      },
                      {
                        "id": "je_3",
                        "date": "2025-06-10",
                        "document_type": "Document",
                        "document_id": "502689293251118564",
                        "ledger_account_id": "123",
                        "project_id": null,
                        "contact_id": null,
                        "tax_rate_id": null,
                        "financial_account_id": null,
                        "amount": "250.0",
                        "description": "Product sales"
                      },
                      {
                        "id": "je_4",
                        "date": "2025-06-08",
                        "document_type": "Document",
                        "document_id": "502689293255312872",
                        "ledger_account_id": "123",
                        "project_id": null,
                        "contact_id": null,
                        "tax_rate_id": null,
                        "financial_account_id": null,
                        "amount": "-25.0",
                        "description": "Sales return"
                      },
                      {
                        "id": "je_2",
                        "date": "2025-06-05",
                        "document_type": "Document",
                        "document_id": "502689293247972832",
                        "ledger_account_id": "123",
                        "project_id": null,
                        "contact_id": null,
                        "tax_rate_id": null,
                        "financial_account_id": null,
                        "amount": "50.0",
                        "description": "Service income"
                      },
                      {
                        "id": "je_7",
                        "date": "2025-06-03",
                        "document_type": "Document",
                        "document_id": "502689293265798644",
                        "ledger_account_id": "123",
                        "project_id": null,
                        "contact_id": null,
                        "tax_rate_id": null,
                        "financial_account_id": null,
                        "amount": "15.5",
                        "description": "Small miscellaneous income"
                      },
                      {
                        "id": "je_1",
                        "date": "2025-06-01",
                        "document_type": "Document",
                        "document_id": "502689293243778524",
                        "ledger_account_id": "123",
                        "project_id": null,
                        "contact_id": null,
                        "tax_rate_id": null,
                        "financial_account_id": null,
                        "amount": "100.0",
                        "description": "Revenue from sales"
                      }
                    ]
                  },
                  "ReturnsSuccessForFullPeriod": {
                    "summary": "Returns success for full period",
                    "value": [
                      {
                        "id": "je_6",
                        "date": "2025-06-14",
                        "document_type": "Document",
                        "document_id": "502689293364364848",
                        "ledger_account_id": "123",
                        "project_id": null,
                        "contact_id": null,
                        "tax_rate_id": null,
                        "financial_account_id": null,
                        "amount": "500.0",
                        "description": "Large customer payment"
                      },
                      {
                        "id": "je_5",
                        "date": "2025-06-12",
                        "document_type": "Document",
                        "document_id": "502689293360170540",
                        "ledger_account_id": "123",
                        "project_id": null,
                        "contact_id": null,
                        "tax_rate_id": null,
                        "financial_account_id": null,
                        "amount": "-75.0",
                        "description": "Credit note"
                      },
                      {
                        "id": "je_3",
                        "date": "2025-06-10",
                        "document_type": "Document",
                        "document_id": "502689293351781924",
                        "ledger_account_id": "123",
                        "project_id": null,
                        "contact_id": null,
                        "tax_rate_id": null,
                        "financial_account_id": null,
                        "amount": "250.0",
                        "description": "Product sales"
                      },
                      {
                        "id": "je_4",
                        "date": "2025-06-08",
                        "document_type": "Document",
                        "document_id": "502689293355976232",
                        "ledger_account_id": "123",
                        "project_id": null,
                        "contact_id": null,
                        "tax_rate_id": null,
                        "financial_account_id": null,
                        "amount": "-25.0",
                        "description": "Sales return"
                      },
                      {
                        "id": "je_2",
                        "date": "2025-06-05",
                        "document_type": "Document",
                        "document_id": "502689293347587616",
                        "ledger_account_id": "123",
                        "project_id": null,
                        "contact_id": null,
                        "tax_rate_id": null,
                        "financial_account_id": null,
                        "amount": "50.0",
                        "description": "Service income"
                      },
                      {
                        "id": "je_7",
                        "date": "2025-06-03",
                        "document_type": "Document",
                        "document_id": "502689293367510580",
                        "ledger_account_id": "123",
                        "project_id": null,
                        "contact_id": null,
                        "tax_rate_id": null,
                        "financial_account_id": null,
                        "amount": "15.5",
                        "description": "Small miscellaneous income"
                      },
                      {
                        "id": "je_1",
                        "date": "2025-06-01",
                        "document_type": "Document",
                        "document_id": "502689293343393308",
                        "ledger_account_id": "123",
                        "project_id": null,
                        "contact_id": null,
                        "tax_rate_id": null,
                        "financial_account_id": null,
                        "amount": "100.0",
                        "description": "Revenue from sales"
                      },
                      {
                        "id": "je_8",
                        "date": "2025-05-25",
                        "document_type": "Document",
                        "document_id": "502689293370656312",
                        "ledger_account_id": "123",
                        "project_id": null,
                        "contact_id": null,
                        "tax_rate_id": null,
                        "financial_account_id": null,
                        "amount": "300.0",
                        "description": "Previous month revenue"
                      }
                    ]
                  }
                }
              }
            }
          },
          "400": {
            "description": "Bad request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/symbolic_error"
                },
                "examples": {
                  "ReturnsErrorForInvalidPeriodFormat": {
                    "summary": "Returns error for invalid period format",
                    "value": {
                      "error": "Period is invalid"
                    }
                  },
                  "ReturnsErrorWhenPeriodExceedsLimit": {
                    "summary": "Returns error when period exceeds limit",
                    "value": {
                      "error": "Period cannot exceed 12 months"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Unauthorized",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/symbolic_error"
                },
                "examples": {
                  "Returns401WhenUserLacksRequiredPermissions": {
                    "summary": "Returns 401 when user lacks required permissions",
                    "value": {
                      "error": "No access to sales_invoices and documents"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Not found",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/symbolic_error"
                },
                "examples": {
                  "ReturnsA404IfTheLedgerAccountDoesNotExist": {
                    "summary": "Returns a 404 if the ledger account does not exist",
                    "value": {
                      "error": "Record not found for model name: Category"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "Too many requests - rate limit exceeded",
            "content": {
              "application/json": {
                "schema": {
                  "type": "string",
                  "example": "Retry later"
                },
                "examples": {
                  "Returns429WhenExceedingTheRateLimit": {
                    "summary": "Returns 429 when exceeding the rate limit",
                    "value": "Retry later"
                  }
                }
              }
            },
            "headers": {
              "RateLimit-Limit": {
                "description": "The rate limit ceiling for that given request",
                "schema": {
                  "type": "integer",
                  "example": 150
                }
              },
              "RateLimit-Remaining": {
                "description": "The number of requests left for the time window",
                "schema": {
                  "type": "integer",
                  "example": 149
                }
              },
              "RateLimit-Reset": {
                "description": "The time at which the current rate limit window resets in UTC epoch seconds",
                "schema": {
                  "type": "integer",
                  "example": 1609459200
                }
              },
              "Retry-After": {
                "description": "The time at which the current rate limit window resets in UTC epoch seconds",
                "schema": {
                  "type": "integer",
                  "example": 1609459200
                }
              }
            }
          }
        },
        "operationId": "get_administration_id_reports_ledger_accounts_ledger_account_id"
      }
    },
    "/{administration_id}/reports/profit_loss{format}": {
      "get": {
        "summary": "Profit loss report",
        "description": "Get the profit loss report for the administration.\n\nEvery `*_by_ledger_account` section contains one item per ledger account with bookings in the period. Nested accounts are flat here: a parent's amount does not include its child accounts, which are listed as items of their own. Adding up all items in a section therefore gives that section's total without double counting.\n\nThe sections are not all signed the same way:\n\n| **Section** | **Sign** |\n| - | - |\n| revenue_by_ledger_account | credit minus debit, so revenue is positive |\n| direct_costs_by_ledger_account | debit minus credit, so costs are positive |\n| expenses_by_ledger_account | debit minus credit, so costs are positive |\n| other_income_expenses_by_ledger_account | credit minus debit, so income is positive and expenses are negative |\n\nSections can therefore not be added together as they are, and adding the three cost sections does not produce `total_expenses`. The description of each total says how that total is composed.\n\nThe fields at the top level always cover the whole `period`. With `granularity`, `periods` splits the same fields per month, quarter or year. Within a period, a section only lists the ledger accounts with bookings in that period.\n\n### Required scope(s)\n `documents` and `sales_invoices`",
        "tags": [
          "Reports"
        ],
        "security": [
          {
            "bearerAuth": [
              "documents",
              "sales_invoices"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/administration_id"
          },
          {
            "$ref": "#/components/parameters/format"
          },
          {
            "$ref": "#/components/parameters/period"
          },
          {
            "$ref": "#/components/parameters/granularity"
          },
          {
            "name": "project_id",
            "in": "query",
            "required": false,
            "schema": {
              "$ref": "#/components/schemas/identifier"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "A profit loss report",
            "content": {
              "application/json": {
                "schema": {
                  "allOf": [
                    {
                      "$ref": "#/components/schemas/profit_loss_amounts"
                    },
                    {
                      "type": "object",
                      "properties": {
                        "periods": {
                          "type": "array",
                          "description": "Only present when `granularity` is given. One item for each month, quarter or year in `period`, oldest first.",
                          "items": {
                            "allOf": [
                              {
                                "type": "object",
                                "required": [
                                  "period"
                                ],
                                "properties": {
                                  "period": {
                                    "type": "string",
                                    "description": "The period of this item, in the same format as the `period` parameter (e.g. `202501..202503`)."
                                  }
                                }
                              },
                              {
                                "$ref": "#/components/schemas/profit_loss_amounts"
                              }
                            ]
                          }
                        }
                      }
                    }
                  ]
                },
                "examples": {
                  "SplitsTheProfitLossReportIntoPeriodsByGranularity": {
                    "summary": "Splits the profit loss report into periods by granularity",
                    "value": {
                      "revenue_by_ledger_account": {
                        "ledger_accounts": [
                          {
                            "ledger_account_id": "502689242549323694",
                            "value": "150.0"
                          }
                        ]
                      },
                      "direct_costs_by_ledger_account": {
                        "ledger_accounts": [
                          {
                            "ledger_account_id": "502689242561906611",
                            "value": "20.0"
                          }
                        ]
                      },
                      "expenses_by_ledger_account": {
                        "ledger_accounts": [
                          {
                            "ledger_account_id": "502689242574489528",
                            "value": "15.0"
                          }
                        ]
                      },
                      "other_income_expenses_by_ledger_account": {
                        "ledger_accounts": [
                          {
                            "ledger_account_id": "502689242588121021",
                            "value": "1.0"
                          }
                        ]
                      },
                      "gross_profit": "130.0",
                      "operating_profit": "115.0",
                      "net_profit": "116.0",
                      "total_expenses": "34.0",
                      "total_revenue": "150.0",
                      "periods": [
                        {
                          "period": "202505..202505",
                          "revenue_by_ledger_account": {
                            "ledger_accounts": [
                              {
                                "ledger_account_id": "502689242549323694",
                                "value": "50.0"
                              }
                            ]
                          },
                          "direct_costs_by_ledger_account": {
                            "ledger_accounts": []
                          },
                          "expenses_by_ledger_account": {
                            "ledger_accounts": []
                          },
                          "other_income_expenses_by_ledger_account": {
                            "ledger_accounts": []
                          },
                          "gross_profit": "50.0",
                          "operating_profit": "50.0",
                          "net_profit": "50.0",
                          "total_expenses": "0.0",
                          "total_revenue": "50.0"
                        },
                        {
                          "period": "202506..202506",
                          "revenue_by_ledger_account": {
                            "ledger_accounts": [
                              {
                                "ledger_account_id": "502689242549323694",
                                "value": "100.0"
                              }
                            ]
                          },
                          "direct_costs_by_ledger_account": {
                            "ledger_accounts": [
                              {
                                "ledger_account_id": "502689242561906611",
                                "value": "20.0"
                              }
                            ]
                          },
                          "expenses_by_ledger_account": {
                            "ledger_accounts": [
                              {
                                "ledger_account_id": "502689242574489528",
                                "value": "15.0"
                              }
                            ]
                          },
                          "other_income_expenses_by_ledger_account": {
                            "ledger_accounts": [
                              {
                                "ledger_account_id": "502689242588121021",
                                "value": "1.0"
                              }
                            ]
                          },
                          "gross_profit": "80.0",
                          "operating_profit": "65.0",
                          "net_profit": "66.0",
                          "total_expenses": "34.0",
                          "total_revenue": "100.0"
                        }
                      ]
                    }
                  },
                  "ReturnsAProfitLossReport": {
                    "summary": "Returns a profit loss report",
                    "value": {
                      "revenue_by_ledger_account": {
                        "ledger_accounts": [
                          {
                            "ledger_account_id": "502689242657327046",
                            "value": "100.0"
                          }
                        ]
                      },
                      "direct_costs_by_ledger_account": {
                        "ledger_accounts": [
                          {
                            "ledger_account_id": "502689242668861387",
                            "value": "20.0"
                          }
                        ]
                      },
                      "expenses_by_ledger_account": {
                        "ledger_accounts": [
                          {
                            "ledger_account_id": "502689242679347152",
                            "value": "15.0"
                          }
                        ]
                      },
                      "other_income_expenses_by_ledger_account": {
                        "ledger_accounts": [
                          {
                            "ledger_account_id": "502689242690881493",
                            "value": "1.0"
                          }
                        ]
                      },
                      "gross_profit": "80.0",
                      "operating_profit": "65.0",
                      "net_profit": "66.0",
                      "total_expenses": "34.0",
                      "total_revenue": "100.0"
                    }
                  },
                  "ReturnsSuccessForFullPeriod": {
                    "summary": "Returns success for full period",
                    "value": {
                      "revenue_by_ledger_account": {
                        "ledger_accounts": [
                          {
                            "ledger_account_id": "502689242870187030",
                            "value": "100.0"
                          }
                        ]
                      },
                      "direct_costs_by_ledger_account": {
                        "ledger_accounts": [
                          {
                            "ledger_account_id": "502689242877527067",
                            "value": "20.0"
                          }
                        ]
                      },
                      "expenses_by_ledger_account": {
                        "ledger_accounts": [
                          {
                            "ledger_account_id": "502689242884867104",
                            "value": "15.0"
                          }
                        ]
                      },
                      "other_income_expenses_by_ledger_account": {
                        "ledger_accounts": [
                          {
                            "ledger_account_id": "502689242892207141",
                            "value": "1.0"
                          }
                        ]
                      },
                      "gross_profit": "80.0",
                      "operating_profit": "65.0",
                      "net_profit": "66.0",
                      "total_expenses": "34.0",
                      "total_revenue": "100.0"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "Bad request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/symbolic_error"
                },
                "examples": {
                  "ReturnsErrorForInvalidPeriodFormat": {
                    "summary": "Returns error for invalid period format",
                    "value": {
                      "error": "Period is invalid"
                    }
                  },
                  "ReturnsErrorWhenPeriodExceedsLimit": {
                    "summary": "Returns error when period exceeds limit",
                    "value": {
                      "error": "Period cannot exceed 12 months"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Unauthorized",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/symbolic_error"
                },
                "examples": {
                  "Returns401WhenUserLacksRequiredPermissions": {
                    "summary": "Returns 401 when user lacks required permissions",
                    "value": {
                      "error": "No access to sales_invoices and documents"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "Too many requests - rate limit exceeded",
            "content": {
              "application/json": {
                "schema": {
                  "type": "string",
                  "example": "Retry later"
                },
                "examples": {
                  "Returns429WhenExceedingTheRateLimit": {
                    "summary": "Returns 429 when exceeding the rate limit",
                    "value": "Retry later"
                  }
                }
              }
            },
            "headers": {
              "RateLimit-Limit": {
                "description": "The rate limit ceiling for that given request",
                "schema": {
                  "type": "integer",
                  "example": 150
                }
              },
              "RateLimit-Remaining": {
                "description": "The number of requests left for the time window",
                "schema": {
                  "type": "integer",
                  "example": 149
                }
              },
              "RateLimit-Reset": {
                "description": "The time at which the current rate limit window resets in UTC epoch seconds",
                "schema": {
                  "type": "integer",
                  "example": 1609459200
                }
              },
              "Retry-After": {
                "description": "The time at which the current rate limit window resets in UTC epoch seconds",
                "schema": {
                  "type": "integer",
                  "example": 1609459200
                }
              }
            }
          }
        },
        "operationId": "get_administration_id_reports_profit_loss"
      }
    },
    "/{administration_id}/reports/revenue_by_contact{format}": {
      "get": {
        "summary": "Revenue by contact report",
        "description": "Returns a revenue by contact report for the specified administration.\n\nWith `granularity`, `periods` splits the amounts per month, quarter or year. Within a period, only the contacts on this page with bookings in that period are listed.\n\n### Required scope(s)\n `sales_invoices`",
        "tags": [
          "Reports"
        ],
        "security": [
          {
            "bearerAuth": [
              "sales_invoices"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/administration_id"
          },
          {
            "$ref": "#/components/parameters/format"
          },
          {
            "$ref": "#/components/parameters/period"
          },
          {
            "$ref": "#/components/parameters/granularity"
          },
          {
            "$ref": "#/components/parameters/page"
          },
          {
            "$ref": "#/components/parameters/per_page"
          }
        ],
        "responses": {
          "200": {
            "description": "Successful response",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "revenue_by_contact": {
                      "type": "array",
                      "items": {
                        "$ref": "#/components/schemas/contact_report_item"
                      }
                    },
                    "periods": {
                      "type": "array",
                      "description": "Only present when `granularity` is given. One item for each month, quarter or year in `period`, oldest first.",
                      "items": {
                        "type": "object",
                        "required": [
                          "period",
                          "revenue_by_contact"
                        ],
                        "properties": {
                          "period": {
                            "type": "string",
                            "description": "The period of this item, in the same format as the `period` parameter (e.g. `202501..202503`)."
                          },
                          "revenue_by_contact": {
                            "type": "array",
                            "items": {
                              "$ref": "#/components/schemas/contact_report_item"
                            }
                          }
                        }
                      }
                    }
                  }
                },
                "examples": {
                  "ReturnsARevenueByContactReport": {
                    "summary": "Returns a revenue by contact report",
                    "value": {
                      "revenue_by_contact": [
                        {
                          "contact_id": "502689118887610235",
                          "amount": "30.0"
                        }
                      ]
                    }
                  },
                  "SplitsTheRevenueByContactReportIntoPeriodsByGranularity": {
                    "summary": "Splits the revenue by contact report into periods by granularity",
                    "value": {
                      "revenue_by_contact": [
                        {
                          "contact_id": "502689119192745862",
                          "amount": "30.0"
                        }
                      ],
                      "periods": [
                        {
                          "period": "202501..202501",
                          "revenue_by_contact": [
                            {
                              "contact_id": "502689119192745862",
                              "amount": "-50.0"
                            }
                          ]
                        },
                        {
                          "period": "202502..202502",
                          "revenue_by_contact": [
                            {
                              "contact_id": "502689119192745862",
                              "amount": "80.0"
                            }
                          ]
                        }
                      ]
                    }
                  },
                  "ReturnsSuccessForFullPeriod": {
                    "summary": "Returns success for full period",
                    "value": {
                      "revenue_by_contact": [
                        {
                          "contact_id": "502689119358420892",
                          "amount": "30.0"
                        }
                      ]
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "Bad request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/symbolic_error"
                },
                "examples": {
                  "ReturnsErrorWhenPeriodExceedsLimit": {
                    "summary": "Returns error when period exceeds limit",
                    "value": {
                      "error": "Period cannot exceed 12 months"
                    }
                  },
                  "ReturnsErrorForInvalidPeriodFormat": {
                    "summary": "Returns error for invalid period format",
                    "value": {
                      "error": "Period is invalid"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Unauthorized",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/symbolic_error"
                },
                "examples": {
                  "Returns401WhenUserLacksRequiredPermissions": {
                    "summary": "Returns 401 when user lacks required permissions",
                    "value": {
                      "error": "No access to sales_invoices"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "Too many requests - rate limit exceeded",
            "content": {
              "application/json": {
                "schema": {
                  "type": "string",
                  "example": "Retry later"
                },
                "examples": {
                  "Returns429WhenExceedingTheRateLimit": {
                    "summary": "Returns 429 when exceeding the rate limit",
                    "value": "Retry later"
                  }
                }
              }
            },
            "headers": {
              "RateLimit-Limit": {
                "description": "The rate limit ceiling for that given request",
                "schema": {
                  "type": "integer",
                  "example": 150
                }
              },
              "RateLimit-Remaining": {
                "description": "The number of requests left for the time window",
                "schema": {
                  "type": "integer",
                  "example": 149
                }
              },
              "RateLimit-Reset": {
                "description": "The time at which the current rate limit window resets in UTC epoch seconds",
                "schema": {
                  "type": "integer",
                  "example": 1609459200
                }
              },
              "Retry-After": {
                "description": "The time at which the current rate limit window resets in UTC epoch seconds",
                "schema": {
                  "type": "integer",
                  "example": 1609459200
                }
              }
            }
          }
        },
        "operationId": "get_administration_id_reports_revenue_by_contact"
      }
    },
    "/{administration_id}/reports/revenue_by_project{format}": {
      "get": {
        "summary": "Revenue by project report",
        "description": "Returns a revenue by project report for the specified administration.\n\nWith `granularity`, `periods` splits the amounts per month, quarter or year. Within a period, only the projects on this page with bookings in that period are listed.\n\n### Required scope(s)\n `sales_invoices`",
        "tags": [
          "Reports"
        ],
        "security": [
          {
            "bearerAuth": [
              "sales_invoices"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/administration_id"
          },
          {
            "$ref": "#/components/parameters/format"
          },
          {
            "$ref": "#/components/parameters/period"
          },
          {
            "$ref": "#/components/parameters/granularity"
          },
          {
            "$ref": "#/components/parameters/page"
          },
          {
            "$ref": "#/components/parameters/per_page"
          }
        ],
        "responses": {
          "200": {
            "description": "Successful response",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "revenue_by_project": {
                      "type": "array",
                      "items": {
                        "$ref": "#/components/schemas/project_report_item"
                      }
                    },
                    "periods": {
                      "type": "array",
                      "description": "Only present when `granularity` is given. One item for each month, quarter or year in `period`, oldest first.",
                      "items": {
                        "type": "object",
                        "required": [
                          "period",
                          "revenue_by_project"
                        ],
                        "properties": {
                          "period": {
                            "type": "string",
                            "description": "The period of this item, in the same format as the `period` parameter (e.g. `202501..202503`)."
                          },
                          "revenue_by_project": {
                            "type": "array",
                            "items": {
                              "$ref": "#/components/schemas/project_report_item"
                            }
                          }
                        }
                      }
                    }
                  }
                },
                "examples": {
                  "SplitsTheRevenueByProjectReportIntoPeriodsByGranularity": {
                    "summary": "Splits the revenue by project report into periods by granularity",
                    "value": {
                      "revenue_by_project": [
                        {
                          "project_id": null,
                          "amount": "1000.0"
                        },
                        {
                          "project_id": "502689289290647218",
                          "amount": "7000.0"
                        }
                      ],
                      "periods": [
                        {
                          "period": "202501..202501",
                          "revenue_by_project": [
                            {
                              "project_id": "502689289290647218",
                              "amount": "12000.0"
                            }
                          ]
                        },
                        {
                          "period": "202502..202502",
                          "revenue_by_project": [
                            {
                              "project_id": null,
                              "amount": "1000.0"
                            },
                            {
                              "project_id": "502689289290647218",
                              "amount": "-5000.0"
                            }
                          ]
                        }
                      ]
                    }
                  },
                  "ReturnsARevenueByProjectReport": {
                    "summary": "Returns a revenue by project report",
                    "value": {
                      "revenue_by_project": [
                        {
                          "project_id": null,
                          "amount": "1000.0"
                        },
                        {
                          "project_id": "502689289348318913",
                          "amount": "7000.0"
                        }
                      ]
                    }
                  },
                  "ReturnsSuccessForFullPeriod": {
                    "summary": "Returns success for full period",
                    "value": {
                      "revenue_by_project": [
                        {
                          "project_id": null,
                          "amount": "1000.0"
                        },
                        {
                          "project_id": "502689289450030815",
                          "amount": "7000.0"
                        }
                      ]
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "Bad request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/symbolic_error"
                },
                "examples": {
                  "ReturnsErrorForInvalidPeriodFormat": {
                    "summary": "Returns error for invalid period format",
                    "value": {
                      "error": "Period is invalid"
                    }
                  },
                  "ReturnsErrorWhenPeriodExceedsLimit": {
                    "summary": "Returns error when period exceeds limit",
                    "value": {
                      "error": "Period cannot exceed 12 months"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Unauthorized",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/symbolic_error"
                },
                "examples": {
                  "Returns401WhenUserLacksRequiredPermissions": {
                    "summary": "Returns 401 when user lacks required permissions",
                    "value": {
                      "error": "No access to sales_invoices"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "Too many requests - rate limit exceeded",
            "content": {
              "application/json": {
                "schema": {
                  "type": "string",
                  "example": "Retry later"
                },
                "examples": {
                  "Returns429WhenExceedingTheRateLimit": {
                    "summary": "Returns 429 when exceeding the rate limit",
                    "value": "Retry later"
                  }
                }
              }
            },
            "headers": {
              "RateLimit-Limit": {
                "description": "The rate limit ceiling for that given request",
                "schema": {
                  "type": "integer",
                  "example": 150
                }
              },
              "RateLimit-Remaining": {
                "description": "The number of requests left for the time window",
                "schema": {
                  "type": "integer",
                  "example": 149
                }
              },
              "RateLimit-Reset": {
                "description": "The time at which the current rate limit window resets in UTC epoch seconds",
                "schema": {
                  "type": "integer",
                  "example": 1609459200
                }
              },
              "Retry-After": {
                "description": "The time at which the current rate limit window resets in UTC epoch seconds",
                "schema": {
                  "type": "integer",
                  "example": 1609459200
                }
              }
            }
          }
        },
        "operationId": "get_administration_id_reports_revenue_by_project"
      }
    },
    "/{administration_id}/reports/subscriptions{format}": {
      "get": {
        "summary": "Subscriptions report",
        "description": "Get the subscriptions report for the administration. All values are for the last month of the specified period. For example, `this_year` returns the values for December.\n\n### Required scope(s)\n `sales_invoices`",
        "tags": [
          "Reports"
        ],
        "security": [
          {
            "bearerAuth": [
              "sales_invoices"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/administration_id"
          },
          {
            "$ref": "#/components/parameters/format"
          },
          {
            "$ref": "#/components/parameters/period"
          }
        ],
        "responses": {
          "200": {
            "description": "A subscriptions report",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "monthly_recurring_revenue": {
                      "type": "string"
                    },
                    "annual_run_rate": {
                      "type": "string"
                    },
                    "churn_rate": {
                      "type": "string"
                    },
                    "lifetime_value": {
                      "type": "string"
                    }
                  }
                },
                "examples": {
                  "ReturnsASubscriptionsReportJson": {
                    "summary": "Returns a subscriptions report json",
                    "value": {
                      "monthly_recurring_revenue": "75.0",
                      "annual_run_rate": "900.0",
                      "churn_rate": "0",
                      "lifetime_value": "0"
                    }
                  },
                  "ReturnsSuccessForFullPeriod": {
                    "summary": "Returns success for full period",
                    "value": {
                      "monthly_recurring_revenue": "75.0",
                      "annual_run_rate": "900.0",
                      "churn_rate": "0",
                      "lifetime_value": "0"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "Bad request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/symbolic_error"
                },
                "examples": {
                  "ReturnsErrorWhenPeriodExceedsLimit": {
                    "summary": "Returns error when period exceeds limit",
                    "value": {
                      "error": "Period cannot exceed 12 months"
                    }
                  },
                  "ReturnsErrorForInvalidPeriodFormat": {
                    "summary": "Returns error for invalid period format",
                    "value": {
                      "error": "Period is invalid"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Unauthorized",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/symbolic_error"
                },
                "examples": {
                  "Returns401WhenUserLacksRequiredPermissions": {
                    "summary": "Returns 401 when user lacks required permissions",
                    "value": {
                      "error": "No access to sales_invoices"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "Too many requests - rate limit exceeded",
            "content": {
              "application/json": {
                "schema": {
                  "type": "string",
                  "example": "Retry later"
                },
                "examples": {
                  "Returns429WhenExceedingTheRateLimit": {
                    "summary": "Returns 429 when exceeding the rate limit",
                    "value": "Retry later"
                  }
                }
              }
            },
            "headers": {
              "RateLimit-Limit": {
                "description": "The rate limit ceiling for that given request",
                "schema": {
                  "type": "integer",
                  "example": 150
                }
              },
              "RateLimit-Remaining": {
                "description": "The number of requests left for the time window",
                "schema": {
                  "type": "integer",
                  "example": 149
                }
              },
              "RateLimit-Reset": {
                "description": "The time at which the current rate limit window resets in UTC epoch seconds",
                "schema": {
                  "type": "integer",
                  "example": 1609459200
                }
              },
              "Retry-After": {
                "description": "The time at which the current rate limit window resets in UTC epoch seconds",
                "schema": {
                  "type": "integer",
                  "example": 1609459200
                }
              }
            }
          }
        },
        "operationId": "get_administration_id_reports_subscriptions"
      }
    },
    "/{administration_id}/reports/tax{format}": {
      "get": {
        "summary": "Tax report",
        "description": "Get the tax report for the administration.\n\n`tax_rates` at the top level always covers the whole `period`. With `granularity`, `periods` gives the same list per month, quarter or year. Within a period, only the tax rates with a non-zero amount in that period are listed.\n\n### Required scope(s)\n `documents` and `sales_invoices`",
        "tags": [
          "Reports"
        ],
        "security": [
          {
            "bearerAuth": [
              "documents",
              "sales_invoices"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/administration_id"
          },
          {
            "$ref": "#/components/parameters/format"
          },
          {
            "$ref": "#/components/parameters/period"
          },
          {
            "$ref": "#/components/parameters/granularity"
          }
        ],
        "responses": {
          "200": {
            "description": "A tax report",
            "content": {
              "application/json": {
                "schema": {
                  "allOf": [
                    {
                      "$ref": "#/components/schemas/tax_report_amounts"
                    },
                    {
                      "type": "object",
                      "properties": {
                        "periods": {
                          "type": "array",
                          "description": "Only present when `granularity` is given. One item for each month, quarter or year in `period`, oldest first.",
                          "items": {
                            "allOf": [
                              {
                                "type": "object",
                                "required": [
                                  "period"
                                ],
                                "properties": {
                                  "period": {
                                    "type": "string",
                                    "description": "The period of this item, in the same format as the `period` parameter (e.g. `202501..202503`)."
                                  }
                                }
                              },
                              {
                                "$ref": "#/components/schemas/tax_report_amounts"
                              }
                            ]
                          }
                        }
                      }
                    }
                  ]
                },
                "examples": {
                  "SplitsTheTaxReportIntoPeriodsByGranularity": {
                    "summary": "Splits the tax report into periods by granularity",
                    "value": {
                      "tax_rates": [
                        {
                          "tax_rate_id": "502689108899923082",
                          "name": "21% btw",
                          "percentage": "21.0",
                          "report_reference": "NL/1a",
                          "amount": "1200.0",
                          "type": "sales_invoice",
                          "tax": "252.0"
                        },
                        {
                          "tax_rate_id": "502689108908311693",
                          "name": "21% btw",
                          "percentage": "21.0",
                          "report_reference": "NL/5b",
                          "amount": "900.0",
                          "type": "purchase_invoice",
                          "tax": "189.0"
                        }
                      ],
                      "periods": [
                        {
                          "period": "202508..202508",
                          "tax_rates": [
                            {
                              "tax_rate_id": "502689108899923082",
                              "name": "21% btw",
                              "percentage": "21.0",
                              "report_reference": "NL/1a",
                              "amount": "300.0",
                              "type": "sales_invoice",
                              "tax": "63.0"
                            }
                          ]
                        },
                        {
                          "period": "202509..202509",
                          "tax_rates": [
                            {
                              "tax_rate_id": "502689108899923082",
                              "name": "21% btw",
                              "percentage": "21.0",
                              "report_reference": "NL/1a",
                              "amount": "900.0",
                              "type": "sales_invoice",
                              "tax": "189.0"
                            },
                            {
                              "tax_rate_id": "502689108908311693",
                              "name": "21% btw",
                              "percentage": "21.0",
                              "report_reference": "NL/5b",
                              "amount": "900.0",
                              "type": "purchase_invoice",
                              "tax": "189.0"
                            }
                          ]
                        }
                      ]
                    }
                  },
                  "ReturnsATaxReport": {
                    "summary": "Returns a tax report",
                    "value": {
                      "tax_rates": [
                        {
                          "tax_rate_id": "502689108899923082",
                          "name": "21% btw",
                          "percentage": "21.0",
                          "report_reference": "NL/1a",
                          "amount": "900.0",
                          "type": "sales_invoice",
                          "tax": "189.0"
                        },
                        {
                          "tax_rate_id": "502689108908311693",
                          "name": "21% btw",
                          "percentage": "21.0",
                          "report_reference": "NL/5b",
                          "amount": "900.0",
                          "type": "purchase_invoice",
                          "tax": "189.0"
                        }
                      ]
                    }
                  },
                  "ReturnsSuccessForFullPeriod": {
                    "summary": "Returns success for full period",
                    "value": {
                      "tax_rates": [
                        {
                          "tax_rate_id": "502689108899923082",
                          "name": "21% btw",
                          "percentage": "21.0",
                          "report_reference": "NL/1a",
                          "amount": "900.0",
                          "type": "sales_invoice",
                          "tax": "189.0"
                        },
                        {
                          "tax_rate_id": "502689108908311693",
                          "name": "21% btw",
                          "percentage": "21.0",
                          "report_reference": "NL/5b",
                          "amount": "900.0",
                          "type": "purchase_invoice",
                          "tax": "189.0"
                        }
                      ]
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "Bad request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/symbolic_error"
                },
                "examples": {
                  "ReturnsErrorWhenPeriodExceedsLimit": {
                    "summary": "Returns error when period exceeds limit",
                    "value": {
                      "error": "Period cannot exceed 12 months"
                    }
                  },
                  "ReturnsErrorForInvalidPeriodFormat": {
                    "summary": "Returns error for invalid period format",
                    "value": {
                      "error": "Period is invalid"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Unauthorized",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/symbolic_error"
                },
                "examples": {
                  "Returns401WhenUserLacksRequiredPermissions": {
                    "summary": "Returns 401 when user lacks required permissions",
                    "value": {
                      "error": "No access to sales_invoices and documents"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "Too many requests - rate limit exceeded",
            "content": {
              "application/json": {
                "schema": {
                  "type": "string",
                  "example": "Retry later"
                },
                "examples": {
                  "Returns429WhenExceedingTheRateLimit": {
                    "summary": "Returns 429 when exceeding the rate limit",
                    "value": "Retry later"
                  }
                }
              }
            },
            "headers": {
              "RateLimit-Limit": {
                "description": "The rate limit ceiling for that given request",
                "schema": {
                  "type": "integer",
                  "example": 150
                }
              },
              "RateLimit-Remaining": {
                "description": "The number of requests left for the time window",
                "schema": {
                  "type": "integer",
                  "example": 149
                }
              },
              "RateLimit-Reset": {
                "description": "The time at which the current rate limit window resets in UTC epoch seconds",
                "schema": {
                  "type": "integer",
                  "example": 1609459200
                }
              },
              "Retry-After": {
                "description": "The time at which the current rate limit window resets in UTC epoch seconds",
                "schema": {
                  "type": "integer",
                  "example": 1609459200
                }
              }
            }
          }
        },
        "operationId": "get_administration_id_reports_tax"
      }
    },
    "/{administration_id}/reports/working_capital{format}": {
      "get": {
        "summary": "Working capital report",
        "description": "Get the working capital of the administration at the end of the specified period, with the same figures as the balance card on the reports page.\n\nWith `granularity`, `periods` also gives the working capital at the end of every month, quarter or year in the period.\n\n### Required scope(s)\n `bank`",
        "tags": [
          "Reports"
        ],
        "security": [
          {
            "bearerAuth": [
              "bank"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/administration_id"
          },
          {
            "$ref": "#/components/parameters/format"
          },
          {
            "$ref": "#/components/parameters/period"
          },
          {
            "$ref": "#/components/parameters/granularity"
          }
        ],
        "responses": {
          "200": {
            "description": "A working capital report",
            "content": {
              "application/json": {
                "schema": {
                  "allOf": [
                    {
                      "$ref": "#/components/schemas/working_capital_amounts"
                    },
                    {
                      "type": "object",
                      "properties": {
                        "periods": {
                          "type": "array",
                          "description": "Only present when `granularity` is given. One item for each month, quarter or year in `period`, oldest first.",
                          "items": {
                            "allOf": [
                              {
                                "type": "object",
                                "required": [
                                  "period"
                                ],
                                "properties": {
                                  "period": {
                                    "type": "string",
                                    "description": "The period of this item, in the same format as the `period` parameter (e.g. `202501..202503`)."
                                  }
                                }
                              },
                              {
                                "$ref": "#/components/schemas/working_capital_amounts"
                              }
                            ]
                          }
                        }
                      }
                    }
                  ]
                },
                "examples": {
                  "ReturnsTheWorkingCapitalWithAPositiveBankBalanceAtTheEndOfThePeriod": {
                    "summary": "Returns the working capital with a positive bank balance at the end of the period",
                    "value": {
                      "working_capital": "800.0",
                      "bank": "200.0",
                      "to_receive": "900.0",
                      "to_pay": "300.0"
                    }
                  },
                  "CountsANegativeBankBalanceAsToPay": {
                    "summary": "Counts a negative bank balance as to pay",
                    "value": {
                      "working_capital": "400.0",
                      "bank": "0.0",
                      "to_receive": "900.0",
                      "to_pay": "500.0"
                    }
                  },
                  "ReturnsTheWorkingCapitalAtTheEndOfEachPeriodByGranularity": {
                    "summary": "Returns the working capital at the end of each period by granularity",
                    "value": {
                      "working_capital": "600.0",
                      "bank": "0.0",
                      "to_receive": "900.0",
                      "to_pay": "300.0",
                      "periods": [
                        {
                          "period": "202505..202505",
                          "working_capital": "100.0",
                          "bank": "0.0",
                          "to_receive": "100.0",
                          "to_pay": "0.0"
                        },
                        {
                          "period": "202506..202506",
                          "working_capital": "600.0",
                          "bank": "0.0",
                          "to_receive": "900.0",
                          "to_pay": "300.0"
                        }
                      ]
                    }
                  },
                  "ReturnsSuccessForFullPeriod": {
                    "summary": "Returns success for full period",
                    "value": {
                      "working_capital": "600.0",
                      "bank": "0.0",
                      "to_receive": "900.0",
                      "to_pay": "300.0"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "Bad request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/symbolic_error"
                },
                "examples": {
                  "ReturnsErrorForInvalidPeriodFormat": {
                    "summary": "Returns error for invalid period format",
                    "value": {
                      "error": "Period is invalid"
                    }
                  },
                  "ReturnsErrorWhenPeriodExceedsLimit": {
                    "summary": "Returns error when period exceeds limit",
                    "value": {
                      "error": "Period cannot exceed 12 months"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Unauthorized",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/symbolic_error"
                },
                "examples": {
                  "Returns401WhenUserLacksRequiredPermissions": {
                    "summary": "Returns 401 when user lacks required permissions",
                    "value": {
                      "error": "No access to bank"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "Too many requests - rate limit exceeded",
            "content": {
              "application/json": {
                "schema": {
                  "type": "string",
                  "example": "Retry later"
                },
                "examples": {
                  "Returns429WhenExceedingTheRateLimit": {
                    "summary": "Returns 429 when exceeding the rate limit",
                    "value": "Retry later"
                  }
                }
              }
            },
            "headers": {
              "RateLimit-Limit": {
                "description": "The rate limit ceiling for that given request",
                "schema": {
                  "type": "integer",
                  "example": 150
                }
              },
              "RateLimit-Remaining": {
                "description": "The number of requests left for the time window",
                "schema": {
                  "type": "integer",
                  "example": 149
                }
              },
              "RateLimit-Reset": {
                "description": "The time at which the current rate limit window resets in UTC epoch seconds",
                "schema": {
                  "type": "integer",
                  "example": 1609459200
                }
              },
              "Retry-After": {
                "description": "The time at which the current rate limit window resets in UTC epoch seconds",
                "schema": {
                  "type": "integer",
                  "example": 1609459200
                }
              }
            }
          }
        },
        "operationId": "get_administration_id_reports_working_capital"
      }
    },
    "/{administration_id}/sales_invoices/find_by_invoice_id/{invoice_id}{format}": {
      "get": {
        "summary": "Get an invoice by invoice_id",
        "description": "Get a sales invoice by the invoice_id field of the sales invoice.\n\nAn invoice does not have an `invoice_id` when its a draft, so a draft is never found here. List drafts through `GET /sales_invoices` with `state:draft` and fetch one with `GET /sales_invoices/{id}`.\n\n### Required scope(s)\n `sales_invoices`",
        "tags": [
          "Sales invoices"
        ],
        "security": [
          {
            "bearerAuth": [
              "sales_invoices"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/administration_id"
          },
          {
            "name": "invoice_id",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string",
              "description": "Unique invoice identifier",
              "example": "2025-0001"
            }
          },
          {
            "$ref": "#/components/parameters/format"
          }
        ],
        "responses": {
          "200": {
            "description": "A sales invoice",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/sales_invoice_response"
                },
                "examples": {
                  "ReturnsInvoiceByGivenId": {
                    "summary": "Returns invoice by given id",
                    "value": {
                      "id": "502689145432311243",
                      "administration_id": 123,
                      "contact_id": "502689145389319622",
                      "contact": {
                        "id": "502689145389319622",
                        "administration_id": 123,
                        "company_name": "Foobar Holding B.V.",
                        "firstname": null,
                        "lastname": null,
                        "address1": "Hoofdstraat 12",
                        "address2": null,
                        "zipcode": "1234AB",
                        "city": "Amsterdam",
                        "country": "NL",
                        "phone": null,
                        "delivery_method": "Email",
                        "customer_id": "customer-1",
                        "tax_number": null,
                        "chamber_of_commerce": null,
                        "bank_account": null,
                        "is_trusted": false,
                        "max_transfer_amount": null,
                        "attention": null,
                        "email": "info@example.com",
                        "email_ubl": true,
                        "send_invoices_to_attention": null,
                        "send_invoices_to_email": "info@example.com",
                        "send_estimates_to_attention": null,
                        "send_estimates_to_email": "info@example.com",
                        "direct_debit": false,
                        "sepa_active": false,
                        "sepa_iban": null,
                        "sepa_iban_account_name": null,
                        "sepa_bic": null,
                        "sepa_mandate_id": null,
                        "sepa_mandate_date": null,
                        "sepa_sequence_type": "RCUR",
                        "credit_card_number": null,
                        "credit_card_reference": null,
                        "credit_card_type": null,
                        "tax_number_validated_at": null,
                        "tax_number_valid": null,
                        "invoice_workflow_id": null,
                        "estimate_workflow_id": null,
                        "si_identifier": null,
                        "si_identifier_type": null,
                        "moneybird_payments_mandate": false,
                        "created_at": "2026-11-02T12:15:48.814Z",
                        "updated_at": "2026-11-02T12:15:48.814Z",
                        "version": 1793621748,
                        "sales_invoices_url": "https://moneybird.dev/123/sales_invoices/0000000000000000000000000000000000000000000000000000000000000001/all",
                        "notes": [],
                        "custom_fields": [],
                        "contact_people": [],
                        "archived": false
                      },
                      "contact_person_id": "502689145394562504",
                      "contact_person": {
                        "id": null,
                        "contact_id": "502689145389319622",
                        "administration_id": 123,
                        "firstname": "Jan",
                        "lastname": "Janssen",
                        "phone": "123-456-2346",
                        "email": "janjanssen@dev.null.moneybird.net",
                        "department": "Sales",
                        "created_at": "2026-11-02T12:15:48.819Z",
                        "updated_at": "2026-11-02T12:15:48.819Z",
                        "version": 1793621748
                      },
                      "invoice_id": "2026-0001",
                      "recurring_sales_invoice_id": null,
                      "subscription_id": null,
                      "workflow_id": "502689109097055375",
                      "document_style_id": "502689109280556185",
                      "identity_id": "502689108656653419",
                      "draft_id": null,
                      "state": "open",
                      "invoice_date": "2026-11-02",
                      "due_date": "2026-11-16",
                      "payment_conditions": "We verzoeken u vriendelijk het bovenstaande bedrag van {document.total_price} voor {document.due_date} te voldoen op onze bankrekening onder vermelding van de omschrijving {document.payment_reference}. Voor vragen kunt u contact opnemen per e-mail.",
                      "payment_reference": "RF030000000000000PDSZVHZG",
                      "short_payment_reference": "RF03PDSZVHZG",
                      "reference": "Project X",
                      "language": "nl",
                      "currency": "EUR",
                      "discount": "0.0",
                      "original_sales_invoice_id": null,
                      "paused": false,
                      "paid_at": null,
                      "sent_at": "2026-11-02",
                      "created_at": "2026-11-02T12:15:48.856Z",
                      "updated_at": "2026-11-02T12:15:48.920Z",
                      "public_view_code": "923768",
                      "public_view_code_expires_at": "2027-02-02T12:15:48.891Z",
                      "version": 1793621748,
                      "details": [
                        {
                          "id": "502689145435456972",
                          "administration_id": 123,
                          "tax_rate_id": "502689108899923082",
                          "ledger_account_id": "502689108787725434",
                          "project_id": null,
                          "product_id": null,
                          "amount": "1 x",
                          "amount_decimal": "1.0",
                          "description": "Project X",
                          "price": "300.0",
                          "period": null,
                          "row_order": 1,
                          "total_price_excl_tax_with_discount": "300.0",
                          "total_price_excl_tax_with_discount_base": "300.0",
                          "tax_report_reference": [
                            "NL/1a"
                          ],
                          "mandatory_tax_text": null,
                          "created_at": "2026-11-02T12:15:48.858Z",
                          "updated_at": "2026-11-02T12:15:48.919Z"
                        }
                      ],
                      "payments": [],
                      "total_paid": "0.0",
                      "total_unpaid": "363.0",
                      "total_unpaid_base": "363.0",
                      "prices_are_incl_tax": false,
                      "total_price_excl_tax": "300.0",
                      "total_price_excl_tax_base": "300.0",
                      "total_price_incl_tax": "363.0",
                      "total_price_incl_tax_base": "363.0",
                      "total_discount": "0.0",
                      "marked_dubious_on": null,
                      "marked_uncollectible_on": null,
                      "reminder_count": 0,
                      "next_reminder": "2026-11-16",
                      "original_estimate_id": null,
                      "url": "http://moneybird.dev/123/external/0000000000000000000000000000000000000000000000000000000000000001/21b6305b2c4fd1a91d60736aec3b7a2fec530bc3400c561194c14bddb76317ee/sales_invoice",
                      "payment_url": "http://moneybird.dev/123/external/0000000000000000000000000000000000000000000000000000000000000001/21b6305b2c4fd1a91d60736aec3b7a2fec530bc3400c561194c14bddb76317ee/sales_invoice",
                      "custom_fields": [],
                      "notes": [],
                      "attachments": [],
                      "events": [
                        {
                          "administration_id": 123,
                          "user_id": "502689108256097381",
                          "action": "sales_invoice_created",
                          "link_entity_id": null,
                          "link_entity_type": null,
                          "data": {},
                          "created_at": "2026-11-02T12:15:48.860Z",
                          "updated_at": "2026-11-02T12:15:48.860Z"
                        },
                        {
                          "administration_id": 123,
                          "user_id": "502689108256097381",
                          "action": "sales_invoice_state_changed_to_open",
                          "link_entity_id": null,
                          "link_entity_type": null,
                          "data": {},
                          "created_at": "2026-11-02T12:15:48.901Z",
                          "updated_at": "2026-11-02T12:15:48.901Z"
                        },
                        {
                          "administration_id": 123,
                          "user_id": "502689108256097381",
                          "action": "sales_invoice_send_email",
                          "link_entity_id": null,
                          "link_entity_type": null,
                          "data": {
                            "email_address": "info@example.com; janjanssen@dev.null.moneybird.net",
                            "email_message": "Geachte Jan Janssen,\n\nIn de bijlage kunt u factuur 2026-0001 voor onze diensten vinden. Wij verzoeken u vriendelijk de factuur voor 16-11-2026 te voldoen.\n\nMet vriendelijke groet,\n\nParkietje B.V."
                          },
                          "created_at": "2026-11-02T12:15:48.932Z",
                          "updated_at": "2026-11-02T12:15:48.932Z"
                        }
                      ],
                      "tax_totals": [
                        {
                          "tax_rate_id": "502689108899923082",
                          "taxable_amount": "300.0",
                          "taxable_amount_base": "300.0",
                          "tax_amount": "63.0",
                          "tax_amount_base": "63.0"
                        }
                      ],
                      "time_entries": []
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Not found",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/symbolic_error"
                },
                "examples": {
                  "Returns404WhenTheGivenInvoiceIdDoesNotExist": {
                    "summary": "Returns 404 when the given invoice id does not exist",
                    "value": {
                      "error": "Sales invoice with invoice_id: 1337 was not found",
                      "symbolic": {
                        "invoice_id": "not_found"
                      }
                    }
                  }
                }
              }
            }
          }
        },
        "operationId": "get_administration_id_sales_invoices_find_by_invoice_id_invoice_id"
      }
    },
    "/{administration_id}/sales_invoices/find_by_reference/{reference}{format}": {
      "get": {
        "summary": "Get an invoice by reference",
        "description": "Get a sales invoice by the reference field of the sales invoice.\n\n### Required scope(s)\n `sales_invoices`",
        "tags": [
          "Sales invoices"
        ],
        "security": [
          {
            "bearerAuth": [
              "sales_invoices"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/administration_id"
          },
          {
            "name": "reference",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/format"
          }
        ],
        "responses": {
          "200": {
            "description": "A sales invoice",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/sales_invoice_response"
                },
                "examples": {
                  "ReturnsInvoiceByGivenReference": {
                    "summary": "Returns invoice by given reference",
                    "value": {
                      "id": "502689171686557484",
                      "administration_id": 123,
                      "contact_id": "502689171638322983",
                      "contact": {
                        "id": "502689171638322983",
                        "administration_id": 123,
                        "company_name": "Foobar Holding B.V.",
                        "firstname": null,
                        "lastname": null,
                        "address1": "Hoofdstraat 12",
                        "address2": null,
                        "zipcode": "1234AB",
                        "city": "Amsterdam",
                        "country": "NL",
                        "phone": null,
                        "delivery_method": "Email",
                        "customer_id": "customer-1",
                        "tax_number": null,
                        "chamber_of_commerce": null,
                        "bank_account": null,
                        "is_trusted": false,
                        "max_transfer_amount": null,
                        "attention": null,
                        "email": "info@example.com",
                        "email_ubl": true,
                        "send_invoices_to_attention": null,
                        "send_invoices_to_email": "info@example.com",
                        "send_estimates_to_attention": null,
                        "send_estimates_to_email": "info@example.com",
                        "direct_debit": false,
                        "sepa_active": false,
                        "sepa_iban": null,
                        "sepa_iban_account_name": null,
                        "sepa_bic": null,
                        "sepa_mandate_id": null,
                        "sepa_mandate_date": null,
                        "sepa_sequence_type": "RCUR",
                        "credit_card_number": null,
                        "credit_card_reference": null,
                        "credit_card_type": null,
                        "tax_number_validated_at": null,
                        "tax_number_valid": null,
                        "invoice_workflow_id": null,
                        "estimate_workflow_id": null,
                        "si_identifier": null,
                        "si_identifier_type": null,
                        "moneybird_payments_mandate": false,
                        "created_at": "2026-11-02T12:16:13.847Z",
                        "updated_at": "2026-11-02T12:16:13.847Z",
                        "version": 1793621773,
                        "sales_invoices_url": "https://moneybird.dev/123/sales_invoices/0000000000000000000000000000000000000000000000000000000000000001/all",
                        "notes": [],
                        "custom_fields": [],
                        "contact_people": [],
                        "archived": false
                      },
                      "contact_person_id": "502689171641468713",
                      "contact_person": {
                        "id": null,
                        "contact_id": "502689171638322983",
                        "administration_id": 123,
                        "firstname": "Jan",
                        "lastname": "Janssen",
                        "phone": "123-456-2346",
                        "email": "janjanssen@dev.null.moneybird.net",
                        "department": "Sales",
                        "created_at": "2026-11-02T12:16:13.850Z",
                        "updated_at": "2026-11-02T12:16:13.850Z",
                        "version": 1793621773
                      },
                      "invoice_id": "2026-0001",
                      "recurring_sales_invoice_id": null,
                      "subscription_id": null,
                      "workflow_id": "502689109097055375",
                      "document_style_id": "502689109280556185",
                      "identity_id": "502689108656653419",
                      "draft_id": null,
                      "state": "open",
                      "invoice_date": "2026-11-02",
                      "due_date": "2026-11-16",
                      "payment_conditions": "We verzoeken u vriendelijk het bovenstaande bedrag van {document.total_price} voor {document.due_date} te voldoen op onze bankrekening onder vermelding van de omschrijving {document.payment_reference}. Voor vragen kunt u contact opnemen per e-mail.",
                      "payment_reference": "RF12000000000000064GG4PGE",
                      "short_payment_reference": "RF1264GG4PGE",
                      "reference": "invoice-123",
                      "language": "nl",
                      "currency": "EUR",
                      "discount": "0.0",
                      "original_sales_invoice_id": null,
                      "paused": false,
                      "paid_at": null,
                      "sent_at": "2026-11-02",
                      "created_at": "2026-11-02T12:16:13.893Z",
                      "updated_at": "2026-11-02T12:16:13.974Z",
                      "public_view_code": "127222",
                      "public_view_code_expires_at": "2027-02-02T12:16:13.942Z",
                      "version": 1793621773,
                      "details": [
                        {
                          "id": "502689171690751789",
                          "administration_id": 123,
                          "tax_rate_id": "502689108899923082",
                          "ledger_account_id": "502689108787725434",
                          "project_id": null,
                          "product_id": null,
                          "amount": "1 x",
                          "amount_decimal": "1.0",
                          "description": "Project X",
                          "price": "300.0",
                          "period": null,
                          "row_order": 1,
                          "total_price_excl_tax_with_discount": "300.0",
                          "total_price_excl_tax_with_discount_base": "300.0",
                          "tax_report_reference": [
                            "NL/1a"
                          ],
                          "mandatory_tax_text": null,
                          "created_at": "2026-11-02T12:16:13.897Z",
                          "updated_at": "2026-11-02T12:16:13.973Z"
                        }
                      ],
                      "payments": [],
                      "total_paid": "0.0",
                      "total_unpaid": "363.0",
                      "total_unpaid_base": "363.0",
                      "prices_are_incl_tax": false,
                      "total_price_excl_tax": "300.0",
                      "total_price_excl_tax_base": "300.0",
                      "total_price_incl_tax": "363.0",
                      "total_price_incl_tax_base": "363.0",
                      "total_discount": "0.0",
                      "marked_dubious_on": null,
                      "marked_uncollectible_on": null,
                      "reminder_count": 0,
                      "next_reminder": "2026-11-16",
                      "original_estimate_id": null,
                      "url": "http://moneybird.dev/123/external/0000000000000000000000000000000000000000000000000000000000000001/bdf112766af330601aab6cd6dee2859d28aee52821a2e084f4c5e73fa5d6cb6a/sales_invoice",
                      "payment_url": "http://moneybird.dev/123/external/0000000000000000000000000000000000000000000000000000000000000001/bdf112766af330601aab6cd6dee2859d28aee52821a2e084f4c5e73fa5d6cb6a/sales_invoice",
                      "custom_fields": [],
                      "notes": [],
                      "attachments": [],
                      "events": [
                        {
                          "administration_id": 123,
                          "user_id": "502689108256097381",
                          "action": "sales_invoice_created",
                          "link_entity_id": null,
                          "link_entity_type": null,
                          "data": {},
                          "created_at": "2026-11-02T12:16:13.902Z",
                          "updated_at": "2026-11-02T12:16:13.902Z"
                        },
                        {
                          "administration_id": 123,
                          "user_id": "502689108256097381",
                          "action": "sales_invoice_state_changed_to_open",
                          "link_entity_id": null,
                          "link_entity_type": null,
                          "data": {},
                          "created_at": "2026-11-02T12:16:13.952Z",
                          "updated_at": "2026-11-02T12:16:13.952Z"
                        },
                        {
                          "administration_id": 123,
                          "user_id": "502689108256097381",
                          "action": "sales_invoice_send_email",
                          "link_entity_id": null,
                          "link_entity_type": null,
                          "data": {
                            "email_address": "info@example.com; janjanssen@dev.null.moneybird.net",
                            "email_message": "Geachte Jan Janssen,\n\nIn de bijlage kunt u factuur 2026-0001 voor onze diensten vinden. Wij verzoeken u vriendelijk de factuur voor 16-11-2026 te voldoen.\n\nMet vriendelijke groet,\n\nParkietje B.V."
                          },
                          "created_at": "2026-11-02T12:16:13.989Z",
                          "updated_at": "2026-11-02T12:16:13.989Z"
                        }
                      ],
                      "tax_totals": [
                        {
                          "tax_rate_id": "502689108899923082",
                          "taxable_amount": "300.0",
                          "taxable_amount_base": "300.0",
                          "tax_amount": "63.0",
                          "tax_amount_base": "63.0"
                        }
                      ],
                      "time_entries": []
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Not found",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/symbolic_error"
                },
                "examples": {
                  "Returns404WhenTheGivenReferenceDoesNotExist": {
                    "summary": "Returns 404 when the given reference does not exist",
                    "value": {
                      "error": "Sales invoice with reference: 1337 was not found",
                      "symbolic": {
                        "reference": "not_found"
                      }
                    }
                  }
                }
              }
            }
          }
        },
        "operationId": "get_administration_id_sales_invoices_find_by_reference_reference"
      }
    },
    "/{administration_id}/sales_invoices/send_reminders{format}": {
      "post": {
        "summary": "Sends a reminder",
        "description": "This endpoint sends a reminder to a contact. A reminder can contain multiple sales invoices.\nReminders are grouped by workflow, identity and document style, so a contact with sales invoices\nwith different workflows, will receive multiple reminders. Only by grouping reminders like this, we\ncan assure the right content and layout of a reminder.\n\n### Required scope(s)\n `sales_invoices`",
        "tags": [
          "Sales invoices"
        ],
        "security": [
          {
            "bearerAuth": [
              "sales_invoices"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/administration_id"
          },
          {
            "$ref": "#/components/parameters/format"
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/*": {
              "schema": {
                "unevaluatedProperties": false,
                "type": "object",
                "properties": {
                  "sales_invoice_reminders": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "unevaluatedProperties": false,
                      "properties": {
                        "contact_id": {
                          "$ref": "#/components/schemas/identifier"
                        },
                        "workflow_id": {
                          "$ref": "#/components/schemas/identifier"
                        },
                        "document_style_id": {
                          "$ref": "#/components/schemas/identifier"
                        },
                        "identity_id": {
                          "$ref": "#/components/schemas/identifier"
                        },
                        "sales_invoice_ids": {
                          "type": "array",
                          "items": {
                            "$ref": "#/components/schemas/identifier"
                          },
                          "description": "Sales invoices of this contact to include in the reminder."
                        },
                        "reminder_text": {
                          "type": "string",
                          "description": "Message shown in the reminder. Defaults to the text of the next step in the workflow."
                        },
                        "delivery_method": {
                          "type": "string",
                          "enum": [
                            "Email",
                            "Manual"
                          ],
                          "description": "How the reminder is delivered. Defaults to the contact's delivery method."
                        },
                        "email_address": {
                          "type": "string",
                          "description": "Recipient email address. Only used when `delivery_method` is `Email`; defaults to the contact's email address."
                        }
                      },
                      "required": [
                        "contact_id",
                        "workflow_id",
                        "document_style_id",
                        "identity_id",
                        "sales_invoice_ids"
                      ]
                    }
                  }
                },
                "required": [
                  "sales_invoice_reminders"
                ]
              }
            }
          }
        },
        "responses": {
          "200": {
            "$ref": "#/components/responses/status_code"
          },
          "400": {
            "$ref": "#/components/responses/400_bad_request"
          },
          "422": {
            "$ref": "#/components/responses/422_unprocessable_entity"
          }
        },
        "operationId": "post_administration_id_sales_invoices_send_reminders"
      }
    },
    "/{administration_id}/sales_invoices/synchronization{format}": {
      "get": {
        "summary": "List all ids and versions",
        "description": "Returns all sales invoices in the administration. The list contains the invoice id and the version of the invoice.\nCheck if the version of the invoice is newer than the version you have stored locally, use the `POST`\nvariant for fetching invoices with the given ids.\n\n### Required scope(s)\n `sales_invoices`",
        "tags": [
          "Sales invoices"
        ],
        "security": [
          {
            "bearerAuth": [
              "sales_invoices"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/administration_id"
          },
          {
            "$ref": "#/components/parameters/format"
          },
          {
            "name": "filter",
            "in": "query",
            "required": false,
            "description": "Comma-separated `key:value` filter terms. Same syntax as `GET /sales_invoices` — see that operation's description for the available keys.",
            "schema": {
              "type": "string"
            },
            "examples": {
              "RetrievesTheIdSForSynchronizationWithAFilter": {
                "summary": "Retrieves the id's for synchronization with a filter",
                "value": "state:open"
              }
            }
          }
        ],
        "responses": {
          "200": {
            "description": "IDs and versions of records",
            "content": {
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "type": "object",
                    "unevaluatedProperties": false,
                    "properties": {
                      "id": {
                        "type": [
                          "integer",
                          "string"
                        ]
                      },
                      "version": {
                        "type": [
                          "integer",
                          "string"
                        ]
                      }
                    }
                  }
                },
                "examples": {
                  "RetrievesTheIdSForSynchronization": {
                    "summary": "Retrieves the id's for synchronization",
                    "value": [
                      {
                        "id": "502689159133005037",
                        "version": 1793621761
                      },
                      {
                        "id": "502689159025001694",
                        "version": 1793621761
                      },
                      {
                        "id": "502689158906512591",
                        "version": 1793621761
                      },
                      {
                        "id": "502689158800606399",
                        "version": 1793621761
                      }
                    ]
                  },
                  "RetrievesTheIdSForSynchronizationWithAFilter": {
                    "summary": "Retrieves the id's for synchronization with a filter",
                    "value": [
                      {
                        "id": "502689159670924591",
                        "version": 1793621762
                      },
                      {
                        "id": "502689159777879359",
                        "version": 1793621762
                      },
                      {
                        "id": "502689159900562766",
                        "version": 1793621762
                      }
                    ]
                  }
                }
              }
            }
          },
          "400": {
            "description": "Bad request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/symbolic_error"
                },
                "examples": {
                  "ReturnsA400WhenTheFilterHasAnInvalidValue": {
                    "summary": "Returns a 400 when the filter has an invalid value",
                    "value": {
                      "error": "Status is not included in the list",
                      "symbolic": {
                        "filter": "invalid"
                      }
                    }
                  }
                }
              }
            }
          }
        },
        "operationId": "get_administration_id_sales_invoices_synchronization"
      },
      "post": {
        "summary": "Fetch sales invoices with given ids",
        "x-query": true,
        "description": "Given a list of sales invoice ids, returns the sales invoice information belonging to the invoices.\nReturns a maximum of 100 invoice, even if more ids are provided.\n\n### Required scope(s)\n `sales_invoices`",
        "tags": [
          "Sales invoices"
        ],
        "security": [
          {
            "bearerAuth": [
              "sales_invoices"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/administration_id"
          },
          {
            "$ref": "#/components/parameters/format"
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/*": {
              "schema": {
                "unevaluatedProperties": false,
                "type": "object",
                "properties": {
                  "ids": {
                    "type": "array",
                    "items": {
                      "type": [
                        "integer",
                        "string"
                      ]
                    }
                  }
                },
                "required": [
                  "ids"
                ]
              },
              "examples": {
                "RetrievesSalesInvoicesGivenByIds": {
                  "summary": "Retrieves sales invoices given by ids",
                  "value": {
                    "ids": [
                      502689158146294900,
                      502689158263735400
                    ]
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "A list of sales invoices",
            "content": {
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "$ref": "#/components/schemas/sales_invoice_response"
                  }
                },
                "examples": {
                  "RetrievesSalesInvoicesGivenByIds": {
                    "summary": "Retrieves sales invoices given by ids",
                    "value": [
                      {
                        "id": "502689158263735414",
                        "administration_id": 123,
                        "contact_id": "502689157977474130",
                        "contact": {
                          "id": "502689157977474130",
                          "administration_id": 123,
                          "company_name": "Foobar Holding B.V.",
                          "firstname": null,
                          "lastname": null,
                          "address1": "Hoofdstraat 12",
                          "address2": null,
                          "zipcode": "1234AB",
                          "city": "Amsterdam",
                          "country": "NL",
                          "phone": null,
                          "delivery_method": "Email",
                          "customer_id": "customer-1",
                          "tax_number": null,
                          "chamber_of_commerce": null,
                          "bank_account": null,
                          "is_trusted": false,
                          "max_transfer_amount": null,
                          "attention": null,
                          "email": "info@example.com",
                          "email_ubl": true,
                          "send_invoices_to_attention": null,
                          "send_invoices_to_email": "info@example.com",
                          "send_estimates_to_attention": null,
                          "send_estimates_to_email": "info@example.com",
                          "direct_debit": false,
                          "sepa_active": false,
                          "sepa_iban": null,
                          "sepa_iban_account_name": null,
                          "sepa_bic": null,
                          "sepa_mandate_id": null,
                          "sepa_mandate_date": null,
                          "sepa_sequence_type": "RCUR",
                          "credit_card_number": null,
                          "credit_card_reference": null,
                          "credit_card_type": null,
                          "tax_number_validated_at": null,
                          "tax_number_valid": null,
                          "invoice_workflow_id": null,
                          "estimate_workflow_id": null,
                          "si_identifier": null,
                          "si_identifier_type": null,
                          "moneybird_payments_mandate": false,
                          "created_at": "2026-11-02T12:16:00.819Z",
                          "updated_at": "2026-11-02T12:16:00.819Z",
                          "version": 1793621760,
                          "sales_invoices_url": "https://moneybird.dev/123/sales_invoices/0000000000000000000000000000000000000000000000000000000000000001/all",
                          "notes": [],
                          "custom_fields": [],
                          "contact_people": [],
                          "archived": false
                        },
                        "contact_person_id": null,
                        "contact_person": null,
                        "invoice_id": "2026-0003",
                        "recurring_sales_invoice_id": null,
                        "subscription_id": null,
                        "workflow_id": "502689109097055375",
                        "document_style_id": "502689109280556185",
                        "identity_id": "502689108656653419",
                        "draft_id": null,
                        "state": "open",
                        "invoice_date": "2026-11-02",
                        "due_date": "2026-11-16",
                        "payment_conditions": "We verzoeken u vriendelijk het bovenstaande bedrag van {document.total_price} voor {document.due_date} te voldoen op onze bankrekening onder vermelding van de omschrijving {document.payment_reference}. Voor vragen kunt u contact opnemen per e-mail.",
                        "payment_reference": "RF0200000000000007U29PYYM",
                        "short_payment_reference": "RF027U29PYYM",
                        "reference": "Project X",
                        "language": "nl",
                        "currency": "EUR",
                        "discount": "0.0",
                        "original_sales_invoice_id": null,
                        "paused": false,
                        "paid_at": null,
                        "sent_at": "2026-11-02",
                        "created_at": "2026-11-02T12:16:01.092Z",
                        "updated_at": "2026-11-02T12:16:01.165Z",
                        "public_view_code": "531223",
                        "public_view_code_expires_at": "2027-02-02T12:16:01.128Z",
                        "version": 1793621761,
                        "details": [
                          {
                            "id": "502689158266881143",
                            "administration_id": 123,
                            "tax_rate_id": "502689108899923082",
                            "ledger_account_id": "502689108787725434",
                            "project_id": null,
                            "product_id": null,
                            "amount": "1 x",
                            "amount_decimal": "1.0",
                            "description": "Project X",
                            "price": "300.0",
                            "period": null,
                            "row_order": 1,
                            "total_price_excl_tax_with_discount": "300.0",
                            "total_price_excl_tax_with_discount_base": "300.0",
                            "tax_report_reference": [
                              "NL/1a"
                            ],
                            "mandatory_tax_text": null,
                            "created_at": "2026-11-02T12:16:01.095Z",
                            "updated_at": "2026-11-02T12:16:01.165Z"
                          }
                        ],
                        "payments": [],
                        "total_paid": "0.0",
                        "total_unpaid": "363.0",
                        "total_unpaid_base": "363.0",
                        "prices_are_incl_tax": false,
                        "total_price_excl_tax": "300.0",
                        "total_price_excl_tax_base": "300.0",
                        "total_price_incl_tax": "363.0",
                        "total_price_incl_tax_base": "363.0",
                        "total_discount": "0.0",
                        "marked_dubious_on": null,
                        "marked_uncollectible_on": null,
                        "reminder_count": 0,
                        "next_reminder": "2026-11-16",
                        "original_estimate_id": null,
                        "url": "http://moneybird.dev/123/external/0000000000000000000000000000000000000000000000000000000000000001/8ba2cb07c849fdd65160c85cfd8126c3fba771d27a4e493e27d6d180c1d7abb6/sales_invoice",
                        "payment_url": "http://moneybird.dev/123/external/0000000000000000000000000000000000000000000000000000000000000001/8ba2cb07c849fdd65160c85cfd8126c3fba771d27a4e493e27d6d180c1d7abb6/sales_invoice",
                        "custom_fields": [],
                        "notes": [],
                        "attachments": [],
                        "events": [
                          {
                            "administration_id": 123,
                            "user_id": "502689108256097381",
                            "action": "sales_invoice_created",
                            "link_entity_id": null,
                            "link_entity_type": null,
                            "data": {},
                            "created_at": "2026-11-02T12:16:01.098Z",
                            "updated_at": "2026-11-02T12:16:01.098Z"
                          },
                          {
                            "administration_id": 123,
                            "user_id": "502689108256097381",
                            "action": "sales_invoice_state_changed_to_open",
                            "link_entity_id": null,
                            "link_entity_type": null,
                            "data": {},
                            "created_at": "2026-11-02T12:16:01.146Z",
                            "updated_at": "2026-11-02T12:16:01.146Z"
                          },
                          {
                            "administration_id": 123,
                            "user_id": "502689108256097381",
                            "action": "sales_invoice_send_email",
                            "link_entity_id": null,
                            "link_entity_type": null,
                            "data": {
                              "email_address": "info@example.com",
                              "email_message": "Geachte Foobar Holding B.V.,\n\nIn de bijlage kunt u factuur 2026-0003 voor onze diensten vinden. Wij verzoeken u vriendelijk de factuur voor 16-11-2026 te voldoen.\n\nMet vriendelijke groet,\n\nParkietje B.V."
                            },
                            "created_at": "2026-11-02T12:16:01.178Z",
                            "updated_at": "2026-11-02T12:16:01.178Z"
                          }
                        ],
                        "tax_totals": [
                          {
                            "tax_rate_id": "502689108899923082",
                            "taxable_amount": "300.0",
                            "taxable_amount_base": "300.0",
                            "tax_amount": "63.0",
                            "tax_amount_base": "63.0"
                          }
                        ],
                        "time_entries": []
                      },
                      {
                        "id": "502689158146294887",
                        "administration_id": 123,
                        "contact_id": "502689157977474130",
                        "contact": {
                          "id": "502689157977474130",
                          "administration_id": 123,
                          "company_name": "Foobar Holding B.V.",
                          "firstname": null,
                          "lastname": null,
                          "address1": "Hoofdstraat 12",
                          "address2": null,
                          "zipcode": "1234AB",
                          "city": "Amsterdam",
                          "country": "NL",
                          "phone": null,
                          "delivery_method": "Email",
                          "customer_id": "customer-1",
                          "tax_number": null,
                          "chamber_of_commerce": null,
                          "bank_account": null,
                          "is_trusted": false,
                          "max_transfer_amount": null,
                          "attention": null,
                          "email": "info@example.com",
                          "email_ubl": true,
                          "send_invoices_to_attention": null,
                          "send_invoices_to_email": "info@example.com",
                          "send_estimates_to_attention": null,
                          "send_estimates_to_email": "info@example.com",
                          "direct_debit": false,
                          "sepa_active": false,
                          "sepa_iban": null,
                          "sepa_iban_account_name": null,
                          "sepa_bic": null,
                          "sepa_mandate_id": null,
                          "sepa_mandate_date": null,
                          "sepa_sequence_type": "RCUR",
                          "credit_card_number": null,
                          "credit_card_reference": null,
                          "credit_card_type": null,
                          "tax_number_validated_at": null,
                          "tax_number_valid": null,
                          "invoice_workflow_id": null,
                          "estimate_workflow_id": null,
                          "si_identifier": null,
                          "si_identifier_type": null,
                          "moneybird_payments_mandate": false,
                          "created_at": "2026-11-02T12:16:00.819Z",
                          "updated_at": "2026-11-02T12:16:00.819Z",
                          "version": 1793621760,
                          "sales_invoices_url": "https://moneybird.dev/123/sales_invoices/0000000000000000000000000000000000000000000000000000000000000001/all",
                          "notes": [],
                          "custom_fields": [],
                          "contact_people": [],
                          "archived": false
                        },
                        "contact_person_id": null,
                        "contact_person": null,
                        "invoice_id": "2026-0002",
                        "recurring_sales_invoice_id": null,
                        "subscription_id": null,
                        "workflow_id": "502689109097055375",
                        "document_style_id": "502689109280556185",
                        "identity_id": "502689108656653419",
                        "draft_id": null,
                        "state": "open",
                        "invoice_date": "2026-11-02",
                        "due_date": "2026-11-16",
                        "payment_conditions": "We verzoeken u vriendelijk het bovenstaande bedrag van {document.total_price} voor {document.due_date} te voldoen op onze bankrekening onder vermelding van de omschrijving {document.payment_reference}. Voor vragen kunt u contact opnemen per e-mail.",
                        "payment_reference": "RF1300000000000002JK7F5QW",
                        "short_payment_reference": "RF132JK7F5QW",
                        "reference": "Project X",
                        "language": "nl",
                        "currency": "EUR",
                        "discount": "0.0",
                        "original_sales_invoice_id": null,
                        "paused": false,
                        "paid_at": null,
                        "sent_at": "2026-11-02",
                        "created_at": "2026-11-02T12:16:00.980Z",
                        "updated_at": "2026-11-02T12:16:01.050Z",
                        "public_view_code": "420684",
                        "public_view_code_expires_at": "2027-02-02T12:16:01.018Z",
                        "version": 1793621761,
                        "details": [
                          {
                            "id": "502689158148392040",
                            "administration_id": 123,
                            "tax_rate_id": "502689108899923082",
                            "ledger_account_id": "502689108787725434",
                            "project_id": null,
                            "product_id": null,
                            "amount": "1 x",
                            "amount_decimal": "1.0",
                            "description": "Project X",
                            "price": "300.0",
                            "period": null,
                            "row_order": 1,
                            "total_price_excl_tax_with_discount": "300.0",
                            "total_price_excl_tax_with_discount_base": "300.0",
                            "tax_report_reference": [
                              "NL/1a"
                            ],
                            "mandatory_tax_text": null,
                            "created_at": "2026-11-02T12:16:00.982Z",
                            "updated_at": "2026-11-02T12:16:01.048Z"
                          }
                        ],
                        "payments": [],
                        "total_paid": "0.0",
                        "total_unpaid": "363.0",
                        "total_unpaid_base": "363.0",
                        "prices_are_incl_tax": false,
                        "total_price_excl_tax": "300.0",
                        "total_price_excl_tax_base": "300.0",
                        "total_price_incl_tax": "363.0",
                        "total_price_incl_tax_base": "363.0",
                        "total_discount": "0.0",
                        "marked_dubious_on": null,
                        "marked_uncollectible_on": null,
                        "reminder_count": 0,
                        "next_reminder": "2026-11-16",
                        "original_estimate_id": null,
                        "url": "http://moneybird.dev/123/external/0000000000000000000000000000000000000000000000000000000000000001/65049ee7f67b1db67787486b15d54e2f20ddce0435e4617bdc42dea61704f657/sales_invoice",
                        "payment_url": "http://moneybird.dev/123/external/0000000000000000000000000000000000000000000000000000000000000001/65049ee7f67b1db67787486b15d54e2f20ddce0435e4617bdc42dea61704f657/sales_invoice",
                        "custom_fields": [],
                        "notes": [],
                        "attachments": [],
                        "events": [
                          {
                            "administration_id": 123,
                            "user_id": "502689108256097381",
                            "action": "sales_invoice_created",
                            "link_entity_id": null,
                            "link_entity_type": null,
                            "data": {},
                            "created_at": "2026-11-02T12:16:00.985Z",
                            "updated_at": "2026-11-02T12:16:00.985Z"
                          },
                          {
                            "administration_id": 123,
                            "user_id": "502689108256097381",
                            "action": "sales_invoice_state_changed_to_open",
                            "link_entity_id": null,
                            "link_entity_type": null,
                            "data": {},
                            "created_at": "2026-11-02T12:16:01.029Z",
                            "updated_at": "2026-11-02T12:16:01.029Z"
                          },
                          {
                            "administration_id": 123,
                            "user_id": "502689108256097381",
                            "action": "sales_invoice_send_email",
                            "link_entity_id": null,
                            "link_entity_type": null,
                            "data": {
                              "email_address": "info@example.com",
                              "email_message": "Geachte Foobar Holding B.V.,\n\nIn de bijlage kunt u factuur 2026-0002 voor onze diensten vinden. Wij verzoeken u vriendelijk de factuur voor 16-11-2026 te voldoen.\n\nMet vriendelijke groet,\n\nParkietje B.V."
                            },
                            "created_at": "2026-11-02T12:16:01.064Z",
                            "updated_at": "2026-11-02T12:16:01.064Z"
                          }
                        ],
                        "tax_totals": [
                          {
                            "tax_rate_id": "502689108899923082",
                            "taxable_amount": "300.0",
                            "taxable_amount_base": "300.0",
                            "tax_amount": "63.0",
                            "tax_amount_base": "63.0"
                          }
                        ],
                        "time_entries": []
                      }
                    ]
                  }
                }
              }
            }
          },
          "400": {
            "$ref": "#/components/responses/400_bad_request"
          }
        },
        "operationId": "post_administration_id_sales_invoices_synchronization"
      }
    },
    "/{administration_id}/sales_invoices/{id}/attachments{format}": {
      "post": {
        "summary": "Add attachment to sales invoice",
        "description": "Add an attachment to a sales invoice.\n\n### Required scope(s)\n `sales_invoices`",
        "tags": [
          "Sales invoices"
        ],
        "security": [
          {
            "bearerAuth": [
              "sales_invoices"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/administration_id"
          },
          {
            "name": "id",
            "in": "path",
            "required": true,
            "schema": {
              "$ref": "#/components/schemas/identifier"
            }
          },
          {
            "$ref": "#/components/parameters/format"
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "multipart/form-data": {
              "schema": {
                "type": "object",
                "properties": {
                  "file": {
                    "type": "string",
                    "format": "binary"
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Status code",
            "content": {
              "application/json": {
                "schema": {
                  "type": "integer"
                },
                "examples": {
                  "UploadsAnAttachment": {
                    "summary": "Uploads an attachment",
                    "value": 200
                  }
                }
              }
            }
          },
          "400": {
            "$ref": "#/components/responses/400_bad_request"
          },
          "404": {
            "$ref": "#/components/responses/404_not_found"
          },
          "422": {
            "$ref": "#/components/responses/422_unprocessable_entity"
          }
        },
        "operationId": "post_administration_id_sales_invoices_id_attachments"
      }
    },
    "/{administration_id}/sales_invoices/{id}/download_packing_slip_pdf{format}": {
      "get": {
        "summary": "Download sales invoice packing slip PDF by id",
        "description": "Redirects to the download URL of the sales invoice as packing slip PDF. The link is valid for 30 seconds.\n\n### Required scope(s)\n `sales_invoices`",
        "tags": [
          "Sales invoices"
        ],
        "security": [
          {
            "bearerAuth": [
              "sales_invoices"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/administration_id"
          },
          {
            "name": "id",
            "in": "path",
            "required": true,
            "schema": {
              "$ref": "#/components/schemas/identifier"
            }
          },
          {
            "$ref": "#/components/parameters/format"
          },
          {
            "name": "media",
            "in": "query",
            "required": false,
            "schema": {
              "type": "string",
              "description": "In case you want to hide sender address and logo you can set this to 'stationery'."
            }
          }
        ],
        "responses": {
          "302": {
            "description": "Found",
            "content": {
              "text/plain": {
                "schema": {
                  "type": "string"
                },
                "examples": {
                  "ReturnsInvoiceByGivenIdAsPackingSlipPdf": {
                    "summary": "Returns invoice by given id as packing slip pdf",
                    "value": "\"This resource has been moved temporarily to http://moneybird-storage-develop-moneybird-storage-sandbox-de-175c5207.ci.svc.cluster.local:80/c4b189d2d6e8e9c9a3d73fbc058fa7a2190a2658dab50047023d0d47f22923f1/35c8c3d46aecccb58db8f684afcc6954eb77fdcd4599e4c4c7195ab7c110440b/download.\""
                  }
                }
              }
            }
          },
          "404": {
            "description": "Not found",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/symbolic_error"
                },
                "examples": {
                  "Returns404WhenInvoiceDoesNotExist": {
                    "summary": "Returns 404 when invoice does not exist",
                    "value": {
                      "error": "record not found",
                      "symbolic": {
                        "id": "not_found"
                      }
                    }
                  }
                }
              }
            }
          }
        },
        "operationId": "get_administration_id_sales_invoices_id_download_packing_slip_pdf"
      }
    },
    "/{administration_id}/sales_invoices/{id}/download_pdf{format}": {
      "get": {
        "summary": "Download sales invoice PDF by id",
        "description": "Redirects to the download URL of the sales invoice as PDF. The link is valid for 30 seconds.\n\n### Required scope(s)\n `sales_invoices`",
        "tags": [
          "Sales invoices"
        ],
        "security": [
          {
            "bearerAuth": [
              "sales_invoices"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/administration_id"
          },
          {
            "name": "id",
            "in": "path",
            "required": true,
            "schema": {
              "$ref": "#/components/schemas/identifier"
            }
          },
          {
            "$ref": "#/components/parameters/format"
          },
          {
            "name": "media",
            "in": "query",
            "required": false,
            "schema": {
              "type": "string",
              "description": "In case you want to hide sender address and logo you can set this to 'stationery'."
            }
          }
        ],
        "responses": {
          "302": {
            "description": "Found",
            "content": {
              "text/plain": {
                "schema": {
                  "type": "string"
                },
                "examples": {
                  "ReturnsInvoiceByGivenIdAsPdf": {
                    "summary": "Returns invoice by given id as pdf",
                    "value": "\"This resource has been moved temporarily to http://moneybird-storage-develop-moneybird-storage-sandbox-de-175c5207.ci.svc.cluster.local:80/4adf497f3ec19c21b5d05508e7a0951e5c29ac479d63ba9149542d816b66c510/ee860b7b5ca97065b0357d24f18e891ba34db720123eb3ffb052b1183c9c4e88/download.\""
                  }
                }
              }
            }
          },
          "404": {
            "description": "Not found",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/symbolic_error"
                },
                "examples": {
                  "Returns404WhenInvoiceDoesNotExist": {
                    "summary": "Returns 404 when invoice does not exist",
                    "value": {
                      "error": "record not found",
                      "symbolic": {
                        "id": "not_found"
                      }
                    }
                  }
                }
              }
            }
          }
        },
        "operationId": "get_administration_id_sales_invoices_id_download_pdf"
      }
    },
    "/{administration_id}/sales_invoices/{id}/download_ubl{format}": {
      "get": {
        "summary": "Download sales invoice UBL by id",
        "description": "Download the sales invoice as UBL.\n\n### Required scope(s)\n `sales_invoices`",
        "tags": [
          "Sales invoices"
        ],
        "security": [
          {
            "bearerAuth": [
              "sales_invoices"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/administration_id"
          },
          {
            "name": "id",
            "in": "path",
            "required": true,
            "schema": {
              "$ref": "#/components/schemas/identifier"
            }
          },
          {
            "$ref": "#/components/parameters/format"
          }
        ],
        "responses": {
          "200": {
            "description": "A sales invoice",
            "content": {
              "text/xml": {
                "schema": {
                  "type": "string"
                },
                "examples": {
                  "ReturnsInvoiceByGivenIdAsUbl": {
                    "summary": "Returns invoice by given id as ubl",
                    "value": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<Invoice xmlns:cbc=\"urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-2\" xmlns:cac=\"urn:oasis:names:specification:ubl:schema:xsd:CommonAggregateComponents-2\" xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:schemaLocation=\"urn:oasis:names:specification:ubl:schema:xsd:Invoice-2 UBL-Invoice-2.1.xsd\" xmlns=\"urn:oasis:names:specification:ubl:schema:xsd:Invoice-2\">\n  <cbc:UBLVersionID>2.1</cbc:UBLVersionID>\n  \n  \n  <cbc:ID>2019-0001</cbc:ID>\n  <cbc:IssueDate>2019-10-01</cbc:IssueDate>\n  <cbc:DueDate>2019-10-15</cbc:DueDate>\n  <cbc:InvoiceTypeCode listID=\"UNCL1001\" listAgencyID=\"6\">380</cbc:InvoiceTypeCode>\n  <cbc:DocumentCurrencyCode listID=\"ISO4217\" listAgencyID=\"6\">EUR</cbc:DocumentCurrencyCode>\n  <cac:OrderReference>\n    <cbc:ID>Project X</cbc:ID>\n  </cac:OrderReference>\n  <cac:AdditionalDocumentReference>\n    <cbc:ID>2019-0001.pdf</cbc:ID>\n    <cbc:DocumentType>PrimaryImage</cbc:DocumentType>\n    <cac:Attachment>\n      <cbc:EmbeddedDocumentBinaryObject mimeCode=\"application/pdf\" filename=\"2019-0001.pdf\">JVBERi0xLjMK/////woxIDAgb2JqCjw8IC9DcmVhdG9yIChQcmF3bikKL1By\nb2R1Y2VyIChQcmF3bikKPj4KZW5kb2JqCjIgMCBvYmoKPDwgL0tpZHMgWzUg\nMCBSXQovVHlwZSAvUGFnZXMKL0NvdW50IDEKPj4KZW5kb2JqCjMgMCBvYmoK\nPDwgL1BhZ2VzIDIgMCBSCi9UeXBlIC9DYXRhbG9nCj4+CmVuZG9iago0IDAg\nb2JqCjw8IC9MZW5ndGggMzg4Nwo+PgpzdHJlYW0KMC4wMDAgMC4wMDAgMC4w\nMDAgcmcKMC4wMDAgMC4wMDAgMC4wMDAgUkcKcQpCVAoxLjAwMCAwLjAwMCAt\nMC4wMDAgMS4wMDAgNDA5LjI4MCA4MTUuODkwIFRtCjAgLTUuNzQ0IFRkCjAu\nMDAwIDAuMDAwIDAuMDAwIHJnCjAgVHMKL0YxLjAgOCBUZgpbPDU1NzcyMDQy\nNjU2NDcyPiAtMTUgPDY5NmE2NjczMmQ0ZTYxNjE2ZDIwNDI+IDIwIDwyZTU2\nPiAxMjUgPDJlPl0gVEoKMCAtOS4yNDggVGQKWzw0NzcyNmY3NDY1MjA0ZDYx\nNzI+IC0xNSA8NmI3NDIwMzEzMDMwPl0gVEoKMCAtOS4yNDggVGQKWzwzMTMx\nMzIzMjIwNDE0MTIwNDU2ZTczNjM2ODY1NjQ2NT5dIFRKCjAgLTkuMjQ4IFRk\nCjAgLTkuMjQ4IFRkCls8NmI3NjZiMmU+IDYwIDwyMDMxMzIzMzM0MzUzOTM4\nMzczNj5dIFRKCjAgLTkuMjQ4IFRkCls8NjI3NDc3PiA2MCA8MmU+IDYwIDwy\nMDM4MzIzMzM5MzMzNjM1MzMzOD5dIFRKCjAgLTkuMjQ4IFRkCjAgLTkuMjQ4\nIFRkCi9GMi4wIDggVGYKWzw0NTJkNmQ2MTY5NmMzYT5dIFRKCi9GMS4wIDgg\nVGYKWzwyMDY5NmU2Nj4gMzAgPDZmNDA3NTc3NjI2NTY0NzI+IC0xNSA8Njk2\nYTY2NzMyZDJkNmU2MTYxNmQyZTZlNmM+XSBUSgpFVAoKcQoyMDAuMDAwIDAg\nMCA4MC4wMDAgMzYuMDAwIDczNS44OTAgY20KL0kxIERvClEKCkJUCjY2IDY5\nOS40MjggVGQKL0YxLjAgOSBUZgpbPDQyNmY2ZjZiNzM2ODZmNzAwYT5dIFRK\nCkVUCgoKQlQKNjYgNjg5LjAyNCBUZAovRjEuMCA5IFRmCls8NTQ+IDEyMCA8\nMmU2MTJlNzY+IDgwIDwyZT4gNjAgPDIwNGE2ZjczMjA3Nj4gMjUgPDYxNmUy\nMDY0NjU3MjIwNGQ2ZjZjNjU2ZTBhPl0gVEoKRVQKCgpCVAo2NiA2NzguNjIg\nVGQKL0YxLjAgOSBUZgpbPDRmNzg2Nj4gMzAgPDZmNzI2NDBhPl0gVEoKRVQK\nCgpCVAo2NiA2NjguMjE2IFRkCi9GMS4wIDkgVGYKWzwwYT5dIFRKCkVUCgoK\nQlQKNjYgNjU3LjgxMiBUZAovRjEuMCA5IFRmCls8MGE+XSBUSgpFVAoKCkJU\nCjM2IDU4MC45NDYgVGQKL0YxLjAgMTggVGYKWzw0Nj4gNTAgPDYxNjM3NDc1\nNzU3MjIwMzIzMDMxMzAyZDMwMzEzMTMyPl0gVEoKRVQKCgpCVAo0MDguNjQg\nNTkxLjk3MiBUZAovRjEuMCA5IFRmCls8NDY+IDUwIDw2MTYzNzQ3NTc1NzI2\nNDYxNzQ3NTZkM2E+IDUwIDwyMD5dIFRKCkVUCgowLjAwMCAwLjAwMCAwLjAw\nMCByZwoKQlQKNTA1LjYxNCA1OTEuOTcyIFRkCi9GMS4wIDkgVGYKWzwzMTM4\nMmQzMDM5MmQzMjMwMzEzMD5dIFRKCkVUCgowLjAwMCAwLjAwMCAwLjAwMCBy\nZwoKQlQKNDA4LjY0IDU3OC4xIFRkCi9GMS4wIDkgVGYKWzw1Nj4gODAgPDY1\nNzI+IC0zMCA8NzY+IDI1IDw2MTZjNjQ2MTc0NzU2ZDNhPiA1MCA8MjA+XSBU\nSgpFVAoKMC4wMDAgMC4wMDAgMC4wMDAgcmcKCkJUCjUwNS42MTQgNTc4LjEg\nVGQKL0YxLjAgOSBUZgpbPDMwMzIyZDMxMzAyZDMyMzAzMTMwPl0gVEoKRVQK\nCjAuMDAwIDAuMDAwIDAuMDAwIHJnCjAuNSB3CjAuMDAwIDAuMDAwIDAuMDAw\nIFJHCjEgdwowLjAwMCAwLjAwMCAwLjAwMCBSRwowLjUgdwowLjAwMCAwLjAw\nMCAwLjAwMCByZwoxIHcKMC4wMDAgMC4wMDAgMC4wMDAgUkcKMC41IHcKCkJU\nCjk2IDUzMC4wMjQgVGQKL0YyLjAgOSBUZgpbPDRmNmQ3MzYzPiAxMCA8Njg3\nMjY5NmE3NjY5NmU2Nz5dIFRKCkVUCgowLjAwMCAwLjAwMCAwLjAwMCByZwox\nIHcKMC4wMDAgMC4wMDAgMC4wMDAgUkcKMC41IHcKCkJUCjM4NC41NjUgNTMw\nLjAyNCBUZAovRjIuMCA5IFRmCls8NDI2NTY0NzI2MT4gMTAgPDY3Pl0gVEoK\nRVQKCjAuMDAwIDAuMDAwIDAuMDAwIHJnCjEgdwowLjAwMCAwLjAwMCAwLjAw\nMCBSRwowLjUgdwoKQlQKNDg5LjY5NSA1MzAuMDI0IFRkCi9GMi4wIDkgVGYK\nWzw1ND4gODAgPDZmNzQ2MTYxNmM+XSBUSgpFVAoKMC4wMDAgMC4wMDAgMC4w\nMDAgcmcKMSB3CjAuMDAwIDAuMDAwIDAuMDAwIFJHCjAuNSB3CgpCVAo1MzQu\nOTg3IDUzMC4wMjQgVGQKL0YyLjAgOSBUZgpbPDQyNTQ1Nz5dIFRKCkVUCgow\nLjAwMCAwLjAwMCAwLjAwMCByZwozNi4wMDAgNTI2LjAzOCBtCjU1OS4yODAg\nNTI2LjAzOCBsClMKMSB3CjAuMDAwIDAuMDAwIDAuMDAwIFJHCjAuNSB3CgpC\nVAo0MCA1MTIuOTQ4IFRkCi9GMS4wIDkgVGYKWzwzMTIwNzg+XSBUSgpFVAoK\nMC4wMDAgMC4wMDAgMC4wMDAgcmcKMSB3CjAuMDAwIDAuMDAwIDAuMDAwIFJH\nCjAuNSB3CgpCVAo5NiA1MTIuOTQ4IFRkCi9GMS4wIDkgVGYKWzw3NDY1NzM3\nND5dIFRKCkVUCgowLjAwMCAwLjAwMCAwLjAwMCByZwoxIHcKMC4wMDAgMC4w\nMDAgMC4wMDAgUkcKMC41IHcKCkJUCjM3Mi45NDYgNTEyLjk0OCBUZAovRjEu\nMCA5IFRmCls8ODAyMDMxMmUzMjMzMzQyYzMwMzA+XSBUSgpFVAoKMC4wMDAg\nMC4wMDAgMC4wMDAgcmcKMSB3CjAuMDAwIDAuMDAwIDAuMDAwIFJHCjAuNSB3\nCgpCVAo0NzIuOTQ2IDUxMi45NDggVGQKL0YxLjAgOSBUZgpbPDgwMjAzMTJl\nMzIzMzM0MmMzMDMwPl0gVEoKRVQKCjAuMDAwIDAuMDAwIDAuMDAwIHJnCjEg\ndwowLjAwMCAwLjAwMCAwLjAwMCBSRwowLjUgdwoKQlQKNTM3LjQ3MSA1MTIu\nOTQ4IFRkCi9GMS4wIDkgVGYKWzwzMTM5MjU+XSBUSgpFVAoKMC4wMDAgMC4w\nMDAgMC4wMDAgcmcKMzYuMDAwIDUwNS42MzQgbQo1NTkuMjgwIDUwNS42MzQg\nbApTCjAuMDAwIDAuMDAwIDAuMDAwIFJHCjEgdwowLjAwMCAwLjAwMCAwLjAw\nMCBSRwowLjUgdwoKQlQKMzcxLjQ3OSA0OTIuMzQgVGQKL0YyLjAgOSBUZgpb\nPDUzNzU2Mjc0NmY3NDYxNjE2YzNhPl0gVEoKRVQKCjAuMDAwIDAuMDAwIDAu\nMDAwIHJnCjEgdwowLjAwMCAwLjAwMCAwLjAwMCBSRwowLjUgdwoKQlQKNDcy\nLjk0NiA0OTIuNTQ0IFRkCi9GMS4wIDkgVGYKWzw4MDIwMzEyZTMyMzMzNDJj\nMzAzMD5dIFRKCkVUCgowLjAwMCAwLjAwMCAwLjAwMCByZwoxIHcKMC4wMDAg\nMC4wMDAgMC4wMDAgUkcKMC41IHcKCkJUCjM3MS40NzkgNDcwLjQ2OCBUZAov\nRjIuMCA5IFRmCls8NDI1NDU3MjAzMTM5MjUzYT5dIFRKCkVUCgowLjAwMCAw\nLjAwMCAwLjAwMCByZwoxIHcKMC4wMDAgMC4wMDAgMC4wMDAgUkcKMC41IHcK\nCkJUCjQ4MC40NTIgNDcwLjY3MiBUZAovRjEuMCA5IFRmCls8ODAyMDMyMzMz\nNDJjMzQzNj5dIFRKCkVUCgowLjAwMCAwLjAwMCAwLjAwMCByZwozMTkuNDgw\nIDQ2MS44OTAgbQo1MTkuNDgwIDQ2MS44OTAgbApTCjEgdwowLjAwMCAwLjAw\nMCAwLjAwMCBSRwowLjUgdwoKQlQKMzg2LjY5OCA0NDguNTk2IFRkCi9GMi4w\nIDkgVGYKWzw1ND4gODAgPDZmNzQ2MTYxNmMzYT5dIFRKCkVUCgowLjAwMCAw\nLjAwMCAwLjAwMCByZwoxIHcKMC4wMDAgMC4wMDAgMC4wMDAgUkcKMC41IHcK\nCkJUCjQ3Mi45NDYgNDQ4LjggVGQKL0YxLjAgOSBUZgpbPDgwMjAzMTJlMzQz\nNjM4MmMzNDM2Pl0gVEoKRVQKCjAuMDAwIDAuMDAwIDAuMDAwIHJnCjM2LjAw\nMCA2My43NDQgbQo1NTkuMjgwIDYzLjc0NCBsClMKCkJUCjM2IDUyLjI4MiBU\nZAovRjEuMCA5IFRmCls8NTc+IDMwIDw2NTIwNzY+IDI1IDw2NTcyN2E+IDE1\nIDw2ZjY1NmI+IDIwIDw2NTZlMjA3NTIwNzY3Mj4gLTE1IDw2OTY1NmU2NDY1\nNmM2OTZhNmIyMDY4NjU3NDIwNjI2Zj4gMTUgPDc2PiAyNSA8NjU2ZTczNzQ2\nMTYxNmU2NDY1MjA2MjY1NjQ3Mj4gMTAgPDYxNjcyMDYyNjk2ZTZlNjU2ZTIw\nNjQ2NTIwNjc2NTczNzQ2NTZjNjQ2NTIwNjI2NTc0NjE2YzY5NmU2NzczNzQ2\nNTcyPiAtMjUgPDZkNjk2YTZlMjA3NDY1MjA3Nj4gMjUgPDZmNmM2NDZmNjU2\nZTIwNmY3MDIwNmY2ZTdhPiAxNSA8NjUyMDYyNjE2ZTZiNzI2NTZiPiAyMCA8\nNjU2ZTY5NmU2NzJlPiA2MCA8MjA+IDUwIDw1Nj4gODAgPDZmNmY3MjBhPl0g\nVEoKRVQKCgpCVAozNiA0MS44NzggVGQKL0YxLjAgOSBUZgpbPDc2NzI+IDEw\nIDw2MTY3NjU2ZTIwNmI3NTZlNzQyMDc1MjA2MzZmNmU3NDYxNjM3NDIwNmY3\nMDZlNjU2ZDY1NmUyMDcwNjU3MjIwNjUyZDZkNjE2OTZjMmU+XSBUSgpFVAoK\nUQoKZW5kc3RyZWFtCmVuZG9iago1IDAgb2JqCjw8IC9Db250ZW50cyA0IDAg\nUgovUHJvY1NldCA2IDAgUgovTWVkaWFCb3ggWzAgMCA1OTUuMjggODQxLjg5\nXQovUGFyZW50IDIgMCBSCi9SZXNvdXJjZXMgPDwgL0ZvbnQgPDwgL0YxLjAg\nNyAwIFIKL0YyLjAgOCAwIFIKPj4KL1hPYmplY3QgPDwgL0kxIDkgMCBSCj4+\nCj4+Ci9UeXBlIC9QYWdlCj4+CmVuZG9iago2IDAgb2JqClsvUERGIC9UZXh0\nIC9JbWFnZUNdCmVuZG9iago3IDAgb2JqCjw8IC9CYXNlRm9udCAvSGVsdmV0\naWNhCi9FbmNvZGluZyAvV2luQW5zaUVuY29kaW5nCi9UeXBlIC9Gb250Ci9T\ndWJ0eXBlIC9UeXBlMQo+PgplbmRvYmoKOCAwIG9iago8PCAvQmFzZUZvbnQg\nL0hlbHZldGljYS1Cb2xkCi9FbmNvZGluZyAvV2luQW5zaUVuY29kaW5nCi9U\neXBlIC9Gb250Ci9TdWJ0eXBlIC9UeXBlMQo+PgplbmRvYmoKOSAwIG9iago8\nPCAvTGVuZ3RoIDM3MjkKL1dpZHRoIDIwMAovQ29sb3JTcGFjZSAvRGV2aWNl\nR3JheQovRmlsdGVyIC9EQ1REZWNvZGUKL0hlaWdodCA4MAovVHlwZSAvWE9i\namVjdAovQml0c1BlckNvbXBvbmVudCA4Ci9TdWJ0eXBlIC9JbWFnZQo+Pgpz\ndHJlYW0K/9j/4AAQSkZJRgABAQEASABIAAD/2wBDAAEBAQEBAQEBAQEBAQEB\nAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEB\nAQEBAQH/wAALCABQAMgBAREA/8QAHAABAAIDAQEBAAAAAAAAAAAAAAgJBgcK\nAgUD/8QALBAAAQQDAQABBAIBAwUAAAAABAMFBgcAAggBCRITFBURFhcKGSIh\nQ1mX2P/aAAgBAQAAPwDv4xjGMYxjGMYxjGMYxjGMYxjGMYxjGMYxjGMYxjGM\nYxjGMhd0p2/WvP8AIWepo8xya+unZkFuXX3MtQpCPVkPQ+30ppSOXrrrpMNU\n1wOqpqo7WLYR7KwCBJGrNv7kwJRv2rptu8/lblFm8yc5SWEe8avdv288qvPU\nHO7XA+nafErhCo7GmA1ZytK4oOsvCrSZpS1RVjLPLYAo7O9x3t2hD/qCOoyK\n2LfHVa9hXnw9zJbtryH2W2PP6sY5DMpL60sbD69PZW5WhR/rPGm1nYW71b7W\nnvorU1ghp/8AaQ1/6/zNHGMYxjGMYxjGMYxjGMoX7s707GQniVK88cr9XV/V\nJBZjbPOsI/TcSk1hmgi+e6mA89Vnac7ruPJEmebJCJ2RYbirsz6krHNdcuKi\nDY5k/B5q6yojlKPvDXVnxpfJWtJped49WXa02gtETS4rak2317ESazbHeunV\npBKHRZdQhdEZVcdjZ9iSB4+ztASn4vkl/wDdpG/8efyO/wDq7n7/AOm8rJiP\nTN7crT5p34G4q76cqGkUg9UmHF9+Q6sla+imjoSsW6PnNFmR+97DnNTlblqK\nGbVgdF5jW7iWe4rtokUU2H3R6Wagsr226+YJ0rArHrAx3G+pxgVsRZeIzmMO\nCfnnhLY8tuyxreRuhtt54m5sTo8MZunv1guZH0q6p7MxjGMYxjGMYxjGMYxn\nPt84DVCSZHQknnFbQG2BKv5m+Rq2mCGWcyryGFGzCvapqmQxkl7aBXBqJMFF\nchdN1Eh3IJbdPZTVMlLbbzfWt/4IIJyt8kwvUa3QXCPGrZvTZFLpRP8AxrVT\nzHNV9bATtXd8/c+PUzk/5nqfsLaP1/o3oP4/ihv3vCfvJfYlp8yPK3EvBPGh\nd+0lwxyg4TdCzoLD9B59W576wetUk/cfsN9gGmSx4v0zX8BD8Zbxx8TT/lT6\n0Vfq8+mJnBcWo+4ub+C+wg+YeeaavAv5Sa4q5aQUlBnCHj7Q5uFfiPwPEXSR\nSQz+TlvsqH7en+pL7Cje6Ipfb9+rskVU+0kor9Cin2091Ptpa/Wqp9Gvu30J\n6fz59Sm38fTpr/Pn1be+efz5/P8AOQOrj5LuP7So2/Oh4zYziNXPMTjJGe7f\nZNDpXFJVCnaLtiTme2FQ5/aQJEWcX939WzIAAE7PL+iUwt/q7sIUIjJihbvg\nnSNRQe8awUfSa9sdp9f4efI467xRzdWPcskUN3/QvwwTuIA6eDbGtK5giHjm\n1LBuofireaIQtt3GMre6v+WTh/jWfC1LbloOLjbpIqB6tXVrDpLY8yawCRP2\nCBT+JGm8puj+6zd7o5jtr05gvJbUqm6htpDbt+V5MKg70rnpen4LelSObi8V\n1YrWu7xhxdmF6jDiQKK5GtBXhTJIAm91D3QcW40fz1cXxAvRLQ0BYtvIFLX2\n/jGMYxjGMYxlb/Sjc3u/yEfHi1uoIbm2OFdd0huDa4CoGgHCEQqlklxTAyU1\nRyRl09tk1kFk90ldNttN9NtfffM+r289yTnWkY2XzH5BKWntpdH8vUrvMW+t\nIw9BtTbb12xKtHB5Mi3ujSDIiGVrlriW3CGmDfwtsomiWJ6vut5inLjld0k6\nC675n6qsuFdMs1Nx3mSYQ57KpKI14MkvbDdbxb2MdGAXKTgmqh7w5p1BOXN3\nVR8/I9RTQ++p5t+/dsajkUG4SaYswMkbavPka51I8bGBqBZ2/wAIWb7A+8v4\nG3IDDeLK/Rr91X7X17/Tr9e3v0+ZZfnHp8iXHKCXy013zBCJodB+efljdINY\nvU8BZ/CkP30goCTSKcSQgAlInX8Aqb/gquKTgl9SoMskD66KIqDbIDbbAlEo\nvHq/pn5Q4I2dkXLw5VXxg1s1NnOdTUFMW+qYgSDEopNfty6ywhRdFZhXoG0D\nbVnBoXXDEb2SXx1tbjmoUFJJwwGn/kX6uuScfApL7HtSVwcDoCQ3zCrrEa3V\neFQe7y67sYSv4i9yBnHWDZnU978SbNCBEUkwSpQ6HItLeKG4BN2vm7ezul2+\nQ/6g/wAifRVlpNvPWlHpUdszzpzVEqg10tIZhlSEFUHMUTjy5HmhjO7It+yO\nyfqS4C2ifqWyWt4fxP1/e4/OMV6K6A6dsPoOX9aVlS10jx2U7EDw2mm2Rwna\nRNsNrtpUczkgxvWWUM4cmcvERzZG9MX7pzVNLJ2X8ri+DN4hCXV3yot9uFNI\nfabt1tNlXwCVbhjzsyrRnmQkNyMPTcPfHMmKhvX7ZZwHj2yrQO0awlZfXVt8\nj2+bH7gta4uivlQ5z+OGJdK2nytREsoORXfJpxz5Lm6B2xbEpFcbBQTjEQsP\nwFxJaxmXyDFKEitqZaZO6Ev3eWw9QFt3bqsJ/wDID2fFfjg7zjQvSM9lEx4t\n71i1F1R1K2Om4U4sWv8Aaay5rUGkcmb1thpd9wWPCuay5yRShbRJW0RxIcR0\nQt093s8A7ddPkr04HX+UDrbSE9E8oMPSE7nqLm1pzGOyhQR6KXYKe88U/Epe\nNqyEfUn8WuvWNTaNbeRgncpZAR+Gis5/If22N8ONdzz3p6es1xVV8sSPMat4\nEPqqkkk9aNFGSWxEhrFcnFRTeWs6L89oKugsrKdNHNsj7Ug9Fl6De7eWR+2X\ncnxwfKpz9T0h7evzq2g+iudbPte8GK9ZSLYLlXXtdQmyJsXZ0BbWQMUCDQ4n\neBEGtDBHGkcXyPiSdqJLkpA7Qc217RbubqmGXLwZ0vTdh9tuXMnTHTYdOqvP\nXnT1Z2ey32wp2MPCp2jH+a4fExkaP1jqh722t8iFfnfdE1Bl0S3LWaRnh93L\nM5J2h0bYnzsnNXfXS9Nwz4932dWpVkFreXEMyDqW1Nt0yNriRskEXFk7RAwW\nmnl2jSKMjmI1EmSFJ1NHI/Vfhm5qy959O1NHvhz+RS57usBy5vu+JySg+too\no8K6V6rOmkqfxaIWy6xwdMRiCkT+AgrLnQlvGbBtDK3W2U2TRcS91rYPg9kX\nRVs8gunTfSljTibSbpe157YsDj0rkTk8Ndb1UI9Ex6LxeLtzh79DQ2EOjdI3\nkP0PRFA6Onxn6UE0xEvdrk8YxjIIdc8p3Pedlc+XBQvSTNzjYVCCW82iur9R\noF5N8ja7ebIY1ugu7M5WJABWpVuRiGuyRXu7ruRsf/w0D9F+omPcm4V7ttV2\nqwW9PkXglh1zXt5UpdrpCGLh6OQBxlBlKWZGrLaWNKYN1+OpTDo5uEbQCVcd\nGp01FTX2W3bTtU/RVdg2pxp1WZ0tbPQvNXasV5/RuaIVLF5jC5LyqzXbsqrU\nIcuDYXIOSO1wwv0TwjSaO+y4SDEn5576j4qUV9pP3TD1+He3J9P6Mf8AoL5B\noTa0Cpa7oReGkCj/ABbHqxPkT7BtXRNuA9mbZer8S0jrIPBqaiv6V0T823TU\n3CW9T18y2LI6WByZz9aN7U/0vO4B+9u2hBXsKppr/apq2f1QWRjGCPKX9bZ5\nI3xJ9/MHPLT+uSsLwoP936xN0N009tI7dNfFFwX19ZY9v3tRYsisX0FuaXuS\nR+YzyBEzJlatk9gWmbjwWTR4OVIIajiDpnOw5D0mAA3tiTom2giiJZX0P8a3\nFHUVSVlR9uUZHza4pbVJGpGaKHvkBXrwLUMJuKaoy5QtzYzxGZ1b28IV4Z1l\nyGxz3Cb3EsVR3a2twCwyL/Ej8eEJhFzVvEOb2mNQfoSKwCFW/HGSe2y3AS+P\nVisIVDh/fRZ4muwnhnBJObu/RlZlfpY7qnO8uc3xzcnEsqdNcV9EKkryB1VX\nzR/X4DWUMi9fQhh/PdHX9JEIYxgxyNNH7R7Ncnpy/WsraEF+e7uJ7oZ9n8g8\n0otRVdSDfV3xPcEdpy3/ACFflCtT5Yu6Agpc/i8ilkBlTsKAgmIGhIToY9sq\nMm/FCRQBDIkQroWACOgIAQMOlonr4s74muBbbqGoqRmFEIKQqg24pnpoprnV\njtc2gDSabu4mNTZYg8t/vDm1kmKKEKNcjfntu8X+2SmKmSMKshlBfxj8Lmcv\nIcZ70CyC84JSICXr18zymfx1d1lraogoNJ3+aR6WNc+kD/t6KIkW6PUoOLOF\nDCBMUXCCEHR2yJx3zkD0Qw9XC119q/oxWI9Nsc9/t063/BrcXwnxCOf1ZST7\nwsn7fhZHn7guOEP233P+bpt9On01CfIx8ODDMeOYNzPwVVkYibWt3LGep7Rj\nMrsqYFgPXilWziATZ5GerBfpY4aODiOVDm9GOt5rez6ojEliCiL7Gqk2Hc6/\nFlwlyvMJhPqcohqbJfNmRyijo+SuSzKxSwYW7DJBnwqPeT+QyRGPxokJL8Ak\nJqSGXNbNv1J5RTWkOGjqKF/B78YsBkbHLI9zbsk/RSxmm0oaaRbN1LaQ6UsL\nim7s+kdD1sRIIRiEdUkz1o8uMU0Oy6AWr4K5otjUkFKRj4L5Pja/WpLNVP4a\n/dALk3dT7/3mySP8pBu7bNmhxR+guYr6Qj8hvsaZD/crrWIqo/ufuoKJLt7U\nqDWR8gXxtW9cVJ82fG1yHX1ZVTwwG86yO17MlMnepjN6nFisv9kjfH4G3TCS\nPEufnaTqyKQHiOKi7n4oqMTHniRRJgM/h0u/rSu4nUVdQSqoG16MsJraHxuC\nxFpT2+vVujkUaBGNmD9U9812W3QbwR9FV9/PuLq+brKe+777e5m+MYxjGMYx\njGMYxjGMYxjGMYxjGMYxjGMYxjGMYxjGMYxjGMYxjGMYxjGMYxjGMYxjP//Z\nCmVuZHN0cmVhbQplbmRvYmoKeHJlZgowIDEwCjAwMDAwMDAwMDAgNjU1MzUg\nZiAKMDAwMDAwMDAxNCAwMDAwMCBuIAowMDAwMDAwMDcwIDAwMDAwIG4gCjAw\nMDAwMDAxMjcgMDAwMDAgbiAKMDAwMDAwMDE3NiAwMDAwMCBuIAowMDAwMDA0\nMTE1IDAwMDAwIG4gCjAwMDAwMDQzMDEgMDAwMDAgbiAKMDAwMDAwNDMzNyAw\nMDAwMCBuIAowMDAwMDA0NDM0IDAwMDAwIG4gCjAwMDAwMDQ1MzYgMDAwMDAg\nbiAKdHJhaWxlcgo8PCAvUm9vdCAzIDAgUgovU2l6ZSAxMAovSW5mbyAxIDAg\nUgo+PgpzdGFydHhyZWYKODQzMwolJUVPRgo=\n</cbc:EmbeddedDocumentBinaryObject>\n    </cac:Attachment>\n  </cac:AdditionalDocumentReference>\n  <cac:AccountingSupplierParty>\n    <cac:Party>\n      <cbc:EndpointID schemeID=\"0106\">08155914</cbc:EndpointID>\n      <cac:PartyName>\n        <cbc:Name>Parkietje B.V.</cbc:Name>\n      </cac:PartyName>\n      <cac:PostalAddress>\n        <cbc:StreetName>Brouwerijstraat 26</cbc:StreetName>\n        <cbc:CityName>Enschede</cbc:CityName>\n        <cbc:PostalZone>7523XD</cbc:PostalZone>\n        <cac:Country>\n          <cbc:IdentificationCode listID=\"ISO3166-1:Alpha2\" listAgencyID=\"6\">NL</cbc:IdentificationCode>\n        </cac:Country>\n      </cac:PostalAddress>\n      <cac:PartyTaxScheme>\n        <cbc:CompanyID schemeID=\"NL:VAT\">NL817575546B01</cbc:CompanyID>\n        <cac:TaxScheme>\n          <cbc:ID schemeID=\"UN/ECE 5153\">VAT</cbc:ID>\n        </cac:TaxScheme>\n      </cac:PartyTaxScheme>\n      <cac:PartyLegalEntity>\n        <cbc:RegistrationName>Parkietje B.V.</cbc:RegistrationName>\n        <cbc:CompanyID schemeID=\"0106\">08155914</cbc:CompanyID>\n      </cac:PartyLegalEntity>\n      <cac:Contact>\n        <cbc:ElectronicMail>info@dev.null.moneybird.net</cbc:ElectronicMail>\n      </cac:Contact>\n    </cac:Party>\n  </cac:AccountingSupplierParty>\n  <cac:AccountingCustomerParty>\n    <cac:Party>\n      <cac:PartyName>\n        <cbc:Name>Foobar Holding B.V.</cbc:Name>\n      </cac:PartyName>\n      <cac:PostalAddress>\n        <cbc:StreetName>Hoofdstraat 12</cbc:StreetName>\n        <cbc:CityName>Amsterdam</cbc:CityName>\n        <cbc:PostalZone>1234AB</cbc:PostalZone>\n        <cac:Country>\n          <cbc:IdentificationCode listID=\"ISO3166-1:Alpha2\" listAgencyID=\"6\">NL</cbc:IdentificationCode>\n        </cac:Country>\n      </cac:PostalAddress>\n      <cac:PartyLegalEntity>\n        <cbc:RegistrationName>Foobar Holding B.V.</cbc:RegistrationName>\n      </cac:PartyLegalEntity>\n      <cac:Contact>\n        <cbc:ElectronicMail>info@example.com</cbc:ElectronicMail>\n      </cac:Contact>\n    </cac:Party>\n  </cac:AccountingCustomerParty>\n  <cac:PaymentMeans>\n    <cbc:PaymentMeansCode listID=\"UNCL4461\" listAgencyID=\"6\">30</cbc:PaymentMeansCode>\n    <cbc:PaymentDueDate>2019-10-15</cbc:PaymentDueDate>\n    <cbc:PaymentID>RF320000000000000QMXJFKFM</cbc:PaymentID>\n    <cac:PayeeFinancialAccount>\n      <cbc:ID schemeID=\"IBAN\">NL50TEST0166567191</cbc:ID>\n      <cac:FinancialInstitutionBranch>\n        <cac:FinancialInstitution>\n          <cbc:ID schemeID=\"BIC\">TESTNL2A</cbc:ID>\n        </cac:FinancialInstitution>\n      </cac:FinancialInstitutionBranch>\n    </cac:PayeeFinancialAccount>\n  </cac:PaymentMeans>\n  <cac:PaymentTerms>\n    <cbc:Note>We verzoeken u vriendelijk het bovenstaande bedrag van € 363,00 voor 15-10-2019 te voldoen op onze bankrekening onder vermelding van de omschrijving RF32QMXJFKFM. Voor vragen kunt u contact opnemen per e-mail.</cbc:Note>\n  </cac:PaymentTerms>\n  <cac:TaxTotal>\n    <cbc:TaxAmount currencyID=\"EUR\">63.0</cbc:TaxAmount>\n    <cac:TaxSubtotal>\n      <cbc:TaxableAmount currencyID=\"EUR\">300.0</cbc:TaxableAmount>\n      <cbc:TaxAmount currencyID=\"EUR\">63.0</cbc:TaxAmount>\n      <cac:TaxCategory>\n        <cbc:ID schemeID=\"UNCL5305\">S</cbc:ID>\n        <cbc:Percent>21.0</cbc:Percent>\n        <cac:TaxScheme>\n          <cbc:ID schemeID=\"UN/ECE 5153\">VAT</cbc:ID>\n        </cac:TaxScheme>\n      </cac:TaxCategory>\n    </cac:TaxSubtotal>\n  </cac:TaxTotal>\n  <cac:LegalMonetaryTotal>\n    <cbc:LineExtensionAmount currencyID=\"EUR\">300.0</cbc:LineExtensionAmount>\n    <cbc:TaxExclusiveAmount currencyID=\"EUR\">300.0</cbc:TaxExclusiveAmount>\n    <cbc:TaxInclusiveAmount currencyID=\"EUR\">363.0</cbc:TaxInclusiveAmount>\n    <cbc:AllowanceTotalAmount currencyID=\"EUR\">0</cbc:AllowanceTotalAmount>\n    <cbc:PayableAmount currencyID=\"EUR\">363.0</cbc:PayableAmount>\n  </cac:LegalMonetaryTotal>\n  <cac:InvoiceLine>\n    <cbc:ID>1</cbc:ID>\n    <cbc:InvoicedQuantity unitCode=\"ZZ\" unitCodeListID=\"UNECERec20\">1.0</cbc:InvoicedQuantity>\n    <cbc:LineExtensionAmount currencyID=\"EUR\">300.0</cbc:LineExtensionAmount>\n    <cac:Item>\n      <cbc:Description>Project X</cbc:Description>\n      <cbc:Name>Project X</cbc:Name>\n      <cac:ClassifiedTaxCategory>\n        <cbc:ID schemeID=\"UNCL5305\">S</cbc:ID>\n        <cbc:Percent>21.0</cbc:Percent>\n        <cac:TaxScheme>\n          <cbc:ID schemeID=\"UN/ECE 5153\">VAT</cbc:ID>\n        </cac:TaxScheme>\n      </cac:ClassifiedTaxCategory>\n    </cac:Item>\n    <cac:Price>\n      <cbc:PriceAmount currencyID=\"EUR\">300.0</cbc:PriceAmount>\n    </cac:Price>\n  </cac:InvoiceLine>\n</Invoice>\n"
                  }
                }
              }
            }
          },
          "404": {
            "description": "Not found",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/symbolic_error"
                },
                "examples": {
                  "Returns404WhenInvoiceDoesNotExist": {
                    "summary": "Returns 404 when invoice does not exist",
                    "value": {
                      "error": "record not found",
                      "symbolic": {
                        "id": "not_found"
                      }
                    }
                  }
                }
              }
            }
          }
        },
        "operationId": "get_administration_id_sales_invoices_id_download_ubl"
      }
    },
    "/{administration_id}/sales_invoices/{id}/duplicate_creditinvoice{format}": {
      "patch": {
        "summary": "Duplicate to credit invoice",
        "description": "Duplicate a sales invoice to a new credit invoice.\n\n### Required scope(s)\n `sales_invoices`",
        "tags": [
          "Sales invoices"
        ],
        "security": [
          {
            "bearerAuth": [
              "sales_invoices"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/administration_id"
          },
          {
            "name": "id",
            "in": "path",
            "required": true,
            "schema": {
              "$ref": "#/components/schemas/identifier"
            }
          },
          {
            "$ref": "#/components/parameters/format"
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/*": {
              "schema": {
                "unevaluatedProperties": false,
                "type": "object",
                "properties": {
                  "detail_ids": {
                    "type": "array",
                    "items": {
                      "$ref": "#/components/schemas/identifier"
                    },
                    "description": "The invoice lines to credit. When left out, all lines of the invoice are credited."
                  }
                }
              },
              "examples": {
                "CreditsOnlyTheGivenLinesWhenDetailIdsAreSentAsStrings": {
                  "summary": "Credits only the given lines when detail ids are sent as strings",
                  "value": {
                    "detail_ids": [
                      "502689153534657973"
                    ]
                  }
                },
                "CreatesACreditInvoiceForASalesInvoice": {
                  "summary": "Creates a credit invoice for a sales invoice",
                  "value": {}
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Sales invoice updated",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/sales_invoice_response"
                },
                "examples": {
                  "CreditsOnlyTheGivenLinesWhenDetailIdsAreSentAsStrings": {
                    "summary": "Credits only the given lines when detail ids are sent as strings",
                    "value": {
                      "id": "502689153655244229",
                      "administration_id": 123,
                      "contact_id": "502689153504249266",
                      "contact": {
                        "id": "502689153504249266",
                        "administration_id": 123,
                        "company_name": "Foobar Holding B.V.",
                        "firstname": null,
                        "lastname": null,
                        "address1": "Hoofdstraat 12",
                        "address2": null,
                        "zipcode": "1234AB",
                        "city": "Amsterdam",
                        "country": "NL",
                        "phone": null,
                        "delivery_method": "Email",
                        "customer_id": "customer-1",
                        "tax_number": null,
                        "chamber_of_commerce": null,
                        "bank_account": null,
                        "is_trusted": false,
                        "max_transfer_amount": null,
                        "attention": null,
                        "email": "info@example.com",
                        "email_ubl": true,
                        "send_invoices_to_attention": null,
                        "send_invoices_to_email": "info@example.com",
                        "send_estimates_to_attention": null,
                        "send_estimates_to_email": "info@example.com",
                        "direct_debit": false,
                        "sepa_active": false,
                        "sepa_iban": null,
                        "sepa_iban_account_name": null,
                        "sepa_bic": null,
                        "sepa_mandate_id": null,
                        "sepa_mandate_date": null,
                        "sepa_sequence_type": "RCUR",
                        "credit_card_number": null,
                        "credit_card_reference": null,
                        "credit_card_type": null,
                        "tax_number_validated_at": null,
                        "tax_number_valid": null,
                        "invoice_workflow_id": null,
                        "estimate_workflow_id": null,
                        "si_identifier": null,
                        "si_identifier_type": null,
                        "moneybird_payments_mandate": false,
                        "created_at": "2026-11-02T12:15:56.553Z",
                        "updated_at": "2026-11-02T12:15:56.553Z",
                        "version": 1793621756,
                        "sales_invoices_url": "https://moneybird.dev/123/sales_invoices/0000000000000000000000000000000000000000000000000000000000000001/all",
                        "notes": [],
                        "custom_fields": [],
                        "contact_people": [],
                        "archived": false
                      },
                      "contact_person_id": null,
                      "contact_person": null,
                      "invoice_id": null,
                      "recurring_sales_invoice_id": null,
                      "subscription_id": null,
                      "workflow_id": "502689109097055375",
                      "document_style_id": "502689109280556185",
                      "identity_id": "502689108656653419",
                      "draft_id": 2,
                      "state": "draft",
                      "invoice_date": null,
                      "due_date": "2026-11-16",
                      "payment_conditions": "We verzoeken u vriendelijk het bovenstaande bedrag van {document.total_price} voor {document.due_date} te voldoen op onze bankrekening onder vermelding van de omschrijving {document.payment_reference}. Voor vragen kunt u contact opnemen per e-mail.",
                      "payment_reference": null,
                      "short_payment_reference": null,
                      "reference": "Project X",
                      "language": "nl",
                      "currency": "EUR",
                      "discount": "0.0",
                      "original_sales_invoice_id": "502689153532560820",
                      "paused": false,
                      "paid_at": null,
                      "sent_at": null,
                      "created_at": "2026-11-02T12:15:56.697Z",
                      "updated_at": "2026-11-02T12:15:56.702Z",
                      "public_view_code": null,
                      "public_view_code_expires_at": null,
                      "version": 1793621756,
                      "details": [
                        {
                          "id": "502689153657341382",
                          "administration_id": 123,
                          "tax_rate_id": "502689108899923082",
                          "ledger_account_id": "502689108787725434",
                          "project_id": null,
                          "product_id": null,
                          "amount": null,
                          "amount_decimal": "1.0",
                          "description": "**Creditfactuur voor factuur 2026-0001**",
                          "price": "0.0",
                          "period": null,
                          "row_order": 1,
                          "total_price_excl_tax_with_discount": "0.0",
                          "total_price_excl_tax_with_discount_base": "0.0",
                          "tax_report_reference": [
                            "NL/1a"
                          ],
                          "mandatory_tax_text": "",
                          "created_at": "2026-11-02T12:15:56.699Z",
                          "updated_at": "2026-11-02T12:15:56.699Z"
                        },
                        {
                          "id": "502689153659438535",
                          "administration_id": 123,
                          "tax_rate_id": "502689108899923082",
                          "ledger_account_id": "502689108787725434",
                          "project_id": null,
                          "product_id": null,
                          "amount": "-1 x",
                          "amount_decimal": "-1.0",
                          "description": "Project X",
                          "price": "300.0",
                          "period": null,
                          "row_order": 2,
                          "total_price_excl_tax_with_discount": "-300.0",
                          "total_price_excl_tax_with_discount_base": "-300.0",
                          "tax_report_reference": [
                            "NL/1a"
                          ],
                          "mandatory_tax_text": null,
                          "created_at": "2026-11-02T12:15:56.701Z",
                          "updated_at": "2026-11-02T12:15:56.701Z"
                        }
                      ],
                      "payments": [],
                      "total_paid": "0.0",
                      "total_unpaid": "-363.0",
                      "total_unpaid_base": "-363.0",
                      "prices_are_incl_tax": false,
                      "total_price_excl_tax": "-300.0",
                      "total_price_excl_tax_base": "-300.0",
                      "total_price_incl_tax": "-363.0",
                      "total_price_incl_tax_base": "-363.0",
                      "total_discount": "0.0",
                      "marked_dubious_on": null,
                      "marked_uncollectible_on": null,
                      "reminder_count": 0,
                      "next_reminder": null,
                      "original_estimate_id": null,
                      "url": "http://moneybird.dev/123/external/0000000000000000000000000000000000000000000000000000000000000001/7892c37b1976d91ff852c1464a00d3da613b63d6c981de81cda7973fb90f13df/sales_invoice",
                      "payment_url": "http://moneybird.dev/123/external/0000000000000000000000000000000000000000000000000000000000000001/7892c37b1976d91ff852c1464a00d3da613b63d6c981de81cda7973fb90f13df/sales_invoice",
                      "custom_fields": [],
                      "notes": [],
                      "attachments": [],
                      "events": [
                        {
                          "administration_id": 123,
                          "user_id": "502689108256097381",
                          "action": "credit_invoice_created_from_original",
                          "link_entity_id": null,
                          "link_entity_type": null,
                          "data": {
                            "original_invoice": "2026-0001"
                          },
                          "created_at": "2026-11-02T12:15:56.704Z",
                          "updated_at": "2026-11-02T12:15:56.704Z"
                        }
                      ],
                      "tax_totals": [
                        {
                          "tax_rate_id": "502689108899923082",
                          "taxable_amount": "-300.0",
                          "taxable_amount_base": "-300.0",
                          "tax_amount": "-63.0",
                          "tax_amount_base": "-63.0"
                        }
                      ],
                      "time_entries": []
                    }
                  },
                  "CreatesACreditInvoiceForASalesInvoice": {
                    "summary": "Creates a credit invoice for a sales invoice",
                    "value": {
                      "id": "502689153858667996",
                      "administration_id": 123,
                      "contact_id": "502689153699284426",
                      "contact": {
                        "id": "502689153699284426",
                        "administration_id": 123,
                        "company_name": "Foobar Holding B.V.",
                        "firstname": null,
                        "lastname": null,
                        "address1": "Hoofdstraat 12",
                        "address2": null,
                        "zipcode": "1234AB",
                        "city": "Amsterdam",
                        "country": "NL",
                        "phone": null,
                        "delivery_method": "Email",
                        "customer_id": "customer-1",
                        "tax_number": null,
                        "chamber_of_commerce": null,
                        "bank_account": null,
                        "is_trusted": false,
                        "max_transfer_amount": null,
                        "attention": null,
                        "email": "info@example.com",
                        "email_ubl": true,
                        "send_invoices_to_attention": null,
                        "send_invoices_to_email": "info@example.com",
                        "send_estimates_to_attention": null,
                        "send_estimates_to_email": "info@example.com",
                        "direct_debit": false,
                        "sepa_active": false,
                        "sepa_iban": null,
                        "sepa_iban_account_name": null,
                        "sepa_bic": null,
                        "sepa_mandate_id": null,
                        "sepa_mandate_date": null,
                        "sepa_sequence_type": "RCUR",
                        "credit_card_number": null,
                        "credit_card_reference": null,
                        "credit_card_type": null,
                        "tax_number_validated_at": null,
                        "tax_number_valid": null,
                        "invoice_workflow_id": null,
                        "estimate_workflow_id": null,
                        "si_identifier": null,
                        "si_identifier_type": null,
                        "moneybird_payments_mandate": false,
                        "created_at": "2026-11-02T12:15:56.739Z",
                        "updated_at": "2026-11-02T12:15:56.739Z",
                        "version": 1793621756,
                        "sales_invoices_url": "https://moneybird.dev/123/sales_invoices/0000000000000000000000000000000000000000000000000000000000000001/all",
                        "notes": [],
                        "custom_fields": [],
                        "contact_people": [],
                        "archived": false
                      },
                      "contact_person_id": null,
                      "contact_person": null,
                      "invoice_id": null,
                      "recurring_sales_invoice_id": null,
                      "subscription_id": null,
                      "workflow_id": "502689109097055375",
                      "document_style_id": "502689109280556185",
                      "identity_id": "502689108656653419",
                      "draft_id": 2,
                      "state": "draft",
                      "invoice_date": null,
                      "due_date": "2026-11-16",
                      "payment_conditions": "We verzoeken u vriendelijk het bovenstaande bedrag van {document.total_price} voor {document.due_date} te voldoen op onze bankrekening onder vermelding van de omschrijving {document.payment_reference}. Voor vragen kunt u contact opnemen per e-mail.",
                      "payment_reference": null,
                      "short_payment_reference": null,
                      "reference": "Project X",
                      "language": "nl",
                      "currency": "EUR",
                      "discount": "0.0",
                      "original_sales_invoice_id": "502689153729693132",
                      "paused": false,
                      "paid_at": null,
                      "sent_at": null,
                      "created_at": "2026-11-02T12:15:56.891Z",
                      "updated_at": "2026-11-02T12:15:56.895Z",
                      "public_view_code": null,
                      "public_view_code_expires_at": null,
                      "version": 1793621756,
                      "details": [
                        {
                          "id": "502689153860765149",
                          "administration_id": 123,
                          "tax_rate_id": "502689108899923082",
                          "ledger_account_id": "502689108787725434",
                          "project_id": null,
                          "product_id": null,
                          "amount": null,
                          "amount_decimal": "1.0",
                          "description": "**Creditfactuur voor factuur 2026-0001**",
                          "price": "0.0",
                          "period": null,
                          "row_order": 1,
                          "total_price_excl_tax_with_discount": "0.0",
                          "total_price_excl_tax_with_discount_base": "0.0",
                          "tax_report_reference": [
                            "NL/1a"
                          ],
                          "mandatory_tax_text": "",
                          "created_at": "2026-11-02T12:15:56.893Z",
                          "updated_at": "2026-11-02T12:15:56.893Z"
                        },
                        {
                          "id": "502689153861813726",
                          "administration_id": 123,
                          "tax_rate_id": "502689108899923082",
                          "ledger_account_id": "502689108787725434",
                          "project_id": null,
                          "product_id": null,
                          "amount": "-1 x",
                          "amount_decimal": "-1.0",
                          "description": "Project X",
                          "price": "300.0",
                          "period": null,
                          "row_order": 2,
                          "total_price_excl_tax_with_discount": "-300.0",
                          "total_price_excl_tax_with_discount_base": "-300.0",
                          "tax_report_reference": [
                            "NL/1a"
                          ],
                          "mandatory_tax_text": null,
                          "created_at": "2026-11-02T12:15:56.895Z",
                          "updated_at": "2026-11-02T12:15:56.895Z"
                        }
                      ],
                      "payments": [],
                      "total_paid": "0.0",
                      "total_unpaid": "-363.0",
                      "total_unpaid_base": "-363.0",
                      "prices_are_incl_tax": false,
                      "total_price_excl_tax": "-300.0",
                      "total_price_excl_tax_base": "-300.0",
                      "total_price_incl_tax": "-363.0",
                      "total_price_incl_tax_base": "-363.0",
                      "total_discount": "0.0",
                      "marked_dubious_on": null,
                      "marked_uncollectible_on": null,
                      "reminder_count": 0,
                      "next_reminder": null,
                      "original_estimate_id": null,
                      "url": "http://moneybird.dev/123/external/0000000000000000000000000000000000000000000000000000000000000001/a21654f7d7a424028ca00efec01c6fe27ef1f9682288b03dff258438e31a564e/sales_invoice",
                      "payment_url": "http://moneybird.dev/123/external/0000000000000000000000000000000000000000000000000000000000000001/a21654f7d7a424028ca00efec01c6fe27ef1f9682288b03dff258438e31a564e/sales_invoice",
                      "custom_fields": [],
                      "notes": [],
                      "attachments": [],
                      "events": [
                        {
                          "administration_id": 123,
                          "user_id": "502689108256097381",
                          "action": "credit_invoice_created_from_original",
                          "link_entity_id": null,
                          "link_entity_type": null,
                          "data": {
                            "original_invoice": "2026-0001"
                          },
                          "created_at": "2026-11-02T12:15:56.897Z",
                          "updated_at": "2026-11-02T12:15:56.897Z"
                        }
                      ],
                      "tax_totals": [
                        {
                          "tax_rate_id": "502689108899923082",
                          "taxable_amount": "-300.0",
                          "taxable_amount_base": "-300.0",
                          "tax_amount": "-63.0",
                          "tax_amount_base": "-63.0"
                        }
                      ],
                      "time_entries": []
                    }
                  }
                }
              }
            }
          },
          "400": {
            "$ref": "#/components/responses/400_bad_request"
          },
          "402": {
            "$ref": "#/components/responses/402_payment_required"
          },
          "404": {
            "$ref": "#/components/responses/404_not_found"
          }
        },
        "operationId": "patch_administration_id_sales_invoices_id_duplicate_creditinvoice"
      }
    },
    "/{administration_id}/sales_invoices/{id}/mark_as_dubious{format}": {
      "patch": {
        "summary": "Mark as dubious",
        "description": "This endpoint marks a sales invoice as dubious.\n\n### Required scope(s)\n `sales_invoices`",
        "tags": [
          "Sales invoices"
        ],
        "security": [
          {
            "bearerAuth": [
              "sales_invoices"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/administration_id"
          },
          {
            "name": "id",
            "in": "path",
            "required": true,
            "schema": {
              "$ref": "#/components/schemas/identifier"
            }
          },
          {
            "$ref": "#/components/parameters/format"
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/*": {
              "schema": {
                "unevaluatedProperties": false,
                "type": "object",
                "properties": {
                  "dubious_date": {
                    "type": "string",
                    "format": "date"
                  }
                },
                "required": []
              },
              "examples": {
                "MarksTheSalesInvoiceAsDubious": {
                  "summary": "Marks the sales invoice as dubious",
                  "value": {}
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Sales invoice updated",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/sales_invoice_response"
                },
                "examples": {
                  "MarksTheSalesInvoiceAsDubious": {
                    "summary": "Marks the sales invoice as dubious",
                    "value": {
                      "id": "502689152317261031",
                      "administration_id": 123,
                      "contact_id": "502689152293143781",
                      "contact": {
                        "id": "502689152293143781",
                        "administration_id": 123,
                        "company_name": "Foobar Holding B.V.",
                        "firstname": null,
                        "lastname": null,
                        "address1": "Hoofdstraat 12",
                        "address2": null,
                        "zipcode": "1234AB",
                        "city": "Amsterdam",
                        "country": "NL",
                        "phone": null,
                        "delivery_method": "Email",
                        "customer_id": "customer-1",
                        "tax_number": null,
                        "chamber_of_commerce": null,
                        "bank_account": null,
                        "is_trusted": false,
                        "max_transfer_amount": null,
                        "attention": null,
                        "email": "info@example.com",
                        "email_ubl": true,
                        "send_invoices_to_attention": null,
                        "send_invoices_to_email": "info@example.com",
                        "send_estimates_to_attention": null,
                        "send_estimates_to_email": "info@example.com",
                        "direct_debit": false,
                        "sepa_active": false,
                        "sepa_iban": null,
                        "sepa_iban_account_name": null,
                        "sepa_bic": null,
                        "sepa_mandate_id": null,
                        "sepa_mandate_date": null,
                        "sepa_sequence_type": "RCUR",
                        "credit_card_number": null,
                        "credit_card_reference": null,
                        "credit_card_type": null,
                        "tax_number_validated_at": null,
                        "tax_number_valid": null,
                        "invoice_workflow_id": null,
                        "estimate_workflow_id": null,
                        "si_identifier": null,
                        "si_identifier_type": null,
                        "moneybird_payments_mandate": false,
                        "created_at": "2026-11-02T12:15:55.398Z",
                        "updated_at": "2026-11-02T12:15:55.398Z",
                        "version": 1793621755,
                        "sales_invoices_url": "https://moneybird.dev/123/sales_invoices/0000000000000000000000000000000000000000000000000000000000000001/all",
                        "notes": [],
                        "custom_fields": [],
                        "contact_people": [],
                        "archived": false
                      },
                      "contact_person_id": null,
                      "contact_person": null,
                      "invoice_id": "2026-0001",
                      "recurring_sales_invoice_id": null,
                      "subscription_id": null,
                      "workflow_id": "502689109097055375",
                      "document_style_id": "502689109280556185",
                      "identity_id": "502689108656653419",
                      "draft_id": null,
                      "state": "open",
                      "invoice_date": "2026-11-02",
                      "due_date": "2026-11-16",
                      "payment_conditions": "We verzoeken u vriendelijk het bovenstaande bedrag van {document.total_price} voor {document.due_date} te voldoen op onze bankrekening onder vermelding van de omschrijving {document.payment_reference}. Voor vragen kunt u contact opnemen per e-mail.",
                      "payment_reference": "RF4900000000000002UK9MZE3",
                      "short_payment_reference": "RF492UK9MZE3",
                      "reference": "Project X",
                      "language": "nl",
                      "currency": "EUR",
                      "discount": "0.0",
                      "original_sales_invoice_id": null,
                      "paused": false,
                      "paid_at": null,
                      "sent_at": "2026-11-02",
                      "created_at": "2026-11-02T12:15:55.422Z",
                      "updated_at": "2026-11-02T12:15:55.524Z",
                      "public_view_code": "916990",
                      "public_view_code_expires_at": "2027-02-02T12:15:55.458Z",
                      "version": 1793621755,
                      "details": [
                        {
                          "id": "502689152320406760",
                          "administration_id": 123,
                          "tax_rate_id": "502689108899923082",
                          "ledger_account_id": "502689108787725434",
                          "project_id": null,
                          "product_id": null,
                          "amount": "1 x",
                          "amount_decimal": "1.0",
                          "description": "Project X",
                          "price": "300.0",
                          "period": null,
                          "row_order": 1,
                          "total_price_excl_tax_with_discount": "300.0",
                          "total_price_excl_tax_with_discount_base": "300.0",
                          "tax_report_reference": [
                            "NL/1a"
                          ],
                          "mandatory_tax_text": null,
                          "created_at": "2026-11-02T12:15:55.425Z",
                          "updated_at": "2026-11-02T12:15:55.482Z"
                        }
                      ],
                      "payments": [],
                      "total_paid": "0.0",
                      "total_unpaid": "363.0",
                      "total_unpaid_base": "363.0",
                      "prices_are_incl_tax": false,
                      "total_price_excl_tax": "300.0",
                      "total_price_excl_tax_base": "300.0",
                      "total_price_incl_tax": "363.0",
                      "total_price_incl_tax_base": "363.0",
                      "total_discount": "0.0",
                      "marked_dubious_on": "2026-11-02",
                      "marked_uncollectible_on": null,
                      "reminder_count": 0,
                      "next_reminder": "2026-11-16",
                      "original_estimate_id": null,
                      "url": "http://moneybird.dev/123/external/0000000000000000000000000000000000000000000000000000000000000001/e856f12474d1b4227e8f3fda8c323029d0fb1b643b44c44535a3f218ca727cd6/sales_invoice",
                      "payment_url": "http://moneybird.dev/123/external/0000000000000000000000000000000000000000000000000000000000000001/e856f12474d1b4227e8f3fda8c323029d0fb1b643b44c44535a3f218ca727cd6/sales_invoice",
                      "custom_fields": [],
                      "notes": [],
                      "attachments": [],
                      "events": [
                        {
                          "administration_id": 123,
                          "user_id": "502689108256097381",
                          "action": "sales_invoice_created",
                          "link_entity_id": null,
                          "link_entity_type": null,
                          "data": {},
                          "created_at": "2026-11-02T12:15:55.428Z",
                          "updated_at": "2026-11-02T12:15:55.428Z"
                        },
                        {
                          "administration_id": 123,
                          "user_id": "502689108256097381",
                          "action": "sales_invoice_state_changed_to_open",
                          "link_entity_id": null,
                          "link_entity_type": null,
                          "data": {},
                          "created_at": "2026-11-02T12:15:55.465Z",
                          "updated_at": "2026-11-02T12:15:55.465Z"
                        },
                        {
                          "administration_id": 123,
                          "user_id": "502689108256097381",
                          "action": "sales_invoice_send_email",
                          "link_entity_id": null,
                          "link_entity_type": null,
                          "data": {
                            "email_address": "info@example.com",
                            "email_message": "Geachte Foobar Holding B.V.,\n\nIn de bijlage kunt u factuur 2026-0001 voor onze diensten vinden. Wij verzoeken u vriendelijk de factuur voor 16-11-2026 te voldoen.\n\nMet vriendelijke groet,\n\nParkietje B.V."
                          },
                          "created_at": "2026-11-02T12:15:55.498Z",
                          "updated_at": "2026-11-02T12:15:55.498Z"
                        },
                        {
                          "administration_id": 123,
                          "user_id": "502689108256097381",
                          "action": "sales_invoice_marked_as_dubious",
                          "link_entity_id": null,
                          "link_entity_type": null,
                          "data": {},
                          "created_at": "2026-11-02T12:15:55.527Z",
                          "updated_at": "2026-11-02T12:15:55.527Z"
                        }
                      ],
                      "tax_totals": [
                        {
                          "tax_rate_id": "502689108899923082",
                          "taxable_amount": "300.0",
                          "taxable_amount_base": "300.0",
                          "tax_amount": "63.0",
                          "tax_amount_base": "63.0"
                        }
                      ],
                      "time_entries": []
                    }
                  }
                }
              }
            }
          },
          "400": {
            "$ref": "#/components/responses/400_bad_request"
          },
          "404": {
            "$ref": "#/components/responses/404_not_found"
          }
        },
        "operationId": "patch_administration_id_sales_invoices_id_mark_as_dubious"
      }
    },
    "/{administration_id}/sales_invoices/{id}/mark_as_uncollectible{format}": {
      "patch": {
        "summary": "Mark as uncollectible",
        "description": "This endpoint marks a sales invoice as uncollectible.\n\n### Required scope(s)\n `sales_invoices`",
        "tags": [
          "Sales invoices"
        ],
        "security": [
          {
            "bearerAuth": [
              "sales_invoices"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/administration_id"
          },
          {
            "name": "id",
            "in": "path",
            "required": true,
            "schema": {
              "$ref": "#/components/schemas/identifier"
            }
          },
          {
            "$ref": "#/components/parameters/format"
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/*": {
              "schema": {
                "unevaluatedProperties": false,
                "type": "object",
                "properties": {
                  "uncollectible_date": {
                    "type": "string",
                    "format": "date"
                  },
                  "book_method": {
                    "type": "string",
                    "description": "Can be `revenue`."
                  }
                },
                "required": []
              },
              "examples": {
                "MarksTheSalesInvoiceAsUncollectibleUsingTheUncollectibleRevenue": {
                  "summary": "Marks the sales invoice as uncollectible using the uncollectible revenue",
                  "value": {}
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Sales invoice updated",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/sales_invoice_response"
                },
                "examples": {
                  "MarksTheSalesInvoiceAsUncollectibleUsingTheUncollectibleRevenue": {
                    "summary": "Marks the sales invoice as uncollectible using the uncollectible revenue",
                    "value": {
                      "id": "502689155165193879",
                      "administration_id": 123,
                      "contact_id": "502689155135833749",
                      "contact": {
                        "id": "502689155135833749",
                        "administration_id": 123,
                        "company_name": "Foobar Holding B.V.",
                        "firstname": null,
                        "lastname": null,
                        "address1": "Hoofdstraat 12",
                        "address2": null,
                        "zipcode": "1234AB",
                        "city": "Amsterdam",
                        "country": "NL",
                        "phone": null,
                        "delivery_method": "Email",
                        "customer_id": "customer-1",
                        "tax_number": null,
                        "chamber_of_commerce": null,
                        "bank_account": null,
                        "is_trusted": false,
                        "max_transfer_amount": null,
                        "attention": null,
                        "email": "info@example.com",
                        "email_ubl": true,
                        "send_invoices_to_attention": null,
                        "send_invoices_to_email": "info@example.com",
                        "send_estimates_to_attention": null,
                        "send_estimates_to_email": "info@example.com",
                        "direct_debit": false,
                        "sepa_active": false,
                        "sepa_iban": null,
                        "sepa_iban_account_name": null,
                        "sepa_bic": null,
                        "sepa_mandate_id": null,
                        "sepa_mandate_date": null,
                        "sepa_sequence_type": "RCUR",
                        "credit_card_number": null,
                        "credit_card_reference": null,
                        "credit_card_type": null,
                        "tax_number_validated_at": null,
                        "tax_number_valid": null,
                        "invoice_workflow_id": null,
                        "estimate_workflow_id": null,
                        "si_identifier": null,
                        "si_identifier_type": null,
                        "moneybird_payments_mandate": false,
                        "created_at": "2026-11-02T12:15:58.110Z",
                        "updated_at": "2026-11-02T12:15:58.110Z",
                        "version": 1793621758,
                        "sales_invoices_url": "https://moneybird.dev/123/sales_invoices/0000000000000000000000000000000000000000000000000000000000000001/all",
                        "notes": [],
                        "custom_fields": [],
                        "contact_people": [],
                        "archived": false
                      },
                      "contact_person_id": null,
                      "contact_person": null,
                      "invoice_id": "2026-0001",
                      "recurring_sales_invoice_id": null,
                      "subscription_id": null,
                      "workflow_id": "502689109097055375",
                      "document_style_id": "502689109280556185",
                      "identity_id": "502689108656653419",
                      "draft_id": null,
                      "state": "uncollectible",
                      "invoice_date": "2026-11-02",
                      "due_date": "2026-11-16",
                      "payment_conditions": "We verzoeken u vriendelijk het bovenstaande bedrag van {document.total_price} voor {document.due_date} te voldoen op onze bankrekening onder vermelding van de omschrijving {document.payment_reference}. Voor vragen kunt u contact opnemen per e-mail.",
                      "payment_reference": "RF770000000000000TXVCPMPE",
                      "short_payment_reference": "RF77TXVCPMPE",
                      "reference": "Project X",
                      "language": "nl",
                      "currency": "EUR",
                      "discount": "0.0",
                      "original_sales_invoice_id": null,
                      "paused": false,
                      "paid_at": null,
                      "sent_at": "2026-11-02",
                      "created_at": "2026-11-02T12:15:58.137Z",
                      "updated_at": "2026-11-02T12:15:58.268Z",
                      "public_view_code": "924499",
                      "public_view_code_expires_at": "2027-02-02T12:15:58.170Z",
                      "version": 1793621758,
                      "details": [
                        {
                          "id": "502689155167291032",
                          "administration_id": 123,
                          "tax_rate_id": "502689108899923082",
                          "ledger_account_id": "502689108787725434",
                          "project_id": null,
                          "product_id": null,
                          "amount": "1 x",
                          "amount_decimal": "1.0",
                          "description": "Project X",
                          "price": "300.0",
                          "period": null,
                          "row_order": 1,
                          "total_price_excl_tax_with_discount": "300.0",
                          "total_price_excl_tax_with_discount_base": "300.0",
                          "tax_report_reference": [
                            "NL/1a"
                          ],
                          "mandatory_tax_text": null,
                          "created_at": "2026-11-02T12:15:58.139Z",
                          "updated_at": "2026-11-02T12:15:58.267Z"
                        }
                      ],
                      "payments": [],
                      "total_paid": "0.0",
                      "total_unpaid": "363.0",
                      "total_unpaid_base": "363.0",
                      "prices_are_incl_tax": false,
                      "total_price_excl_tax": "300.0",
                      "total_price_excl_tax_base": "300.0",
                      "total_price_incl_tax": "363.0",
                      "total_price_incl_tax_base": "363.0",
                      "total_discount": "0.0",
                      "marked_dubious_on": null,
                      "marked_uncollectible_on": "2026-11-02",
                      "reminder_count": 0,
                      "next_reminder": "2026-11-16",
                      "original_estimate_id": null,
                      "url": "http://moneybird.dev/123/external/0000000000000000000000000000000000000000000000000000000000000001/9706c42ea91acfbc401fede7922fe6ca67c834e8594266b1e3b4e4bac0e2df1d/sales_invoice",
                      "payment_url": "http://moneybird.dev/123/external/0000000000000000000000000000000000000000000000000000000000000001/9706c42ea91acfbc401fede7922fe6ca67c834e8594266b1e3b4e4bac0e2df1d/sales_invoice",
                      "custom_fields": [],
                      "notes": [],
                      "attachments": [],
                      "events": [
                        {
                          "administration_id": 123,
                          "user_id": "502689108256097381",
                          "action": "sales_invoice_created",
                          "link_entity_id": null,
                          "link_entity_type": null,
                          "data": {},
                          "created_at": "2026-11-02T12:15:58.142Z",
                          "updated_at": "2026-11-02T12:15:58.142Z"
                        },
                        {
                          "administration_id": 123,
                          "user_id": "502689108256097381",
                          "action": "sales_invoice_state_changed_to_open",
                          "link_entity_id": null,
                          "link_entity_type": null,
                          "data": {},
                          "created_at": "2026-11-02T12:15:58.176Z",
                          "updated_at": "2026-11-02T12:15:58.176Z"
                        },
                        {
                          "administration_id": 123,
                          "user_id": "502689108256097381",
                          "action": "sales_invoice_send_email",
                          "link_entity_id": null,
                          "link_entity_type": null,
                          "data": {
                            "email_address": "info@example.com",
                            "email_message": "Geachte Foobar Holding B.V.,\n\nIn de bijlage kunt u factuur 2026-0001 voor onze diensten vinden. Wij verzoeken u vriendelijk de factuur voor 16-11-2026 te voldoen.\n\nMet vriendelijke groet,\n\nParkietje B.V."
                          },
                          "created_at": "2026-11-02T12:15:58.205Z",
                          "updated_at": "2026-11-02T12:15:58.205Z"
                        },
                        {
                          "administration_id": 123,
                          "user_id": "502689108256097381",
                          "action": "sales_invoice_state_changed_to_uncollectible",
                          "link_entity_id": null,
                          "link_entity_type": null,
                          "data": {},
                          "created_at": "2026-11-02T12:15:58.257Z",
                          "updated_at": "2026-11-02T12:15:58.257Z"
                        },
                        {
                          "administration_id": 123,
                          "user_id": "502689108256097381",
                          "action": "sales_invoice_marked_as_uncollectible",
                          "link_entity_id": null,
                          "link_entity_type": null,
                          "data": {},
                          "created_at": "2026-11-02T12:15:58.271Z",
                          "updated_at": "2026-11-02T12:15:58.271Z"
                        }
                      ],
                      "tax_totals": [
                        {
                          "tax_rate_id": "502689108899923082",
                          "taxable_amount": "300.0",
                          "taxable_amount_base": "300.0",
                          "tax_amount": "63.0",
                          "tax_amount_base": "63.0"
                        }
                      ],
                      "time_entries": []
                    }
                  }
                }
              }
            }
          },
          "400": {
            "$ref": "#/components/responses/400_bad_request"
          },
          "404": {
            "$ref": "#/components/responses/404_not_found"
          }
        },
        "operationId": "patch_administration_id_sales_invoices_id_mark_as_uncollectible"
      }
    },
    "/{administration_id}/sales_invoices/{id}/pause{format}": {
      "post": {
        "summary": "Pause sales invoice",
        "description": "This endpoint pauses a sales invoice. The automatic workflow steps will not be executed while the sales invoice is paused.\n\n### Required scope(s)\n `sales_invoices`",
        "tags": [
          "Sales invoices"
        ],
        "security": [
          {
            "bearerAuth": [
              "sales_invoices"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/administration_id"
          },
          {
            "name": "id",
            "in": "path",
            "required": true,
            "schema": {
              "$ref": "#/components/schemas/identifier"
            }
          },
          {
            "$ref": "#/components/parameters/format"
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/*": {
              "schema": {
                "unevaluatedProperties": false,
                "type": "object"
              },
              "examples": {
                "PausesTheSalesInvoice": {
                  "summary": "Pauses the sales invoice",
                  "value": {}
                }
              }
            }
          }
        },
        "responses": {
          "201": {
            "description": "Sales invoice paused",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/sales_invoice_response"
                },
                "examples": {
                  "PausesTheSalesInvoice": {
                    "summary": "Pauses the sales invoice",
                    "value": {
                      "id": "502689147718207138",
                      "administration_id": 123,
                      "contact_id": "502689147684652701",
                      "contact": {
                        "id": "502689147684652701",
                        "administration_id": 123,
                        "company_name": "Foobar Holding B.V.",
                        "firstname": null,
                        "lastname": null,
                        "address1": "Hoofdstraat 12",
                        "address2": null,
                        "zipcode": "1234AB",
                        "city": "Amsterdam",
                        "country": "NL",
                        "phone": null,
                        "delivery_method": "Email",
                        "customer_id": "customer-1",
                        "tax_number": null,
                        "chamber_of_commerce": null,
                        "bank_account": null,
                        "is_trusted": false,
                        "max_transfer_amount": null,
                        "attention": null,
                        "email": "info@example.com",
                        "email_ubl": true,
                        "send_invoices_to_attention": null,
                        "send_invoices_to_email": "info@example.com",
                        "send_estimates_to_attention": null,
                        "send_estimates_to_email": "info@example.com",
                        "direct_debit": false,
                        "sepa_active": false,
                        "sepa_iban": null,
                        "sepa_iban_account_name": null,
                        "sepa_bic": null,
                        "sepa_mandate_id": null,
                        "sepa_mandate_date": null,
                        "sepa_sequence_type": "RCUR",
                        "credit_card_number": null,
                        "credit_card_reference": null,
                        "credit_card_type": null,
                        "tax_number_validated_at": null,
                        "tax_number_valid": null,
                        "invoice_workflow_id": null,
                        "estimate_workflow_id": null,
                        "si_identifier": null,
                        "si_identifier_type": null,
                        "moneybird_payments_mandate": false,
                        "created_at": "2026-11-02T12:15:51.003Z",
                        "updated_at": "2026-11-02T12:15:51.003Z",
                        "version": 1793621751,
                        "sales_invoices_url": "https://moneybird.dev/123/sales_invoices/0000000000000000000000000000000000000000000000000000000000000001/all",
                        "notes": [],
                        "custom_fields": [],
                        "contact_people": [],
                        "archived": false
                      },
                      "contact_person_id": "502689147687798431",
                      "contact_person": {
                        "id": null,
                        "contact_id": "502689147684652701",
                        "administration_id": 123,
                        "firstname": "Jan",
                        "lastname": "Janssen",
                        "phone": "123-456-2346",
                        "email": "janjanssen@dev.null.moneybird.net",
                        "department": "Sales",
                        "created_at": "2026-11-02T12:15:51.006Z",
                        "updated_at": "2026-11-02T12:15:51.006Z",
                        "version": 1793621751
                      },
                      "invoice_id": "2026-0001",
                      "recurring_sales_invoice_id": null,
                      "subscription_id": null,
                      "workflow_id": "502689109097055375",
                      "document_style_id": "502689109280556185",
                      "identity_id": "502689108656653419",
                      "draft_id": null,
                      "state": "open",
                      "invoice_date": "2026-11-02",
                      "due_date": "2026-11-16",
                      "payment_conditions": "We verzoeken u vriendelijk het bovenstaande bedrag van {document.total_price} voor {document.due_date} te voldoen op onze bankrekening onder vermelding van de omschrijving {document.payment_reference}. Voor vragen kunt u contact opnemen per e-mail.",
                      "payment_reference": "RF830000000000000CW4VAGAY",
                      "short_payment_reference": "RF83CW4VAGAY",
                      "reference": "Project X",
                      "language": "nl",
                      "currency": "EUR",
                      "discount": "0.0",
                      "original_sales_invoice_id": null,
                      "paused": true,
                      "paid_at": null,
                      "sent_at": "2026-11-02",
                      "created_at": "2026-11-02T12:15:51.035Z",
                      "updated_at": "2026-11-02T12:15:51.125Z",
                      "public_view_code": "500724",
                      "public_view_code_expires_at": "2027-02-02T12:15:51.068Z",
                      "version": 1793621751,
                      "details": [
                        {
                          "id": "502689147720304291",
                          "administration_id": 123,
                          "tax_rate_id": "502689108899923082",
                          "ledger_account_id": "502689108787725434",
                          "project_id": null,
                          "product_id": null,
                          "amount": "1 x",
                          "amount_decimal": "1.0",
                          "description": "Project X",
                          "price": "300.0",
                          "period": "20261101..20261130",
                          "row_order": 1,
                          "total_price_excl_tax_with_discount": "300.0",
                          "total_price_excl_tax_with_discount_base": "300.0",
                          "tax_report_reference": [
                            "NL/1a"
                          ],
                          "mandatory_tax_text": null,
                          "created_at": "2026-11-02T12:15:51.038Z",
                          "updated_at": "2026-11-02T12:15:51.088Z"
                        }
                      ],
                      "payments": [],
                      "total_paid": "0.0",
                      "total_unpaid": "363.0",
                      "total_unpaid_base": "363.0",
                      "prices_are_incl_tax": false,
                      "total_price_excl_tax": "300.0",
                      "total_price_excl_tax_base": "300.0",
                      "total_price_incl_tax": "363.0",
                      "total_price_incl_tax_base": "363.0",
                      "total_discount": "0.0",
                      "marked_dubious_on": null,
                      "marked_uncollectible_on": null,
                      "reminder_count": 0,
                      "next_reminder": "2099-01-01",
                      "original_estimate_id": null,
                      "url": "http://moneybird.dev/123/external/0000000000000000000000000000000000000000000000000000000000000001/9805196ded617c06adc44a5e19d26868a42581fb7d45ab0baf2bcc67d5487df9/sales_invoice",
                      "payment_url": "http://moneybird.dev/123/external/0000000000000000000000000000000000000000000000000000000000000001/9805196ded617c06adc44a5e19d26868a42581fb7d45ab0baf2bcc67d5487df9/sales_invoice",
                      "custom_fields": [],
                      "notes": [],
                      "attachments": [],
                      "events": [
                        {
                          "administration_id": 123,
                          "user_id": "502689108256097381",
                          "action": "sales_invoice_created",
                          "link_entity_id": null,
                          "link_entity_type": null,
                          "data": {},
                          "created_at": "2026-11-02T12:15:51.040Z",
                          "updated_at": "2026-11-02T12:15:51.040Z"
                        },
                        {
                          "administration_id": 123,
                          "user_id": "502689108256097381",
                          "action": "sales_invoice_state_changed_to_open",
                          "link_entity_id": null,
                          "link_entity_type": null,
                          "data": {},
                          "created_at": "2026-11-02T12:15:51.075Z",
                          "updated_at": "2026-11-02T12:15:51.075Z"
                        },
                        {
                          "administration_id": 123,
                          "user_id": "502689108256097381",
                          "action": "sales_invoice_send_email",
                          "link_entity_id": null,
                          "link_entity_type": null,
                          "data": {
                            "email_address": "info@example.com; janjanssen@dev.null.moneybird.net",
                            "email_message": "Geachte Jan Janssen,\n\nIn de bijlage kunt u factuur 2026-0001 voor onze diensten vinden. Wij verzoeken u vriendelijk de factuur voor 16-11-2026 te voldoen.\n\nMet vriendelijke groet,\n\nParkietje B.V."
                          },
                          "created_at": "2026-11-02T12:15:51.102Z",
                          "updated_at": "2026-11-02T12:15:51.102Z"
                        },
                        {
                          "administration_id": 123,
                          "user_id": "502689108256097381",
                          "action": "sales_invoice_paused",
                          "link_entity_id": null,
                          "link_entity_type": null,
                          "data": {},
                          "created_at": "2026-11-02T12:15:51.127Z",
                          "updated_at": "2026-11-02T12:15:51.127Z"
                        }
                      ],
                      "tax_totals": [
                        {
                          "tax_rate_id": "502689108899923082",
                          "taxable_amount": "300.0",
                          "taxable_amount_base": "300.0",
                          "tax_amount": "63.0",
                          "tax_amount_base": "63.0"
                        }
                      ],
                      "time_entries": []
                    }
                  }
                }
              }
            }
          },
          "404": {
            "$ref": "#/components/responses/404_not_found"
          }
        },
        "operationId": "post_administration_id_sales_invoices_id_pause"
      }
    },
    "/{administration_id}/sales_invoices/{id}/register_payment{format}": {
      "patch": {
        "summary": "Register a payment",
        "description": "This endpoint is deprecated and should no longer be used. It has been replaced by [Create a payment](#post_sales_invoices_sales_invoice_id_payments).\n\n### Required scope(s)\n `sales_invoices`",
        "deprecated": true,
        "x-sunset": "2026-12-31",
        "tags": [
          "Sales invoices"
        ],
        "security": [
          {
            "bearerAuth": [
              "sales_invoices"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/administration_id"
          },
          {
            "name": "id",
            "in": "path",
            "required": true,
            "schema": {
              "$ref": "#/components/schemas/identifier"
            }
          },
          {
            "$ref": "#/components/parameters/format"
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/*": {
              "schema": {
                "unevaluatedProperties": false,
                "type": "object",
                "properties": {
                  "payment": {
                    "type": "object",
                    "unevaluatedProperties": false,
                    "properties": {
                      "payment_date": {
                        "type": "string"
                      },
                      "price": {
                        "$ref": "#/components/schemas/money"
                      },
                      "price_base": {
                        "$ref": "#/components/schemas/money",
                        "description": "Amount paid expressed in the base currency. Required for foreign currencies."
                      },
                      "financial_account_id": {
                        "$ref": "#/components/schemas/identifier",
                        "description": "Should be a valid financial account id."
                      },
                      "financial_mutation_id": {
                        "$ref": "#/components/schemas/identifier",
                        "description": "Should be a valid financial mutation id."
                      },
                      "transaction_identifier": {
                        "type": "string"
                      },
                      "manual_payment_action": {
                        "type": "string",
                        "description": "Can be `private_payment`, `payment_without_proof`, `cash_payment`, `rounding_error`, `bank_transfer`, `balance_settlement` or `invoices_settlement`."
                      },
                      "ledger_account_id": {
                        "$ref": "#/components/schemas/identifier",
                        "description": "Should be a valid ledger account id."
                      },
                      "invoice_id": {
                        "$ref": "#/components/schemas/identifier"
                      }
                    },
                    "required": [
                      "payment_date",
                      "price"
                    ]
                  }
                },
                "required": []
              },
              "examples": {
                "RegistersPayments": {
                  "summary": "Registers payments",
                  "value": {
                    "payment": {
                      "payment_date": "2026-11-02T12:15:48.590Z",
                      "price": "363.0"
                    }
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Sales invoice updated",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "additionalProperties": true
                },
                "examples": {
                  "RegistersPayments": {
                    "summary": "Registers payments",
                    "value": {
                      "id": "502689145164924332",
                      "administration_id": 123,
                      "invoice_type": "SalesInvoice",
                      "invoice_id": "502689145072649628",
                      "financial_account_id": null,
                      "user_id": "502689108256097381",
                      "payment_transaction_id": null,
                      "transaction_identifier": null,
                      "price": "363.0",
                      "price_base": "363.0",
                      "payment_date": "2026-11-02",
                      "credit_invoice_id": null,
                      "financial_mutation_id": null,
                      "ledger_account_id": "502689108803454083",
                      "linked_payment_id": null,
                      "manual_payment_action": null,
                      "created_at": "2026-11-02T12:15:48.600Z",
                      "updated_at": "2026-11-02T12:15:48.600Z"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "$ref": "#/components/responses/400_bad_request"
          },
          "404": {
            "$ref": "#/components/responses/404_not_found"
          },
          "422": {
            "$ref": "#/components/responses/422_unprocessable_entity"
          }
        },
        "operationId": "patch_administration_id_sales_invoices_id_register_payment"
      }
    },
    "/{administration_id}/sales_invoices/{id}/register_payment_creditinvoice{format}": {
      "patch": {
        "summary": "Register a payment for a creditinvoice",
        "description": "Settles a credit invoice against the sales invoice it credits. On the\nsettlements ledger account, one payment is booked on each invoice, so they\nsettle against each other. Both use today as the payment date and the total\namount of the credit invoice, so no request body values are needed.\nThe invoice must be a credit invoice, it must have an original invoice, and\nboth invoices must be in a state that accepts a payment.\n\n### Required scope(s)\n `sales_invoices`",
        "tags": [
          "Sales invoices"
        ],
        "security": [
          {
            "bearerAuth": [
              "sales_invoices"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/administration_id"
          },
          {
            "name": "id",
            "in": "path",
            "required": true,
            "schema": {
              "$ref": "#/components/schemas/identifier"
            }
          },
          {
            "$ref": "#/components/parameters/format"
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/*": {
              "schema": {
                "unevaluatedProperties": false,
                "type": "object"
              },
              "examples": {
                "RegistersPaymentsForACreditInvoice": {
                  "summary": "Registers payments for a credit invoice",
                  "value": {}
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Sales invoice updated",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/sales_invoice_response"
                },
                "examples": {
                  "RegistersPaymentsForACreditInvoice": {
                    "summary": "Registers payments for a credit invoice",
                    "value": {
                      "id": "502689147314505331",
                      "administration_id": 123,
                      "contact_id": "502689147150927457",
                      "contact": {
                        "id": "502689147150927457",
                        "administration_id": 123,
                        "company_name": "Foobar Holding B.V.",
                        "firstname": null,
                        "lastname": null,
                        "address1": "Hoofdstraat 12",
                        "address2": null,
                        "zipcode": "1234AB",
                        "city": "Amsterdam",
                        "country": "NL",
                        "phone": null,
                        "delivery_method": "Email",
                        "customer_id": "customer-1",
                        "tax_number": null,
                        "chamber_of_commerce": null,
                        "bank_account": null,
                        "is_trusted": false,
                        "max_transfer_amount": null,
                        "attention": null,
                        "email": "info@example.com",
                        "email_ubl": true,
                        "send_invoices_to_attention": null,
                        "send_invoices_to_email": "info@example.com",
                        "send_estimates_to_attention": null,
                        "send_estimates_to_email": "info@example.com",
                        "direct_debit": false,
                        "sepa_active": false,
                        "sepa_iban": null,
                        "sepa_iban_account_name": null,
                        "sepa_bic": null,
                        "sepa_mandate_id": null,
                        "sepa_mandate_date": null,
                        "sepa_sequence_type": "RCUR",
                        "credit_card_number": null,
                        "credit_card_reference": null,
                        "credit_card_type": null,
                        "tax_number_validated_at": null,
                        "tax_number_valid": null,
                        "invoice_workflow_id": null,
                        "estimate_workflow_id": null,
                        "si_identifier": null,
                        "si_identifier_type": null,
                        "moneybird_payments_mandate": false,
                        "created_at": "2026-11-02T12:15:50.494Z",
                        "updated_at": "2026-11-02T12:15:50.494Z",
                        "version": 1793621750,
                        "sales_invoices_url": "https://moneybird.dev/123/sales_invoices/0000000000000000000000000000000000000000000000000000000000000001/all",
                        "notes": [],
                        "custom_fields": [],
                        "contact_people": [],
                        "archived": false
                      },
                      "contact_person_id": null,
                      "contact_person": null,
                      "invoice_id": "2026-0002",
                      "recurring_sales_invoice_id": null,
                      "subscription_id": null,
                      "workflow_id": "502689109097055375",
                      "document_style_id": "502689109280556185",
                      "identity_id": "502689108656653419",
                      "draft_id": null,
                      "state": "paid",
                      "invoice_date": "2026-11-02",
                      "due_date": "2026-11-16",
                      "payment_conditions": "We verzoeken u vriendelijk het bovenstaande bedrag van {document.total_price} voor {document.due_date} te voldoen op onze bankrekening onder vermelding van de omschrijving {document.payment_reference}. Voor vragen kunt u contact opnemen per e-mail.",
                      "payment_reference": "RF080000000000000GPHGKG5X",
                      "short_payment_reference": "RF08GPHGKG5X",
                      "reference": "Project X",
                      "language": "nl",
                      "currency": "EUR",
                      "discount": "0.0",
                      "original_sales_invoice_id": "502689147189724771",
                      "paused": false,
                      "paid_at": "2026-11-02",
                      "sent_at": "2026-11-02",
                      "created_at": "2026-11-02T12:15:50.650Z",
                      "updated_at": "2026-11-02T12:15:50.780Z",
                      "public_view_code": "119126",
                      "public_view_code_expires_at": "2027-02-02T12:15:50.699Z",
                      "version": 1793621750,
                      "details": [
                        {
                          "id": "502689147317651060",
                          "administration_id": 123,
                          "tax_rate_id": "502689108899923082",
                          "ledger_account_id": "502689108787725434",
                          "project_id": null,
                          "product_id": null,
                          "amount": null,
                          "amount_decimal": "1.0",
                          "description": "**Creditfactuur voor factuur 2026-0001**",
                          "price": "0.0",
                          "period": null,
                          "row_order": 1,
                          "total_price_excl_tax_with_discount": "0.0",
                          "total_price_excl_tax_with_discount_base": "0.0",
                          "tax_report_reference": [
                            "NL/1a"
                          ],
                          "mandatory_tax_text": "",
                          "created_at": "2026-11-02T12:15:50.653Z",
                          "updated_at": "2026-11-02T12:15:50.730Z"
                        },
                        {
                          "id": "502689147318699637",
                          "administration_id": 123,
                          "tax_rate_id": "502689108899923082",
                          "ledger_account_id": "502689108787725434",
                          "project_id": null,
                          "product_id": null,
                          "amount": "-1 x",
                          "amount_decimal": "-1.0",
                          "description": "Project X",
                          "price": "300.0",
                          "period": null,
                          "row_order": 2,
                          "total_price_excl_tax_with_discount": "-300.0",
                          "total_price_excl_tax_with_discount_base": "-300.0",
                          "tax_report_reference": [
                            "NL/1a"
                          ],
                          "mandatory_tax_text": null,
                          "created_at": "2026-11-02T12:15:50.655Z",
                          "updated_at": "2026-11-02T12:15:50.732Z"
                        }
                      ],
                      "payments": [
                        {
                          "id": "502689147440334467",
                          "administration_id": 123,
                          "invoice_type": "SalesInvoice",
                          "invoice_id": "502689147314505331",
                          "financial_account_id": null,
                          "user_id": "502689108256097381",
                          "payment_transaction_id": null,
                          "transaction_identifier": null,
                          "price": "-363.0",
                          "price_base": "-363.0",
                          "payment_date": "2026-11-02",
                          "credit_invoice_id": null,
                          "financial_mutation_id": null,
                          "ledger_account_id": "502689108803454086",
                          "linked_payment_id": null,
                          "manual_payment_action": null,
                          "created_at": "2026-11-02T12:15:50.771Z",
                          "updated_at": "2026-11-02T12:15:50.771Z"
                        }
                      ],
                      "total_paid": "-363.0",
                      "total_unpaid": "0.0",
                      "total_unpaid_base": "0.0",
                      "prices_are_incl_tax": false,
                      "total_price_excl_tax": "-300.0",
                      "total_price_excl_tax_base": "-300.0",
                      "total_price_incl_tax": "-363.0",
                      "total_price_incl_tax_base": "-363.0",
                      "total_discount": "0.0",
                      "marked_dubious_on": null,
                      "marked_uncollectible_on": null,
                      "reminder_count": 0,
                      "next_reminder": "2026-11-16",
                      "original_estimate_id": null,
                      "url": "http://moneybird.dev/123/external/0000000000000000000000000000000000000000000000000000000000000001/d17b583cf539c849b34f25ac0327094d29f443e5e7c1e762f7b9a6a89f15498f/sales_invoice",
                      "payment_url": "http://moneybird.dev/123/external/0000000000000000000000000000000000000000000000000000000000000001/d17b583cf539c849b34f25ac0327094d29f443e5e7c1e762f7b9a6a89f15498f/sales_invoice",
                      "custom_fields": [],
                      "notes": [],
                      "attachments": [],
                      "events": [
                        {
                          "administration_id": 123,
                          "user_id": "502689108256097381",
                          "action": "credit_invoice_created_from_original",
                          "link_entity_id": null,
                          "link_entity_type": null,
                          "data": {
                            "original_invoice": "2026-0001"
                          },
                          "created_at": "2026-11-02T12:15:50.657Z",
                          "updated_at": "2026-11-02T12:15:50.657Z"
                        },
                        {
                          "administration_id": 123,
                          "user_id": "502689108256097381",
                          "action": "sales_invoice_state_changed_to_open",
                          "link_entity_id": null,
                          "link_entity_type": null,
                          "data": {},
                          "created_at": "2026-11-02T12:15:50.708Z",
                          "updated_at": "2026-11-02T12:15:50.708Z"
                        },
                        {
                          "administration_id": 123,
                          "user_id": "502689108256097381",
                          "action": "sales_invoice_send_email",
                          "link_entity_id": null,
                          "link_entity_type": null,
                          "data": {
                            "email_address": "info@example.com",
                            "email_message": "Geachte Foobar Holding B.V.,\n\nIn de bijlage kunt u factuur 2026-0002 voor onze diensten vinden. Wij verzoeken u vriendelijk de factuur voor 16-11-2026 te voldoen.\n\nMet vriendelijke groet,\n\nParkietje B.V."
                          },
                          "created_at": "2026-11-02T12:15:50.749Z",
                          "updated_at": "2026-11-02T12:15:50.749Z"
                        },
                        {
                          "administration_id": 123,
                          "user_id": "502689108256097381",
                          "action": "sales_invoice_state_changed_to_paid",
                          "link_entity_id": null,
                          "link_entity_type": null,
                          "data": {},
                          "created_at": "2026-11-02T12:15:50.773Z",
                          "updated_at": "2026-11-02T12:15:50.773Z"
                        }
                      ],
                      "tax_totals": [
                        {
                          "tax_rate_id": "502689108899923082",
                          "taxable_amount": "-300.0",
                          "taxable_amount_base": "-300.0",
                          "tax_amount": "-63.0",
                          "tax_amount_base": "-63.0"
                        }
                      ],
                      "time_entries": []
                    }
                  }
                }
              }
            }
          },
          "400": {
            "$ref": "#/components/responses/400_bad_request"
          },
          "404": {
            "$ref": "#/components/responses/404_not_found"
          }
        },
        "operationId": "patch_administration_id_sales_invoices_id_register_payment_creditinvoice"
      }
    },
    "/{administration_id}/sales_invoices/{id}/resume{format}": {
      "post": {
        "summary": "Resume sales invoice",
        "description": "This endpoint resumes the sales invoice. The automatic workflow steps will execute again after resuming.\n\n### Required scope(s)\n `sales_invoices`",
        "tags": [
          "Sales invoices"
        ],
        "security": [
          {
            "bearerAuth": [
              "sales_invoices"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/administration_id"
          },
          {
            "name": "id",
            "in": "path",
            "required": true,
            "schema": {
              "$ref": "#/components/schemas/identifier"
            }
          },
          {
            "$ref": "#/components/parameters/format"
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/*": {
              "schema": {
                "unevaluatedProperties": false,
                "type": "object"
              },
              "examples": {
                "ResumesTheSalesInvoice": {
                  "summary": "Resumes the sales invoice",
                  "value": {}
                }
              }
            }
          }
        },
        "responses": {
          "201": {
            "description": "Sales invoice resumed",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/sales_invoice_response"
                },
                "examples": {
                  "ResumesTheSalesInvoice": {
                    "summary": "Resumes the sales invoice",
                    "value": {
                      "id": "502689152857277788",
                      "administration_id": 123,
                      "contact_id": "502689152825820503",
                      "contact": {
                        "id": "502689152825820503",
                        "administration_id": 123,
                        "company_name": "Foobar Holding B.V.",
                        "firstname": null,
                        "lastname": null,
                        "address1": "Hoofdstraat 12",
                        "address2": null,
                        "zipcode": "1234AB",
                        "city": "Amsterdam",
                        "country": "NL",
                        "phone": null,
                        "delivery_method": "Email",
                        "customer_id": "customer-1",
                        "tax_number": null,
                        "chamber_of_commerce": null,
                        "bank_account": null,
                        "is_trusted": false,
                        "max_transfer_amount": null,
                        "attention": null,
                        "email": "info@example.com",
                        "email_ubl": true,
                        "send_invoices_to_attention": null,
                        "send_invoices_to_email": "info@example.com",
                        "send_estimates_to_attention": null,
                        "send_estimates_to_email": "info@example.com",
                        "direct_debit": false,
                        "sepa_active": false,
                        "sepa_iban": null,
                        "sepa_iban_account_name": null,
                        "sepa_bic": null,
                        "sepa_mandate_id": null,
                        "sepa_mandate_date": null,
                        "sepa_sequence_type": "RCUR",
                        "credit_card_number": null,
                        "credit_card_reference": null,
                        "credit_card_type": null,
                        "tax_number_validated_at": null,
                        "tax_number_valid": null,
                        "invoice_workflow_id": null,
                        "estimate_workflow_id": null,
                        "si_identifier": null,
                        "si_identifier_type": null,
                        "moneybird_payments_mandate": false,
                        "created_at": "2026-11-02T12:15:55.906Z",
                        "updated_at": "2026-11-02T12:15:55.906Z",
                        "version": 1793621755,
                        "sales_invoices_url": "https://moneybird.dev/123/sales_invoices/0000000000000000000000000000000000000000000000000000000000000001/all",
                        "notes": [],
                        "custom_fields": [],
                        "contact_people": [],
                        "archived": false
                      },
                      "contact_person_id": "502689152827917657",
                      "contact_person": {
                        "id": null,
                        "contact_id": "502689152825820503",
                        "administration_id": 123,
                        "firstname": "Jan",
                        "lastname": "Janssen",
                        "phone": "123-456-2346",
                        "email": "janjanssen@dev.null.moneybird.net",
                        "department": "Sales",
                        "created_at": "2026-11-02T12:15:55.909Z",
                        "updated_at": "2026-11-02T12:15:55.909Z",
                        "version": 1793621755
                      },
                      "invoice_id": "2026-0001",
                      "recurring_sales_invoice_id": null,
                      "subscription_id": null,
                      "workflow_id": "502689109097055375",
                      "document_style_id": "502689109280556185",
                      "identity_id": "502689108656653419",
                      "draft_id": null,
                      "state": "open",
                      "invoice_date": "2026-11-02",
                      "due_date": "2026-11-16",
                      "payment_conditions": "We verzoeken u vriendelijk het bovenstaande bedrag van {document.total_price} voor {document.due_date} te voldoen op onze bankrekening onder vermelding van de omschrijving {document.payment_reference}. Voor vragen kunt u contact opnemen per e-mail.",
                      "payment_reference": "RF690000000000000Z9P9RWGH",
                      "short_payment_reference": "RF69Z9P9RWGH",
                      "reference": "Project X",
                      "language": "nl",
                      "currency": "EUR",
                      "discount": "0.0",
                      "original_sales_invoice_id": null,
                      "paused": false,
                      "paid_at": null,
                      "sent_at": "2026-11-02",
                      "created_at": "2026-11-02T12:15:55.936Z",
                      "updated_at": "2026-11-02T12:15:56.024Z",
                      "public_view_code": "343978",
                      "public_view_code_expires_at": "2027-02-02T12:15:55.969Z",
                      "version": 1793621756,
                      "details": [
                        {
                          "id": "502689152859374941",
                          "administration_id": 123,
                          "tax_rate_id": "502689108899923082",
                          "ledger_account_id": "502689108787725434",
                          "project_id": null,
                          "product_id": null,
                          "amount": "1 x",
                          "amount_decimal": "1.0",
                          "description": "Project X",
                          "price": "300.0",
                          "period": "20261101..20261130",
                          "row_order": 1,
                          "total_price_excl_tax_with_discount": "300.0",
                          "total_price_excl_tax_with_discount_base": "300.0",
                          "tax_report_reference": [
                            "NL/1a"
                          ],
                          "mandatory_tax_text": null,
                          "created_at": "2026-11-02T12:15:55.939Z",
                          "updated_at": "2026-11-02T12:15:55.989Z"
                        }
                      ],
                      "payments": [],
                      "total_paid": "0.0",
                      "total_unpaid": "363.0",
                      "total_unpaid_base": "363.0",
                      "prices_are_incl_tax": false,
                      "total_price_excl_tax": "300.0",
                      "total_price_excl_tax_base": "300.0",
                      "total_price_incl_tax": "363.0",
                      "total_price_incl_tax_base": "363.0",
                      "total_discount": "0.0",
                      "marked_dubious_on": null,
                      "marked_uncollectible_on": null,
                      "reminder_count": 0,
                      "next_reminder": "2026-11-16",
                      "original_estimate_id": null,
                      "url": "http://moneybird.dev/123/external/0000000000000000000000000000000000000000000000000000000000000001/6847914eb71bd3066fd75b1430c84f11db734140152979631b48a15a385bc546/sales_invoice",
                      "payment_url": "http://moneybird.dev/123/external/0000000000000000000000000000000000000000000000000000000000000001/6847914eb71bd3066fd75b1430c84f11db734140152979631b48a15a385bc546/sales_invoice",
                      "custom_fields": [],
                      "notes": [],
                      "attachments": [],
                      "events": [
                        {
                          "administration_id": 123,
                          "user_id": "502689108256097381",
                          "action": "sales_invoice_created",
                          "link_entity_id": null,
                          "link_entity_type": null,
                          "data": {},
                          "created_at": "2026-11-02T12:15:55.941Z",
                          "updated_at": "2026-11-02T12:15:55.941Z"
                        },
                        {
                          "administration_id": 123,
                          "user_id": "502689108256097381",
                          "action": "sales_invoice_state_changed_to_open",
                          "link_entity_id": null,
                          "link_entity_type": null,
                          "data": {},
                          "created_at": "2026-11-02T12:15:55.976Z",
                          "updated_at": "2026-11-02T12:15:55.976Z"
                        },
                        {
                          "administration_id": 123,
                          "user_id": "502689108256097381",
                          "action": "sales_invoice_send_email",
                          "link_entity_id": null,
                          "link_entity_type": null,
                          "data": {
                            "email_address": "info@example.com; janjanssen@dev.null.moneybird.net",
                            "email_message": "Geachte Jan Janssen,\n\nIn de bijlage kunt u factuur 2026-0001 voor onze diensten vinden. Wij verzoeken u vriendelijk de factuur voor 16-11-2026 te voldoen.\n\nMet vriendelijke groet,\n\nParkietje B.V."
                          },
                          "created_at": "2026-11-02T12:15:56.000Z",
                          "updated_at": "2026-11-02T12:15:56.000Z"
                        },
                        {
                          "administration_id": 123,
                          "user_id": "502689108256097381",
                          "action": "sales_invoice_unpaused",
                          "link_entity_id": null,
                          "link_entity_type": null,
                          "data": {},
                          "created_at": "2026-11-02T12:15:56.026Z",
                          "updated_at": "2026-11-02T12:15:56.026Z"
                        }
                      ],
                      "tax_totals": [
                        {
                          "tax_rate_id": "502689108899923082",
                          "taxable_amount": "300.0",
                          "taxable_amount_base": "300.0",
                          "tax_amount": "63.0",
                          "tax_amount_base": "63.0"
                        }
                      ],
                      "time_entries": []
                    }
                  }
                }
              }
            }
          },
          "404": {
            "$ref": "#/components/responses/404_not_found"
          }
        },
        "operationId": "post_administration_id_sales_invoices_id_resume"
      }
    },
    "/{administration_id}/sales_invoices/{id}/send_invoice{format}": {
      "patch": {
        "summary": "Sends an invoice",
        "description": "This endpoint provides two options: sending the invoice and scheduling sending in the future. When sending\nnow, you can provide a send method, email address and message. If you don't provide any arguments, the defaults\nfrom the contact and workflow will be used. If you have sent the invoice before, then the settings from\nthe previous sending are used instead of the defaults.\n\nWhen scheduling sending, set the boolean `sending_scheduled` to true and provide an `invoice_date`.\n\n### Required scope(s)\n `sales_invoices`",
        "tags": [
          "Sales invoices"
        ],
        "security": [
          {
            "bearerAuth": [
              "sales_invoices"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/administration_id"
          },
          {
            "name": "id",
            "in": "path",
            "required": true,
            "schema": {
              "$ref": "#/components/schemas/identifier"
            }
          },
          {
            "$ref": "#/components/parameters/format"
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/*": {
              "schema": {
                "unevaluatedProperties": false,
                "type": "object",
                "properties": {
                  "sales_invoice_sending": {
                    "type": "object",
                    "unevaluatedProperties": false,
                    "properties": {
                      "delivery_method": {
                        "type": "string",
                        "enum": [
                          "Email",
                          "Peppol",
                          "Manual"
                        ]
                      },
                      "sending_scheduled": {
                        "type": [
                          "boolean",
                          "string"
                        ],
                        "default": false,
                        "description": "Schedule the invoice to be sent in the future instead of immediately. Combine with `invoice_date` to set the date on which it is sent."
                      },
                      "deliver_ubl": {
                        "type": [
                          "boolean",
                          "string"
                        ],
                        "description": "Attach a UBL (e-invoicing) file to the email. Only used when `delivery_method` is `Email`; defaults to the contact's UBL preference."
                      },
                      "mergeable": {
                        "type": [
                          "boolean",
                          "string"
                        ],
                        "default": false,
                        "description": "When multiple scheduled invoices share the same contact, identity, workflow, document style, currency, language and invoice date, merge them into a single invoice before sending."
                      },
                      "email_address": {
                        "type": "string",
                        "description": "Recipient email address. Only used when `delivery_method` is `Email`; overrides the contact's default email address."
                      },
                      "email_message": {
                        "type": "string",
                        "description": "Message included in the email. Only used when `delivery_method` is `Email`; defaults to the workflow's invoice email text."
                      },
                      "invoice_date": {
                        "type": "string",
                        "format": "date",
                        "description": "When scheduling, the date on which the invoice is sent."
                      }
                    },
                    "required": []
                  }
                },
                "required": []
              },
              "examples": {
                "SendsAnInvoiceViaMailWithAnUblAttachment": {
                  "summary": "Sends an invoice via mail with an ubl attachment",
                  "value": {
                    "sales_invoice_sending": {
                      "delivery_method": "Email",
                      "deliver_ubl": true,
                      "email_address": "alternative@example.com"
                    }
                  }
                },
                "SendsAnInvoice": {
                  "summary": "Sends an invoice",
                  "value": {}
                },
                "SendsAnInvoiceWithAlternativeInformation": {
                  "summary": "Sends an invoice with alternative information",
                  "value": {
                    "sales_invoice_sending": {
                      "delivery_method": "Email",
                      "email_address": "alternative@example.com",
                      "email_message": "Hi, this is my invoice with id {invoice_id}!"
                    }
                  }
                },
                "ScheduleSending": {
                  "summary": "Schedule sending",
                  "value": {
                    "sales_invoice_sending": {
                      "sending_scheduled": true,
                      "invoice_date": "2026-11-03"
                    }
                  }
                },
                "FallsBackToE-mailDeliveryWhenSendingSimplerinvoicingForTheSecondTime": {
                  "summary": "Falls back to e-mail delivery when sending simplerinvoicing for the second time",
                  "value": {}
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Sales invoice updated",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/sales_invoice_response"
                },
                "examples": {
                  "SendsAnInvoiceViaMailWithAnUblAttachment": {
                    "summary": "Sends an invoice via mail with an ubl attachment",
                    "value": {
                      "id": "502689143152706797",
                      "administration_id": 123,
                      "contact_id": "502689143129638123",
                      "contact": {
                        "id": "502689143129638123",
                        "administration_id": 123,
                        "company_name": "Foobar Holding B.V.",
                        "firstname": null,
                        "lastname": null,
                        "address1": "Hoofdstraat 12",
                        "address2": null,
                        "zipcode": "1234AB",
                        "city": "Amsterdam",
                        "country": "NL",
                        "phone": null,
                        "delivery_method": "Email",
                        "customer_id": "customer-1",
                        "tax_number": null,
                        "chamber_of_commerce": null,
                        "bank_account": null,
                        "is_trusted": false,
                        "max_transfer_amount": null,
                        "attention": null,
                        "email": "info@example.com",
                        "email_ubl": true,
                        "send_invoices_to_attention": null,
                        "send_invoices_to_email": "info@example.com",
                        "send_estimates_to_attention": null,
                        "send_estimates_to_email": "info@example.com",
                        "direct_debit": false,
                        "sepa_active": false,
                        "sepa_iban": null,
                        "sepa_iban_account_name": null,
                        "sepa_bic": null,
                        "sepa_mandate_id": null,
                        "sepa_mandate_date": null,
                        "sepa_sequence_type": "RCUR",
                        "credit_card_number": null,
                        "credit_card_reference": null,
                        "credit_card_type": null,
                        "tax_number_validated_at": null,
                        "tax_number_valid": null,
                        "invoice_workflow_id": null,
                        "estimate_workflow_id": null,
                        "si_identifier": null,
                        "si_identifier_type": null,
                        "moneybird_payments_mandate": false,
                        "created_at": "2026-11-02T12:15:46.660Z",
                        "updated_at": "2026-11-02T12:15:46.660Z",
                        "version": 1793621746,
                        "sales_invoices_url": "https://moneybird.dev/123/sales_invoices/0000000000000000000000000000000000000000000000000000000000000001/all",
                        "notes": [],
                        "custom_fields": [],
                        "contact_people": [],
                        "archived": false
                      },
                      "contact_person_id": null,
                      "contact_person": null,
                      "invoice_id": "2026-0001",
                      "recurring_sales_invoice_id": null,
                      "subscription_id": null,
                      "workflow_id": "502689109097055375",
                      "document_style_id": "502689109280556185",
                      "identity_id": "502689108656653419",
                      "draft_id": null,
                      "state": "open",
                      "invoice_date": "2026-11-02",
                      "due_date": "2026-11-16",
                      "payment_conditions": "We verzoeken u vriendelijk het bovenstaande bedrag van {document.total_price} voor {document.due_date} te voldoen op onze bankrekening onder vermelding van de omschrijving {document.payment_reference}. Voor vragen kunt u contact opnemen per e-mail.",
                      "payment_reference": "RF750000000000000UQZ4HJV2",
                      "short_payment_reference": "RF75UQZ4HJV2",
                      "reference": "Project X",
                      "language": "nl",
                      "currency": "EUR",
                      "discount": "0.0",
                      "original_sales_invoice_id": null,
                      "paused": false,
                      "paid_at": null,
                      "sent_at": "2026-11-02",
                      "created_at": "2026-11-02T12:15:46.682Z",
                      "updated_at": "2026-11-02T12:15:46.750Z",
                      "public_view_code": "034620",
                      "public_view_code_expires_at": "2027-02-02T12:15:46.719Z",
                      "version": 1793621746,
                      "details": [
                        {
                          "id": "502689143155852526",
                          "administration_id": 123,
                          "tax_rate_id": "502689108899923082",
                          "ledger_account_id": "502689108787725434",
                          "project_id": null,
                          "product_id": null,
                          "amount": "1 x",
                          "amount_decimal": "1.0",
                          "description": "Project X",
                          "price": "300.0",
                          "period": null,
                          "row_order": 1,
                          "total_price_excl_tax_with_discount": "300.0",
                          "total_price_excl_tax_with_discount_base": "300.0",
                          "tax_report_reference": [
                            "NL/1a"
                          ],
                          "mandatory_tax_text": null,
                          "created_at": "2026-11-02T12:15:46.684Z",
                          "updated_at": "2026-11-02T12:15:46.749Z"
                        }
                      ],
                      "payments": [],
                      "total_paid": "0.0",
                      "total_unpaid": "363.0",
                      "total_unpaid_base": "363.0",
                      "prices_are_incl_tax": false,
                      "total_price_excl_tax": "300.0",
                      "total_price_excl_tax_base": "300.0",
                      "total_price_incl_tax": "363.0",
                      "total_price_incl_tax_base": "363.0",
                      "total_discount": "0.0",
                      "marked_dubious_on": null,
                      "marked_uncollectible_on": null,
                      "reminder_count": 0,
                      "next_reminder": "2026-11-16",
                      "original_estimate_id": null,
                      "url": "http://moneybird.dev/123/external/0000000000000000000000000000000000000000000000000000000000000001/487f2fd9e6eafe3ddf02abc676b45be84117f25b263fadbea221392d668102e2/sales_invoice",
                      "payment_url": "http://moneybird.dev/123/external/0000000000000000000000000000000000000000000000000000000000000001/487f2fd9e6eafe3ddf02abc676b45be84117f25b263fadbea221392d668102e2/sales_invoice",
                      "custom_fields": [],
                      "notes": [],
                      "attachments": [],
                      "events": [
                        {
                          "administration_id": 123,
                          "user_id": "502689108256097381",
                          "action": "sales_invoice_created",
                          "link_entity_id": null,
                          "link_entity_type": null,
                          "data": {},
                          "created_at": "2026-11-02T12:15:46.686Z",
                          "updated_at": "2026-11-02T12:15:46.686Z"
                        },
                        {
                          "administration_id": 123,
                          "user_id": "502689108256097381",
                          "action": "sales_invoice_state_changed_to_open",
                          "link_entity_id": null,
                          "link_entity_type": null,
                          "data": {},
                          "created_at": "2026-11-02T12:15:46.725Z",
                          "updated_at": "2026-11-02T12:15:46.725Z"
                        },
                        {
                          "administration_id": 123,
                          "user_id": "502689108256097381",
                          "action": "sales_invoice_send_email",
                          "link_entity_id": null,
                          "link_entity_type": null,
                          "data": {
                            "email_address": "alternative@example.com",
                            "email_message": "Geachte Foobar Holding B.V.,\n\nIn de bijlage kunt u factuur 2026-0001 voor onze diensten vinden. Wij verzoeken u vriendelijk de factuur voor 16-11-2026 te voldoen.\n\nMet vriendelijke groet,\n\nParkietje B.V."
                          },
                          "created_at": "2026-11-02T12:15:46.760Z",
                          "updated_at": "2026-11-02T12:15:46.760Z"
                        }
                      ],
                      "tax_totals": [
                        {
                          "tax_rate_id": "502689108899923082",
                          "taxable_amount": "300.0",
                          "taxable_amount_base": "300.0",
                          "tax_amount": "63.0",
                          "tax_amount_base": "63.0"
                        }
                      ],
                      "time_entries": []
                    }
                  },
                  "SendsAnInvoice": {
                    "summary": "Sends an invoice",
                    "value": {
                      "id": "502689143311041792",
                      "administration_id": 123,
                      "contact_id": "502689143287973118",
                      "contact": {
                        "id": "502689143287973118",
                        "administration_id": 123,
                        "company_name": "Foobar Holding B.V.",
                        "firstname": null,
                        "lastname": null,
                        "address1": "Hoofdstraat 12",
                        "address2": null,
                        "zipcode": "1234AB",
                        "city": "Amsterdam",
                        "country": "NL",
                        "phone": null,
                        "delivery_method": "Email",
                        "customer_id": "customer-1",
                        "tax_number": null,
                        "chamber_of_commerce": null,
                        "bank_account": null,
                        "is_trusted": false,
                        "max_transfer_amount": null,
                        "attention": null,
                        "email": "info@example.com",
                        "email_ubl": true,
                        "send_invoices_to_attention": null,
                        "send_invoices_to_email": "info@example.com",
                        "send_estimates_to_attention": null,
                        "send_estimates_to_email": "info@example.com",
                        "direct_debit": false,
                        "sepa_active": false,
                        "sepa_iban": null,
                        "sepa_iban_account_name": null,
                        "sepa_bic": null,
                        "sepa_mandate_id": null,
                        "sepa_mandate_date": null,
                        "sepa_sequence_type": "RCUR",
                        "credit_card_number": null,
                        "credit_card_reference": null,
                        "credit_card_type": null,
                        "tax_number_validated_at": null,
                        "tax_number_valid": null,
                        "invoice_workflow_id": null,
                        "estimate_workflow_id": null,
                        "si_identifier": null,
                        "si_identifier_type": null,
                        "moneybird_payments_mandate": false,
                        "created_at": "2026-11-02T12:15:46.810Z",
                        "updated_at": "2026-11-02T12:15:46.810Z",
                        "version": 1793621746,
                        "sales_invoices_url": "https://moneybird.dev/123/sales_invoices/0000000000000000000000000000000000000000000000000000000000000001/all",
                        "notes": [],
                        "custom_fields": [],
                        "contact_people": [],
                        "archived": false
                      },
                      "contact_person_id": null,
                      "contact_person": null,
                      "invoice_id": "2026-0001",
                      "recurring_sales_invoice_id": null,
                      "subscription_id": null,
                      "workflow_id": "502689109097055375",
                      "document_style_id": "502689109280556185",
                      "identity_id": "502689108656653419",
                      "draft_id": null,
                      "state": "open",
                      "invoice_date": "2026-11-02",
                      "due_date": "2026-11-16",
                      "payment_conditions": "We verzoeken u vriendelijk het bovenstaande bedrag van {document.total_price} voor {document.due_date} te voldoen op onze bankrekening onder vermelding van de omschrijving {document.payment_reference}. Voor vragen kunt u contact opnemen per e-mail.",
                      "payment_reference": "RF830000000000000C375WAFR",
                      "short_payment_reference": "RF83C375WAFR",
                      "reference": "Project X",
                      "language": "nl",
                      "currency": "EUR",
                      "discount": "0.0",
                      "original_sales_invoice_id": null,
                      "paused": false,
                      "paid_at": null,
                      "sent_at": "2026-11-02",
                      "created_at": "2026-11-02T12:15:46.833Z",
                      "updated_at": "2026-11-02T12:15:46.887Z",
                      "public_view_code": "496025",
                      "public_view_code_expires_at": "2027-02-02T12:15:46.869Z",
                      "version": 1793621746,
                      "details": [
                        {
                          "id": "502689143313138945",
                          "administration_id": 123,
                          "tax_rate_id": "502689108899923082",
                          "ledger_account_id": "502689108787725434",
                          "project_id": null,
                          "product_id": null,
                          "amount": "1 x",
                          "amount_decimal": "1.0",
                          "description": "Project X",
                          "price": "300.0",
                          "period": null,
                          "row_order": 1,
                          "total_price_excl_tax_with_discount": "300.0",
                          "total_price_excl_tax_with_discount_base": "300.0",
                          "tax_report_reference": [
                            "NL/1a"
                          ],
                          "mandatory_tax_text": null,
                          "created_at": "2026-11-02T12:15:46.835Z",
                          "updated_at": "2026-11-02T12:15:46.886Z"
                        }
                      ],
                      "payments": [],
                      "total_paid": "0.0",
                      "total_unpaid": "363.0",
                      "total_unpaid_base": "363.0",
                      "prices_are_incl_tax": false,
                      "total_price_excl_tax": "300.0",
                      "total_price_excl_tax_base": "300.0",
                      "total_price_incl_tax": "363.0",
                      "total_price_incl_tax_base": "363.0",
                      "total_discount": "0.0",
                      "marked_dubious_on": null,
                      "marked_uncollectible_on": null,
                      "reminder_count": 0,
                      "next_reminder": "2026-11-16",
                      "original_estimate_id": null,
                      "url": "http://moneybird.dev/123/external/0000000000000000000000000000000000000000000000000000000000000001/5475dd21f1fba9b48bd9e0d2324762c5780ae00abac1c2a22409aa4ac09ea3db/sales_invoice",
                      "payment_url": "http://moneybird.dev/123/external/0000000000000000000000000000000000000000000000000000000000000001/5475dd21f1fba9b48bd9e0d2324762c5780ae00abac1c2a22409aa4ac09ea3db/sales_invoice",
                      "custom_fields": [],
                      "notes": [],
                      "attachments": [],
                      "events": [
                        {
                          "administration_id": 123,
                          "user_id": "502689108256097381",
                          "action": "sales_invoice_created",
                          "link_entity_id": null,
                          "link_entity_type": null,
                          "data": {},
                          "created_at": "2026-11-02T12:15:46.837Z",
                          "updated_at": "2026-11-02T12:15:46.837Z"
                        },
                        {
                          "administration_id": 123,
                          "user_id": "502689108256097381",
                          "action": "sales_invoice_state_changed_to_open",
                          "link_entity_id": null,
                          "link_entity_type": null,
                          "data": {},
                          "created_at": "2026-11-02T12:15:46.875Z",
                          "updated_at": "2026-11-02T12:15:46.875Z"
                        },
                        {
                          "administration_id": 123,
                          "user_id": "502689108256097381",
                          "action": "sales_invoice_send_email",
                          "link_entity_id": null,
                          "link_entity_type": null,
                          "data": {
                            "email_address": "info@example.com",
                            "email_message": "Geachte Foobar Holding B.V.,\n\nIn de bijlage kunt u factuur 2026-0001 voor onze diensten vinden. Wij verzoeken u vriendelijk de factuur voor 16-11-2026 te voldoen.\n\nMet vriendelijke groet,\n\nParkietje B.V."
                          },
                          "created_at": "2026-11-02T12:15:46.896Z",
                          "updated_at": "2026-11-02T12:15:46.896Z"
                        }
                      ],
                      "tax_totals": [
                        {
                          "tax_rate_id": "502689108899923082",
                          "taxable_amount": "300.0",
                          "taxable_amount_base": "300.0",
                          "tax_amount": "63.0",
                          "tax_amount_base": "63.0"
                        }
                      ],
                      "time_entries": []
                    }
                  },
                  "SendsAnInvoiceWithAlternativeInformation": {
                    "summary": "Sends an invoice with alternative information",
                    "value": {
                      "id": "502689143465182483",
                      "administration_id": 123,
                      "contact_id": "502689143437919505",
                      "contact": {
                        "id": "502689143437919505",
                        "administration_id": 123,
                        "company_name": "Foobar Holding B.V.",
                        "firstname": null,
                        "lastname": null,
                        "address1": "Hoofdstraat 12",
                        "address2": null,
                        "zipcode": "1234AB",
                        "city": "Amsterdam",
                        "country": "NL",
                        "phone": null,
                        "delivery_method": "Email",
                        "customer_id": "customer-1",
                        "tax_number": null,
                        "chamber_of_commerce": null,
                        "bank_account": null,
                        "is_trusted": false,
                        "max_transfer_amount": null,
                        "attention": null,
                        "email": "info@example.com",
                        "email_ubl": true,
                        "send_invoices_to_attention": null,
                        "send_invoices_to_email": "info@example.com",
                        "send_estimates_to_attention": null,
                        "send_estimates_to_email": "info@example.com",
                        "direct_debit": false,
                        "sepa_active": false,
                        "sepa_iban": null,
                        "sepa_iban_account_name": null,
                        "sepa_bic": null,
                        "sepa_mandate_id": null,
                        "sepa_mandate_date": null,
                        "sepa_sequence_type": "RCUR",
                        "credit_card_number": null,
                        "credit_card_reference": null,
                        "credit_card_type": null,
                        "tax_number_validated_at": null,
                        "tax_number_valid": null,
                        "invoice_workflow_id": null,
                        "estimate_workflow_id": null,
                        "si_identifier": null,
                        "si_identifier_type": null,
                        "moneybird_payments_mandate": false,
                        "created_at": "2026-11-02T12:15:46.953Z",
                        "updated_at": "2026-11-02T12:15:46.953Z",
                        "version": 1793621746,
                        "sales_invoices_url": "https://moneybird.dev/123/sales_invoices/0000000000000000000000000000000000000000000000000000000000000001/all",
                        "notes": [],
                        "custom_fields": [],
                        "contact_people": [],
                        "archived": false
                      },
                      "contact_person_id": null,
                      "contact_person": null,
                      "invoice_id": "2026-0001",
                      "recurring_sales_invoice_id": null,
                      "subscription_id": null,
                      "workflow_id": "502689109097055375",
                      "document_style_id": "502689109280556185",
                      "identity_id": "502689108656653419",
                      "draft_id": null,
                      "state": "open",
                      "invoice_date": "2026-11-02",
                      "due_date": "2026-11-16",
                      "payment_conditions": "We verzoeken u vriendelijk het bovenstaande bedrag van {document.total_price} voor {document.due_date} te voldoen op onze bankrekening onder vermelding van de omschrijving {document.payment_reference}. Voor vragen kunt u contact opnemen per e-mail.",
                      "payment_reference": "RF5000000000000006YFT5Y4V",
                      "short_payment_reference": "RF506YFT5Y4V",
                      "reference": "Project X",
                      "language": "nl",
                      "currency": "EUR",
                      "discount": "0.0",
                      "original_sales_invoice_id": null,
                      "paused": false,
                      "paid_at": null,
                      "sent_at": "2026-11-02",
                      "created_at": "2026-11-02T12:15:46.980Z",
                      "updated_at": "2026-11-02T12:15:47.042Z",
                      "public_view_code": "812119",
                      "public_view_code_expires_at": "2027-02-02T12:15:47.021Z",
                      "version": 1793621747,
                      "details": [
                        {
                          "id": "502689143467279636",
                          "administration_id": 123,
                          "tax_rate_id": "502689108899923082",
                          "ledger_account_id": "502689108787725434",
                          "project_id": null,
                          "product_id": null,
                          "amount": "1 x",
                          "amount_decimal": "1.0",
                          "description": "Project X",
                          "price": "300.0",
                          "period": null,
                          "row_order": 1,
                          "total_price_excl_tax_with_discount": "300.0",
                          "total_price_excl_tax_with_discount_base": "300.0",
                          "tax_report_reference": [
                            "NL/1a"
                          ],
                          "mandatory_tax_text": null,
                          "created_at": "2026-11-02T12:15:46.982Z",
                          "updated_at": "2026-11-02T12:15:47.041Z"
                        }
                      ],
                      "payments": [],
                      "total_paid": "0.0",
                      "total_unpaid": "363.0",
                      "total_unpaid_base": "363.0",
                      "prices_are_incl_tax": false,
                      "total_price_excl_tax": "300.0",
                      "total_price_excl_tax_base": "300.0",
                      "total_price_incl_tax": "363.0",
                      "total_price_incl_tax_base": "363.0",
                      "total_discount": "0.0",
                      "marked_dubious_on": null,
                      "marked_uncollectible_on": null,
                      "reminder_count": 0,
                      "next_reminder": "2026-11-16",
                      "original_estimate_id": null,
                      "url": "http://moneybird.dev/123/external/0000000000000000000000000000000000000000000000000000000000000001/bbd8dd7511889fa9163690f37acdaf64803073312c5186f6829a39acbe83ef65/sales_invoice",
                      "payment_url": "http://moneybird.dev/123/external/0000000000000000000000000000000000000000000000000000000000000001/bbd8dd7511889fa9163690f37acdaf64803073312c5186f6829a39acbe83ef65/sales_invoice",
                      "custom_fields": [],
                      "notes": [],
                      "attachments": [],
                      "events": [
                        {
                          "administration_id": 123,
                          "user_id": "502689108256097381",
                          "action": "sales_invoice_created",
                          "link_entity_id": null,
                          "link_entity_type": null,
                          "data": {},
                          "created_at": "2026-11-02T12:15:46.985Z",
                          "updated_at": "2026-11-02T12:15:46.985Z"
                        },
                        {
                          "administration_id": 123,
                          "user_id": "502689108256097381",
                          "action": "sales_invoice_state_changed_to_open",
                          "link_entity_id": null,
                          "link_entity_type": null,
                          "data": {},
                          "created_at": "2026-11-02T12:15:47.027Z",
                          "updated_at": "2026-11-02T12:15:47.027Z"
                        },
                        {
                          "administration_id": 123,
                          "user_id": "502689108256097381",
                          "action": "sales_invoice_send_email",
                          "link_entity_id": null,
                          "link_entity_type": null,
                          "data": {
                            "email_address": "alternative@example.com",
                            "email_message": "Hi, this is my invoice with id {invoice_id}!"
                          },
                          "created_at": "2026-11-02T12:15:47.054Z",
                          "updated_at": "2026-11-02T12:15:47.054Z"
                        }
                      ],
                      "tax_totals": [
                        {
                          "tax_rate_id": "502689108899923082",
                          "taxable_amount": "300.0",
                          "taxable_amount_base": "300.0",
                          "tax_amount": "63.0",
                          "tax_amount_base": "63.0"
                        }
                      ],
                      "time_entries": []
                    }
                  },
                  "ScheduleSending": {
                    "summary": "Schedule sending",
                    "value": {
                      "id": "502689144119493946",
                      "administration_id": 123,
                      "contact_id": "502689144092230968",
                      "contact": {
                        "id": "502689144092230968",
                        "administration_id": 123,
                        "company_name": "Foobar Holding B.V.",
                        "firstname": null,
                        "lastname": null,
                        "address1": "Hoofdstraat 12",
                        "address2": null,
                        "zipcode": "1234AB",
                        "city": "Amsterdam",
                        "country": "NL",
                        "phone": null,
                        "delivery_method": "Email",
                        "customer_id": "customer-1",
                        "tax_number": null,
                        "chamber_of_commerce": null,
                        "bank_account": null,
                        "is_trusted": false,
                        "max_transfer_amount": null,
                        "attention": null,
                        "email": "info@example.com",
                        "email_ubl": true,
                        "send_invoices_to_attention": null,
                        "send_invoices_to_email": "info@example.com",
                        "send_estimates_to_attention": null,
                        "send_estimates_to_email": "info@example.com",
                        "direct_debit": false,
                        "sepa_active": false,
                        "sepa_iban": null,
                        "sepa_iban_account_name": null,
                        "sepa_bic": null,
                        "sepa_mandate_id": null,
                        "sepa_mandate_date": null,
                        "sepa_sequence_type": "RCUR",
                        "credit_card_number": null,
                        "credit_card_reference": null,
                        "credit_card_type": null,
                        "tax_number_validated_at": null,
                        "tax_number_valid": null,
                        "invoice_workflow_id": null,
                        "estimate_workflow_id": null,
                        "si_identifier": null,
                        "si_identifier_type": null,
                        "moneybird_payments_mandate": false,
                        "created_at": "2026-11-02T12:15:47.576Z",
                        "updated_at": "2026-11-02T12:15:47.576Z",
                        "version": 1793621747,
                        "sales_invoices_url": "https://moneybird.dev/123/sales_invoices/0000000000000000000000000000000000000000000000000000000000000001/all",
                        "notes": [],
                        "custom_fields": [],
                        "contact_people": [],
                        "archived": false
                      },
                      "contact_person_id": null,
                      "contact_person": null,
                      "invoice_id": null,
                      "recurring_sales_invoice_id": null,
                      "subscription_id": null,
                      "workflow_id": "502689109097055375",
                      "document_style_id": "502689109280556185",
                      "identity_id": "502689108656653419",
                      "draft_id": 1,
                      "state": "scheduled",
                      "invoice_date": "2026-11-03",
                      "due_date": "2026-11-17",
                      "payment_conditions": "We verzoeken u vriendelijk het bovenstaande bedrag van {document.total_price} voor {document.due_date} te voldoen op onze bankrekening onder vermelding van de omschrijving {document.payment_reference}. Voor vragen kunt u contact opnemen per e-mail.",
                      "payment_reference": null,
                      "short_payment_reference": null,
                      "reference": "Project X",
                      "language": "nl",
                      "currency": "EUR",
                      "discount": "0.0",
                      "original_sales_invoice_id": null,
                      "paused": false,
                      "paid_at": null,
                      "sent_at": null,
                      "created_at": "2026-11-02T12:15:47.603Z",
                      "updated_at": "2026-11-02T12:15:47.650Z",
                      "public_view_code": null,
                      "public_view_code_expires_at": null,
                      "version": 1793621747,
                      "details": [
                        {
                          "id": "502689144121591099",
                          "administration_id": 123,
                          "tax_rate_id": "502689108899923082",
                          "ledger_account_id": "502689108787725434",
                          "project_id": null,
                          "product_id": null,
                          "amount": "1 x",
                          "amount_decimal": "1.0",
                          "description": "Project X",
                          "price": "300.0",
                          "period": null,
                          "row_order": 1,
                          "total_price_excl_tax_with_discount": "300.0",
                          "total_price_excl_tax_with_discount_base": "300.0",
                          "tax_report_reference": [
                            "NL/1a"
                          ],
                          "mandatory_tax_text": null,
                          "created_at": "2026-11-02T12:15:47.605Z",
                          "updated_at": "2026-11-02T12:15:47.649Z"
                        }
                      ],
                      "payments": [],
                      "total_paid": "0.0",
                      "total_unpaid": "363.0",
                      "total_unpaid_base": "363.0",
                      "prices_are_incl_tax": false,
                      "total_price_excl_tax": "300.0",
                      "total_price_excl_tax_base": "300.0",
                      "total_price_incl_tax": "363.0",
                      "total_price_incl_tax_base": "363.0",
                      "total_discount": "0.0",
                      "marked_dubious_on": null,
                      "marked_uncollectible_on": null,
                      "reminder_count": 0,
                      "next_reminder": null,
                      "original_estimate_id": null,
                      "url": "http://moneybird.dev/123/external/0000000000000000000000000000000000000000000000000000000000000001/feeff1846a6dced7feea196dce7ecb31d984b174a809297f7ae9f2b0f20cc206/sales_invoice",
                      "payment_url": "http://moneybird.dev/123/external/0000000000000000000000000000000000000000000000000000000000000001/feeff1846a6dced7feea196dce7ecb31d984b174a809297f7ae9f2b0f20cc206/sales_invoice",
                      "custom_fields": [],
                      "notes": [],
                      "attachments": [],
                      "events": [
                        {
                          "administration_id": 123,
                          "user_id": "502689108256097381",
                          "action": "sales_invoice_created",
                          "link_entity_id": null,
                          "link_entity_type": null,
                          "data": {},
                          "created_at": "2026-11-02T12:15:47.608Z",
                          "updated_at": "2026-11-02T12:15:47.608Z"
                        },
                        {
                          "administration_id": 123,
                          "user_id": "502689108256097381",
                          "action": "sales_invoice_state_changed_to_scheduled",
                          "link_entity_id": null,
                          "link_entity_type": null,
                          "data": {},
                          "created_at": "2026-11-02T12:15:47.642Z",
                          "updated_at": "2026-11-02T12:15:47.642Z"
                        }
                      ],
                      "tax_totals": [
                        {
                          "tax_rate_id": "502689108899923082",
                          "taxable_amount": "300.0",
                          "taxable_amount_base": "300.0",
                          "tax_amount": "63.0",
                          "tax_amount_base": "63.0"
                        }
                      ],
                      "time_entries": []
                    }
                  },
                  "FallsBackToE-mailDeliveryWhenSendingSimplerinvoicingForTheSecondTime": {
                    "summary": "Falls back to e-mail delivery when sending simplerinvoicing for the second time",
                    "value": {
                      "id": "502689144413095247",
                      "administration_id": 123,
                      "contact_id": "502689144294606149",
                      "contact": {
                        "id": "502689144294606149",
                        "administration_id": 123,
                        "company_name": "Foobar Holding B.V.",
                        "firstname": null,
                        "lastname": null,
                        "address1": "Hoofdstraat 12",
                        "address2": null,
                        "zipcode": "1234AB",
                        "city": "Amsterdam",
                        "country": "NL",
                        "phone": null,
                        "delivery_method": "Simplerinvoicing",
                        "customer_id": "customer-1",
                        "tax_number": null,
                        "chamber_of_commerce": null,
                        "bank_account": null,
                        "is_trusted": false,
                        "max_transfer_amount": null,
                        "attention": null,
                        "email": "info@example.com",
                        "email_ubl": true,
                        "send_invoices_to_attention": null,
                        "send_invoices_to_email": "info@example.com",
                        "send_estimates_to_attention": null,
                        "send_estimates_to_email": "info@example.com",
                        "direct_debit": false,
                        "sepa_active": false,
                        "sepa_iban": null,
                        "sepa_iban_account_name": null,
                        "sepa_bic": null,
                        "sepa_mandate_id": null,
                        "sepa_mandate_date": null,
                        "sepa_sequence_type": "RCUR",
                        "credit_card_number": null,
                        "credit_card_reference": null,
                        "credit_card_type": null,
                        "tax_number_validated_at": null,
                        "tax_number_valid": null,
                        "invoice_workflow_id": null,
                        "estimate_workflow_id": null,
                        "si_identifier": "12345678",
                        "si_identifier_type": "NL:KVK",
                        "moneybird_payments_mandate": false,
                        "created_at": "2026-11-02T12:15:47.770Z",
                        "updated_at": "2026-11-02T12:15:47.860Z",
                        "version": 1793621747,
                        "sales_invoices_url": "https://moneybird.dev/123/sales_invoices/0000000000000000000000000000000000000000000000000000000000000001/all",
                        "notes": [],
                        "custom_fields": [],
                        "contact_people": [],
                        "archived": false
                      },
                      "contact_person_id": null,
                      "contact_person": null,
                      "invoice_id": "2026-0001",
                      "recurring_sales_invoice_id": null,
                      "subscription_id": null,
                      "workflow_id": "502689109097055375",
                      "document_style_id": "502689109280556185",
                      "identity_id": "502689108656653419",
                      "draft_id": null,
                      "state": "open",
                      "invoice_date": "2026-11-02",
                      "due_date": "2026-11-16",
                      "payment_conditions": "We verzoeken u vriendelijk het bovenstaande bedrag van {document.total_price} voor {document.due_date} te voldoen op onze bankrekening onder vermelding van de omschrijving {document.payment_reference}. Voor vragen kunt u contact opnemen per e-mail.",
                      "payment_reference": "RF080000000000000WWD742ZR",
                      "short_payment_reference": "RF08WWD742ZR",
                      "reference": "Project X",
                      "language": "nl",
                      "currency": "EUR",
                      "discount": "0.0",
                      "original_sales_invoice_id": null,
                      "paused": false,
                      "paid_at": null,
                      "sent_at": "2026-11-02",
                      "created_at": "2026-11-02T12:15:47.884Z",
                      "updated_at": "2026-11-02T12:15:48.020Z",
                      "public_view_code": "631742",
                      "public_view_code_expires_at": "2027-02-02T12:15:48.019Z",
                      "version": 1793621748,
                      "details": [
                        {
                          "id": "502689144415192400",
                          "administration_id": 123,
                          "tax_rate_id": "502689108899923082",
                          "ledger_account_id": "502689108787725434",
                          "project_id": null,
                          "product_id": null,
                          "amount": "1 x",
                          "amount_decimal": "1.0",
                          "description": "Project X",
                          "price": "300.0",
                          "period": null,
                          "row_order": 1,
                          "total_price_excl_tax_with_discount": "300.0",
                          "total_price_excl_tax_with_discount_base": "300.0",
                          "tax_report_reference": [
                            "NL/1a"
                          ],
                          "mandatory_tax_text": null,
                          "created_at": "2026-11-02T12:15:47.886Z",
                          "updated_at": "2026-11-02T12:15:47.968Z"
                        }
                      ],
                      "payments": [],
                      "total_paid": "0.0",
                      "total_unpaid": "363.0",
                      "total_unpaid_base": "363.0",
                      "prices_are_incl_tax": false,
                      "total_price_excl_tax": "300.0",
                      "total_price_excl_tax_base": "300.0",
                      "total_price_incl_tax": "363.0",
                      "total_price_incl_tax_base": "363.0",
                      "total_discount": "0.0",
                      "marked_dubious_on": null,
                      "marked_uncollectible_on": null,
                      "reminder_count": 0,
                      "next_reminder": "2026-11-16",
                      "original_estimate_id": null,
                      "url": "http://moneybird.dev/123/external/0000000000000000000000000000000000000000000000000000000000000001/41321384d3147fc20c7b27ed04c9bd887f0aedc620d086976ac10e028204b1f7/sales_invoice",
                      "payment_url": "http://moneybird.dev/123/external/0000000000000000000000000000000000000000000000000000000000000001/41321384d3147fc20c7b27ed04c9bd887f0aedc620d086976ac10e028204b1f7/sales_invoice",
                      "custom_fields": [],
                      "notes": [],
                      "attachments": [],
                      "events": [
                        {
                          "administration_id": 123,
                          "user_id": "502689108256097381",
                          "action": "sales_invoice_created",
                          "link_entity_id": null,
                          "link_entity_type": null,
                          "data": {},
                          "created_at": "2026-11-02T12:15:47.888Z",
                          "updated_at": "2026-11-02T12:15:47.888Z"
                        },
                        {
                          "administration_id": 123,
                          "user_id": "502689108256097381",
                          "action": "sales_invoice_state_changed_to_open",
                          "link_entity_id": null,
                          "link_entity_type": null,
                          "data": {},
                          "created_at": "2026-11-02T12:15:47.954Z",
                          "updated_at": "2026-11-02T12:15:47.954Z"
                        },
                        {
                          "administration_id": 123,
                          "user_id": "502689108256097381",
                          "action": "sales_invoice_send_si",
                          "link_entity_id": null,
                          "link_entity_type": null,
                          "data": {
                            "si_identifier": "NL:KVK:12345678"
                          },
                          "created_at": "2026-11-02T12:15:47.984Z",
                          "updated_at": "2026-11-02T12:15:47.984Z"
                        },
                        {
                          "administration_id": 123,
                          "user_id": "502689108256097381",
                          "action": "sales_invoice_send_email",
                          "link_entity_id": null,
                          "link_entity_type": null,
                          "data": {
                            "email_address": "info@example.com",
                            "email_message": "Geachte Foobar Holding B.V.,\n\nIn de bijlage kunt u factuur 2026-0001 voor onze diensten vinden. Wij verzoeken u vriendelijk de factuur voor 16-11-2026 te voldoen.\n\nMet vriendelijke groet,\n\nParkietje B.V."
                          },
                          "created_at": "2026-11-02T12:15:48.027Z",
                          "updated_at": "2026-11-02T12:15:48.027Z"
                        }
                      ],
                      "tax_totals": [
                        {
                          "tax_rate_id": "502689108899923082",
                          "taxable_amount": "300.0",
                          "taxable_amount_base": "300.0",
                          "tax_amount": "63.0",
                          "tax_amount_base": "63.0"
                        }
                      ],
                      "time_entries": []
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "Bad request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/symbolic_error"
                },
                "examples": {
                  "ReturnsErrorWhenSendingInvalidInvoiceWithoutDetails": {
                    "summary": "Returns error when sending invalid invoice without details",
                    "value": {
                      "error": "details cannot be empty",
                      "symbolic": {
                        "sales_invoice": "details_cannot_be_empty"
                      }
                    }
                  }
                }
              }
            }
          },
          "404": {
            "$ref": "#/components/responses/404_not_found"
          },
          "422": {
            "description": "Unprocessable entity",
            "content": {
              "application/json": {
                "schema": {
                  "anyOf": [
                    {
                      "$ref": "#/components/schemas/symbolic_error"
                    },
                    {
                      "$ref": "#/components/schemas/non_symbolic_error"
                    }
                  ]
                },
                "examples": {
                  "ReturnsErrorWhenSendingInvoiceToContactWithoutEmailAddress": {
                    "summary": "Returns error when sending invoice to contact without email address",
                    "value": {
                      "error": {
                        "email_address": [
                          "can't be blank"
                        ]
                      },
                      "details": {
                        "email_address": [
                          {
                            "error": "blank"
                          }
                        ]
                      }
                    }
                  },
                  "ReturnsErrorWhenSendingInvoiceFromIdentityWithoutEmail": {
                    "summary": "Returns error when sending invoice from identity without email",
                    "value": {
                      "error": {
                        "delivery_method": [
                          "The sender address must contain an email address"
                        ]
                      },
                      "details": {
                        "delivery_method": [
                          {
                            "error": "need_identity_email"
                          }
                        ]
                      }
                    }
                  }
                }
              }
            }
          }
        },
        "operationId": "patch_administration_id_sales_invoices_id_send_invoice"
      }
    },
    "/{administration_id}/sales_invoices/{id}{format}": {
      "get": {
        "summary": "Get an invoice by id",
        "description": "Returns a sales invoices in the administration.\n\nNote that the link in the `url` attribute will only work if viewing invoices online has been enabled and the invoice is not a draft.\n\n### Required scope(s)\n `sales_invoices`",
        "tags": [
          "Sales invoices"
        ],
        "security": [
          {
            "bearerAuth": [
              "sales_invoices"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/administration_id"
          },
          {
            "name": "id",
            "in": "path",
            "required": true,
            "schema": {
              "$ref": "#/components/schemas/identifier"
            }
          },
          {
            "$ref": "#/components/parameters/format"
          }
        ],
        "responses": {
          "200": {
            "description": "A sales invoice",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/sales_invoice_response"
                },
                "examples": {
                  "ReturnsInvoiceByGivenId": {
                    "summary": "Returns invoice by given id",
                    "value": {
                      "id": "502689172090259288",
                      "administration_id": 123,
                      "contact_id": "502689172049364819",
                      "contact": {
                        "id": "502689172049364819",
                        "administration_id": 123,
                        "company_name": "Foobar Holding B.V.",
                        "firstname": null,
                        "lastname": null,
                        "address1": "Hoofdstraat 12",
                        "address2": null,
                        "zipcode": "1234AB",
                        "city": "Amsterdam",
                        "country": "NL",
                        "phone": null,
                        "delivery_method": "Email",
                        "customer_id": "customer-1",
                        "tax_number": null,
                        "chamber_of_commerce": null,
                        "bank_account": null,
                        "is_trusted": false,
                        "max_transfer_amount": null,
                        "attention": null,
                        "email": "info@example.com",
                        "email_ubl": true,
                        "send_invoices_to_attention": null,
                        "send_invoices_to_email": "info@example.com",
                        "send_estimates_to_attention": null,
                        "send_estimates_to_email": "info@example.com",
                        "direct_debit": false,
                        "sepa_active": false,
                        "sepa_iban": null,
                        "sepa_iban_account_name": null,
                        "sepa_bic": null,
                        "sepa_mandate_id": null,
                        "sepa_mandate_date": null,
                        "sepa_sequence_type": "RCUR",
                        "credit_card_number": null,
                        "credit_card_reference": null,
                        "credit_card_type": null,
                        "tax_number_validated_at": null,
                        "tax_number_valid": null,
                        "invoice_workflow_id": null,
                        "estimate_workflow_id": null,
                        "si_identifier": null,
                        "si_identifier_type": null,
                        "moneybird_payments_mandate": false,
                        "created_at": "2026-11-02T12:16:14.239Z",
                        "updated_at": "2026-11-02T12:16:14.239Z",
                        "version": 1793621774,
                        "sales_invoices_url": "https://moneybird.dev/123/sales_invoices/0000000000000000000000000000000000000000000000000000000000000001/all",
                        "notes": [],
                        "custom_fields": [],
                        "contact_people": [],
                        "archived": false
                      },
                      "contact_person_id": "502689172054607701",
                      "contact_person": {
                        "id": null,
                        "contact_id": "502689172049364819",
                        "administration_id": 123,
                        "firstname": "Jan",
                        "lastname": "Janssen",
                        "phone": "123-456-2346",
                        "email": "janjanssen@dev.null.moneybird.net",
                        "department": "Sales",
                        "created_at": "2026-11-02T12:16:14.244Z",
                        "updated_at": "2026-11-02T12:16:14.244Z",
                        "version": 1793621774
                      },
                      "invoice_id": "2026-0001",
                      "recurring_sales_invoice_id": null,
                      "subscription_id": null,
                      "workflow_id": "502689109097055375",
                      "document_style_id": "502689109280556185",
                      "identity_id": "502689108656653419",
                      "draft_id": null,
                      "state": "open",
                      "invoice_date": "2026-11-02",
                      "due_date": "2026-11-16",
                      "payment_conditions": "We verzoeken u vriendelijk het bovenstaande bedrag van {document.total_price} voor {document.due_date} te voldoen op onze bankrekening onder vermelding van de omschrijving {document.payment_reference}. Voor vragen kunt u contact opnemen per e-mail.",
                      "payment_reference": "RF120000000000000TMDVYERR",
                      "short_payment_reference": "RF12TMDVYERR",
                      "reference": "Project X",
                      "language": "nl",
                      "currency": "EUR",
                      "discount": "0.0",
                      "original_sales_invoice_id": null,
                      "paused": false,
                      "paid_at": null,
                      "sent_at": "2026-11-02",
                      "created_at": "2026-11-02T12:16:14.277Z",
                      "updated_at": "2026-11-02T12:16:14.353Z",
                      "public_view_code": "552484",
                      "public_view_code_expires_at": "2027-02-02T12:16:14.322Z",
                      "version": 1793621774,
                      "details": [
                        {
                          "id": "502689172092356441",
                          "administration_id": 123,
                          "tax_rate_id": "502689108899923082",
                          "ledger_account_id": "502689108787725434",
                          "project_id": null,
                          "product_id": null,
                          "amount": "1 x",
                          "amount_decimal": "1.0",
                          "description": "Project X",
                          "price": "300.0",
                          "period": "20261101..20261130",
                          "row_order": 1,
                          "total_price_excl_tax_with_discount": "300.0",
                          "total_price_excl_tax_with_discount_base": "300.0",
                          "tax_report_reference": [
                            "NL/1a"
                          ],
                          "mandatory_tax_text": null,
                          "created_at": "2026-11-02T12:16:14.281Z",
                          "updated_at": "2026-11-02T12:16:14.352Z"
                        }
                      ],
                      "payments": [],
                      "total_paid": "0.0",
                      "total_unpaid": "363.0",
                      "total_unpaid_base": "363.0",
                      "prices_are_incl_tax": false,
                      "total_price_excl_tax": "300.0",
                      "total_price_excl_tax_base": "300.0",
                      "total_price_incl_tax": "363.0",
                      "total_price_incl_tax_base": "363.0",
                      "total_discount": "0.0",
                      "marked_dubious_on": null,
                      "marked_uncollectible_on": null,
                      "reminder_count": 0,
                      "next_reminder": "2026-11-16",
                      "original_estimate_id": null,
                      "url": "http://moneybird.dev/123/external/0000000000000000000000000000000000000000000000000000000000000001/a6a4e80b49382715203f439a066b9eb53c12509929f3ddfdc0e2d0fa2e69a756/sales_invoice",
                      "payment_url": "http://moneybird.dev/123/external/0000000000000000000000000000000000000000000000000000000000000001/a6a4e80b49382715203f439a066b9eb53c12509929f3ddfdc0e2d0fa2e69a756/sales_invoice",
                      "custom_fields": [],
                      "notes": [],
                      "attachments": [],
                      "events": [
                        {
                          "administration_id": 123,
                          "user_id": "502689108256097381",
                          "action": "sales_invoice_created",
                          "link_entity_id": null,
                          "link_entity_type": null,
                          "data": {},
                          "created_at": "2026-11-02T12:16:14.284Z",
                          "updated_at": "2026-11-02T12:16:14.284Z"
                        },
                        {
                          "administration_id": 123,
                          "user_id": "502689108256097381",
                          "action": "sales_invoice_state_changed_to_open",
                          "link_entity_id": null,
                          "link_entity_type": null,
                          "data": {},
                          "created_at": "2026-11-02T12:16:14.331Z",
                          "updated_at": "2026-11-02T12:16:14.331Z"
                        },
                        {
                          "administration_id": 123,
                          "user_id": "502689108256097381",
                          "action": "sales_invoice_send_email",
                          "link_entity_id": null,
                          "link_entity_type": null,
                          "data": {
                            "email_address": "info@example.com; janjanssen@dev.null.moneybird.net",
                            "email_message": "Geachte Jan Janssen,\n\nIn de bijlage kunt u factuur 2026-0001 voor onze diensten vinden. Wij verzoeken u vriendelijk de factuur voor 16-11-2026 te voldoen.\n\nMet vriendelijke groet,\n\nParkietje B.V."
                          },
                          "created_at": "2026-11-02T12:16:14.368Z",
                          "updated_at": "2026-11-02T12:16:14.368Z"
                        }
                      ],
                      "tax_totals": [
                        {
                          "tax_rate_id": "502689108899923082",
                          "taxable_amount": "300.0",
                          "taxable_amount_base": "300.0",
                          "tax_amount": "63.0",
                          "tax_amount_base": "63.0"
                        }
                      ],
                      "time_entries": []
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Not found",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/symbolic_error"
                },
                "examples": {
                  "Returns404WhenInvoiceDoesNotExist": {
                    "summary": "Returns 404 when invoice does not exist",
                    "value": {
                      "error": "record not found",
                      "symbolic": {
                        "id": "not_found"
                      }
                    }
                  }
                }
              }
            }
          }
        },
        "operationId": "get_administration_id_sales_invoices_id"
      },
      "patch": {
        "summary": "Update a sales invoice",
        "description": "When updating a sales invoice, provide only the attributes you want to update. The other attributes will not be changed.\n\n### Required scope(s)\n `sales_invoices`",
        "tags": [
          "Sales invoices"
        ],
        "security": [
          {
            "bearerAuth": [
              "sales_invoices"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/administration_id"
          },
          {
            "name": "id",
            "in": "path",
            "required": true,
            "schema": {
              "$ref": "#/components/schemas/identifier"
            }
          },
          {
            "$ref": "#/components/parameters/format"
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/*": {
              "schema": {
                "unevaluatedProperties": false,
                "type": "object",
                "properties": {
                  "sales_invoice": {
                    "type": "object",
                    "unevaluatedProperties": false,
                    "properties": {
                      "contact_id": {
                        "$ref": "#/components/schemas/identifier",
                        "description": "The ID of the contact associated with the sales invoice. This is mandatory when setting the contact_person_id. Should be a valid contact id."
                      },
                      "contact_person_id": {
                        "$ref": "#/components/schemas/identifier",
                        "description": "The ID of the contact person associated with the sales invoice. Should be a valid contact person id."
                      },
                      "update_contact": {
                        "type": [
                          "boolean",
                          "string"
                        ],
                        "description": "When `true`, the contact's address and other details are updated on the invoice from the current contact record."
                      },
                      "original_estimate_id": {
                        "$ref": "#/components/schemas/identifier",
                        "description": "The ID of the estimate this invoice was created from. Used to link an invoice to its originating estimate."
                      },
                      "document_style_id": {
                        "$ref": "#/components/schemas/identifier",
                        "description": "Default document style is used if value is not provided. Should be a valid document style id."
                      },
                      "workflow_id": {
                        "$ref": "#/components/schemas/identifier",
                        "description": "If value is not provided, the workflow saved in the contact is used. If the contact doesn't have a default workflow, the administration's default workflow is used. Should be a valid workflow id."
                      },
                      "reference": {
                        "type": "string",
                        "description": "Your own reference for this invoice, e.g. a project code or PO number. Visible to the recipient."
                      },
                      "invoice_sequence_id": {
                        "type": [
                          "string",
                          "integer"
                        ],
                        "description": "The sequence number that is put in the invoice number template, e.g. `0042`."
                      },
                      "remove_invoice_sequence_id": {
                        "type": [
                          "boolean",
                          "string"
                        ],
                        "description": "Set to `true` to remove the sequence number of an invoice that is not sent yet. The next number in the sequence is then used when the invoice is sent."
                      },
                      "invoice_date": {
                        "type": "string",
                        "description": "The date of the invoice.",
                        "format": "date"
                      },
                      "first_due_interval": {
                        "type": "integer",
                        "description": "The number of days after the invoice date before the invoice is due."
                      },
                      "currency": {
                        "type": "string",
                        "description": "ISO three-character currency code, e.g. EUR or USD."
                      },
                      "prices_are_incl_tax": {
                        "type": [
                          "boolean",
                          "string"
                        ],
                        "description": "Whether the prices on the invoice are inclusive of tax."
                      },
                      "payment_conditions": {
                        "type": "string",
                        "description": "Free-text payment conditions printed on the invoice, e.g. \"Payment within 30 days\"."
                      },
                      "discount": {
                        "$ref": "#/components/schemas/number",
                        "description": "Discount percentage applied to the entire invoice, e.g. `10.0` for 10%."
                      },
                      "time_entry_ids": {
                        "type": "array",
                        "description": "An array of time entry IDs to associate with this invoice. Linked time entries will be marked as invoiced.",
                        "items": {
                          "$ref": "#/components/schemas/identifier"
                        }
                      },
                      "details_attributes": {
                        "$ref": "#/components/schemas/details_attributes"
                      },
                      "custom_fields_attributes": {
                        "$ref": "#/components/schemas/custom_fields_attributes"
                      }
                    },
                    "required": []
                  }
                },
                "required": []
              },
              "examples": {
                "UpdatingTheSalesInvoiceReference": {
                  "summary": "Updating the sales invoice reference",
                  "value": {
                    "sales_invoice": {
                      "reference": "30053"
                    }
                  }
                },
                "AddingAndRemovingASalesInvoiceDetail": {
                  "summary": "Adding and removing a sales invoice detail",
                  "value": {
                    "sales_invoice": {
                      "details_attributes": [
                        {
                          "description": "Sofa",
                          "price": 199.99
                        },
                        {
                          "id": 502689170341234300,
                          "_destroy": true
                        }
                      ]
                    }
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Sales invoice updated",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/sales_invoice_response"
                },
                "examples": {
                  "UpdatingTheSalesInvoiceReference": {
                    "summary": "Updating the sales invoice reference",
                    "value": {
                      "id": "502689170106353228",
                      "administration_id": 123,
                      "contact_id": "502689170080138826",
                      "contact": {
                        "id": "502689170080138826",
                        "administration_id": 123,
                        "company_name": "Foobar Holding B.V.",
                        "firstname": null,
                        "lastname": null,
                        "address1": "Hoofdstraat 12",
                        "address2": null,
                        "zipcode": "1234AB",
                        "city": "Amsterdam",
                        "country": "NL",
                        "phone": null,
                        "delivery_method": "Email",
                        "customer_id": "customer-1",
                        "tax_number": null,
                        "chamber_of_commerce": null,
                        "bank_account": null,
                        "is_trusted": false,
                        "max_transfer_amount": null,
                        "attention": null,
                        "email": "info@example.com",
                        "email_ubl": true,
                        "send_invoices_to_attention": null,
                        "send_invoices_to_email": "info@example.com",
                        "send_estimates_to_attention": null,
                        "send_estimates_to_email": "info@example.com",
                        "direct_debit": false,
                        "sepa_active": false,
                        "sepa_iban": null,
                        "sepa_iban_account_name": null,
                        "sepa_bic": null,
                        "sepa_mandate_id": null,
                        "sepa_mandate_date": null,
                        "sepa_sequence_type": "RCUR",
                        "credit_card_number": null,
                        "credit_card_reference": null,
                        "credit_card_type": null,
                        "tax_number_validated_at": null,
                        "tax_number_valid": null,
                        "invoice_workflow_id": null,
                        "estimate_workflow_id": null,
                        "si_identifier": null,
                        "si_identifier_type": null,
                        "moneybird_payments_mandate": false,
                        "created_at": "2026-11-02T12:16:12.361Z",
                        "updated_at": "2026-11-02T12:16:12.361Z",
                        "version": 1793621772,
                        "sales_invoices_url": "https://moneybird.dev/123/sales_invoices/0000000000000000000000000000000000000000000000000000000000000001/all",
                        "notes": [],
                        "custom_fields": [],
                        "contact_people": [],
                        "archived": false
                      },
                      "contact_person_id": null,
                      "contact_person": null,
                      "invoice_id": "2026-0001",
                      "recurring_sales_invoice_id": null,
                      "subscription_id": null,
                      "workflow_id": "502689109097055375",
                      "document_style_id": "502689109280556185",
                      "identity_id": "502689108656653419",
                      "draft_id": null,
                      "state": "open",
                      "invoice_date": "2026-11-02",
                      "due_date": "2026-11-16",
                      "payment_conditions": "We verzoeken u vriendelijk het bovenstaande bedrag van {document.total_price} voor {document.due_date} te voldoen op onze bankrekening onder vermelding van de omschrijving {document.payment_reference}. Voor vragen kunt u contact opnemen per e-mail.",
                      "payment_reference": "RF340000000000000RP6KCUZ9",
                      "short_payment_reference": "RF34RP6KCUZ9",
                      "reference": "30053",
                      "language": "nl",
                      "currency": "EUR",
                      "discount": "0.0",
                      "original_sales_invoice_id": null,
                      "paused": false,
                      "paid_at": null,
                      "sent_at": "2026-11-02",
                      "created_at": "2026-11-02T12:16:12.387Z",
                      "updated_at": "2026-11-02T12:16:12.525Z",
                      "public_view_code": "501378",
                      "public_view_code_expires_at": "2027-02-02T12:16:12.428Z",
                      "version": 1793621772,
                      "details": [
                        {
                          "id": "502689170108450381",
                          "administration_id": 123,
                          "tax_rate_id": "502689108899923082",
                          "ledger_account_id": "502689108787725434",
                          "project_id": null,
                          "product_id": null,
                          "amount": "1 x",
                          "amount_decimal": "1.0",
                          "description": "Project X",
                          "price": "300.0",
                          "period": null,
                          "row_order": 1,
                          "total_price_excl_tax_with_discount": "300.0",
                          "total_price_excl_tax_with_discount_base": "300.0",
                          "tax_report_reference": [
                            "NL/1a"
                          ],
                          "mandatory_tax_text": null,
                          "created_at": "2026-11-02T12:16:12.389Z",
                          "updated_at": "2026-11-02T12:16:12.455Z"
                        }
                      ],
                      "payments": [],
                      "total_paid": "0.0",
                      "total_unpaid": "363.0",
                      "total_unpaid_base": "363.0",
                      "prices_are_incl_tax": false,
                      "total_price_excl_tax": "300.0",
                      "total_price_excl_tax_base": "300.0",
                      "total_price_incl_tax": "363.0",
                      "total_price_incl_tax_base": "363.0",
                      "total_discount": "0.0",
                      "marked_dubious_on": null,
                      "marked_uncollectible_on": null,
                      "reminder_count": 0,
                      "next_reminder": "2026-11-16",
                      "original_estimate_id": null,
                      "url": "http://moneybird.dev/123/external/0000000000000000000000000000000000000000000000000000000000000001/d2d6c286f73eef634c3b52c0ec1ceb844d3cdf73ef6ea31bcf1b54d3bfb6dc13/sales_invoice",
                      "payment_url": "http://moneybird.dev/123/external/0000000000000000000000000000000000000000000000000000000000000001/d2d6c286f73eef634c3b52c0ec1ceb844d3cdf73ef6ea31bcf1b54d3bfb6dc13/sales_invoice",
                      "custom_fields": [],
                      "notes": [],
                      "attachments": [],
                      "events": [
                        {
                          "administration_id": 123,
                          "user_id": "502689108256097381",
                          "action": "sales_invoice_created",
                          "link_entity_id": null,
                          "link_entity_type": null,
                          "data": {},
                          "created_at": "2026-11-02T12:16:12.391Z",
                          "updated_at": "2026-11-02T12:16:12.391Z"
                        },
                        {
                          "administration_id": 123,
                          "user_id": "502689108256097381",
                          "action": "sales_invoice_state_changed_to_open",
                          "link_entity_id": null,
                          "link_entity_type": null,
                          "data": {},
                          "created_at": "2026-11-02T12:16:12.438Z",
                          "updated_at": "2026-11-02T12:16:12.438Z"
                        },
                        {
                          "administration_id": 123,
                          "user_id": "502689108256097381",
                          "action": "sales_invoice_send_email",
                          "link_entity_id": null,
                          "link_entity_type": null,
                          "data": {
                            "email_address": "info@example.com",
                            "email_message": "Geachte Foobar Holding B.V.,\n\nIn de bijlage kunt u factuur 2026-0001 voor onze diensten vinden. Wij verzoeken u vriendelijk de factuur voor 16-11-2026 te voldoen.\n\nMet vriendelijke groet,\n\nParkietje B.V."
                          },
                          "created_at": "2026-11-02T12:16:12.470Z",
                          "updated_at": "2026-11-02T12:16:12.470Z"
                        },
                        {
                          "administration_id": 123,
                          "user_id": "502689108256097381",
                          "action": "sales_invoice_updated",
                          "link_entity_id": null,
                          "link_entity_type": null,
                          "data": {
                            "changes": {
                              "reference": [
                                "30052",
                                "30053"
                              ],
                              "updated_at": [
                                "2026-11-02T13:16:12.456+01:00",
                                "2026-11-02T13:16:12.525+01:00"
                              ]
                            }
                          },
                          "created_at": "2026-11-02T12:16:12.528Z",
                          "updated_at": "2026-11-02T12:16:12.528Z"
                        }
                      ],
                      "tax_totals": [
                        {
                          "tax_rate_id": "502689108899923082",
                          "taxable_amount": "300.0",
                          "taxable_amount_base": "300.0",
                          "tax_amount": "63.0",
                          "tax_amount_base": "63.0"
                        }
                      ],
                      "time_entries": []
                    }
                  },
                  "AddingAndRemovingASalesInvoiceDetail": {
                    "summary": "Adding and removing a sales invoice detail",
                    "value": {
                      "id": "502689170338088562",
                      "administration_id": 123,
                      "contact_id": "502689170307679856",
                      "contact": {
                        "id": "502689170307679856",
                        "administration_id": 123,
                        "company_name": "Foobar Holding B.V.",
                        "firstname": null,
                        "lastname": null,
                        "address1": "Hoofdstraat 12",
                        "address2": null,
                        "zipcode": "1234AB",
                        "city": "Amsterdam",
                        "country": "NL",
                        "phone": null,
                        "delivery_method": "Email",
                        "customer_id": "customer-1",
                        "tax_number": null,
                        "chamber_of_commerce": null,
                        "bank_account": null,
                        "is_trusted": false,
                        "max_transfer_amount": null,
                        "attention": null,
                        "email": "info@example.com",
                        "email_ubl": true,
                        "send_invoices_to_attention": null,
                        "send_invoices_to_email": "info@example.com",
                        "send_estimates_to_attention": null,
                        "send_estimates_to_email": "info@example.com",
                        "direct_debit": false,
                        "sepa_active": false,
                        "sepa_iban": null,
                        "sepa_iban_account_name": null,
                        "sepa_bic": null,
                        "sepa_mandate_id": null,
                        "sepa_mandate_date": null,
                        "sepa_sequence_type": "RCUR",
                        "credit_card_number": null,
                        "credit_card_reference": null,
                        "credit_card_type": null,
                        "tax_number_validated_at": null,
                        "tax_number_valid": null,
                        "invoice_workflow_id": null,
                        "estimate_workflow_id": null,
                        "si_identifier": null,
                        "si_identifier_type": null,
                        "moneybird_payments_mandate": false,
                        "created_at": "2026-11-02T12:16:12.578Z",
                        "updated_at": "2026-11-02T12:16:12.578Z",
                        "version": 1793621772,
                        "sales_invoices_url": "https://moneybird.dev/123/sales_invoices/0000000000000000000000000000000000000000000000000000000000000001/all",
                        "notes": [],
                        "custom_fields": [],
                        "contact_people": [],
                        "archived": false
                      },
                      "contact_person_id": null,
                      "contact_person": null,
                      "invoice_id": "2026-0001",
                      "recurring_sales_invoice_id": null,
                      "subscription_id": null,
                      "workflow_id": "502689109097055375",
                      "document_style_id": "502689109280556185",
                      "identity_id": "502689108656653419",
                      "draft_id": null,
                      "state": "open",
                      "invoice_date": "2026-11-02",
                      "due_date": "2026-11-16",
                      "payment_conditions": "We verzoeken u vriendelijk het bovenstaande bedrag van {document.total_price} voor {document.due_date} te voldoen op onze bankrekening onder vermelding van de omschrijving {document.payment_reference}. Voor vragen kunt u contact opnemen per e-mail.",
                      "payment_reference": "RF900000000000000AZT9S7XS",
                      "short_payment_reference": "RF90AZT9S7XS",
                      "reference": "30052",
                      "language": "nl",
                      "currency": "EUR",
                      "discount": "0.0",
                      "original_sales_invoice_id": null,
                      "paused": false,
                      "paid_at": null,
                      "sent_at": "2026-11-02",
                      "created_at": "2026-11-02T12:16:12.607Z",
                      "updated_at": "2026-11-02T12:16:12.752Z",
                      "public_view_code": "749499",
                      "public_view_code_expires_at": "2027-02-02T12:16:12.646Z",
                      "version": 1793621772,
                      "details": [
                        {
                          "id": "502689170488034946",
                          "administration_id": 123,
                          "tax_rate_id": "502689108899923082",
                          "ledger_account_id": "502689108787725434",
                          "project_id": null,
                          "product_id": null,
                          "amount": null,
                          "amount_decimal": "1.0",
                          "description": "Sofa",
                          "price": "199.99",
                          "period": null,
                          "row_order": 0,
                          "total_price_excl_tax_with_discount": "199.99",
                          "total_price_excl_tax_with_discount_base": "199.99",
                          "tax_report_reference": [
                            "NL/1a"
                          ],
                          "mandatory_tax_text": null,
                          "created_at": "2026-11-02T12:16:12.751Z",
                          "updated_at": "2026-11-02T12:16:12.751Z"
                        }
                      ],
                      "payments": [],
                      "total_paid": "0.0",
                      "total_unpaid": "241.99",
                      "total_unpaid_base": "241.99",
                      "prices_are_incl_tax": false,
                      "total_price_excl_tax": "199.99",
                      "total_price_excl_tax_base": "199.99",
                      "total_price_incl_tax": "241.99",
                      "total_price_incl_tax_base": "241.99",
                      "total_discount": "0.0",
                      "marked_dubious_on": null,
                      "marked_uncollectible_on": null,
                      "reminder_count": 0,
                      "next_reminder": "2026-11-16",
                      "original_estimate_id": null,
                      "url": "http://moneybird.dev/123/external/0000000000000000000000000000000000000000000000000000000000000001/cab70d55759ffbc2f8a5e9ce7d8480900db4f28df6e76c6cd4255f3cc8ab521b/sales_invoice",
                      "payment_url": "http://moneybird.dev/123/external/0000000000000000000000000000000000000000000000000000000000000001/cab70d55759ffbc2f8a5e9ce7d8480900db4f28df6e76c6cd4255f3cc8ab521b/sales_invoice",
                      "custom_fields": [],
                      "notes": [],
                      "attachments": [],
                      "events": [
                        {
                          "administration_id": 123,
                          "user_id": "502689108256097381",
                          "action": "sales_invoice_created",
                          "link_entity_id": null,
                          "link_entity_type": null,
                          "data": {},
                          "created_at": "2026-11-02T12:16:12.614Z",
                          "updated_at": "2026-11-02T12:16:12.614Z"
                        },
                        {
                          "administration_id": 123,
                          "user_id": "502689108256097381",
                          "action": "sales_invoice_state_changed_to_open",
                          "link_entity_id": null,
                          "link_entity_type": null,
                          "data": {},
                          "created_at": "2026-11-02T12:16:12.653Z",
                          "updated_at": "2026-11-02T12:16:12.653Z"
                        },
                        {
                          "administration_id": 123,
                          "user_id": "502689108256097381",
                          "action": "sales_invoice_send_email",
                          "link_entity_id": null,
                          "link_entity_type": null,
                          "data": {
                            "email_address": "info@example.com",
                            "email_message": "Geachte Foobar Holding B.V.,\n\nIn de bijlage kunt u factuur 2026-0001 voor onze diensten vinden. Wij verzoeken u vriendelijk de factuur voor 16-11-2026 te voldoen.\n\nMet vriendelijke groet,\n\nParkietje B.V."
                          },
                          "created_at": "2026-11-02T12:16:12.681Z",
                          "updated_at": "2026-11-02T12:16:12.681Z"
                        },
                        {
                          "administration_id": 123,
                          "user_id": "502689108256097381",
                          "action": "sales_invoice_updated",
                          "link_entity_id": null,
                          "link_entity_type": null,
                          "data": {
                            "changes": {
                              "total_price_excl_tax": [
                                "300.0",
                                "199.99"
                              ],
                              "total_price_excl_tax_base": [
                                "300.0",
                                "199.99"
                              ],
                              "total_price_incl_tax": [
                                "363.0",
                                "241.99"
                              ],
                              "total_price_incl_tax_base": [
                                "363.0",
                                "241.99"
                              ],
                              "cached_taxes": [
                                [
                                  {
                                    "debit": 0,
                                    "credit": "63.0",
                                    "payable": true,
                                    "tax_rate_id": "502689108899923082",
                                    "report_reference": "NL/1a"
                                  }
                                ],
                                [
                                  {
                                    "tax_rate_id": "502689108899923082",
                                    "report_reference": "NL/1a",
                                    "payable": true,
                                    "debit": 0,
                                    "credit": "42.0"
                                  }
                                ]
                              ],
                              "updated_at": [
                                "2026-11-02T13:16:12.668+01:00",
                                "2026-11-02T13:16:12.745+01:00"
                              ]
                            }
                          },
                          "created_at": "2026-11-02T12:16:12.753Z",
                          "updated_at": "2026-11-02T12:16:12.753Z"
                        }
                      ],
                      "tax_totals": [
                        {
                          "tax_rate_id": "502689108899923082",
                          "taxable_amount": "199.99",
                          "taxable_amount_base": "199.99",
                          "tax_amount": "42.0",
                          "tax_amount_base": "42.0"
                        }
                      ],
                      "time_entries": []
                    }
                  }
                }
              }
            }
          },
          "400": {
            "$ref": "#/components/responses/400_bad_request"
          },
          "404": {
            "$ref": "#/components/responses/404_not_found"
          },
          "422": {
            "$ref": "#/components/responses/422_unprocessable_entity"
          }
        },
        "operationId": "patch_administration_id_sales_invoices_id"
      },
      "delete": {
        "summary": "Delete a sales invoice",
        "description": "Delete a sales invoice. Requires that the sales invoice has no pending payments and is not in a locked bookkeeping period.\n\n### Required scope(s)\n `sales_invoices`",
        "tags": [
          "Sales invoices"
        ],
        "security": [
          {
            "bearerAuth": [
              "sales_invoices"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/administration_id"
          },
          {
            "name": "id",
            "in": "path",
            "required": true,
            "schema": {
              "$ref": "#/components/schemas/identifier"
            }
          },
          {
            "$ref": "#/components/parameters/format"
          }
        ],
        "responses": {
          "204": {
            "description": "Sales invoice deleted"
          },
          "404": {
            "$ref": "#/components/responses/404_not_found"
          },
          "422": {
            "$ref": "#/components/responses/422_unprocessable_entity"
          }
        },
        "operationId": "delete_administration_id_sales_invoices_id"
      }
    },
    "/{administration_id}/sales_invoices/{sales_invoice_id}/attachments/{id}/download{format}": {
      "get": {
        "summary": "Download attachment",
        "description": "Download the attachment. The response will be a redirect to a temporarily available URL\nwhere the attachment can be downloaded. Use the `Location` header in the response\nto download the attachment.\n\n### Required scope(s)\n `sales_invoices`",
        "tags": [
          "Sales invoices"
        ],
        "security": [
          {
            "bearerAuth": [
              "sales_invoices"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/administration_id"
          },
          {
            "name": "sales_invoice_id",
            "in": "path",
            "required": true,
            "schema": {
              "$ref": "#/components/schemas/identifier"
            }
          },
          {
            "name": "id",
            "in": "path",
            "required": true,
            "schema": {
              "$ref": "#/components/schemas/identifier"
            }
          },
          {
            "$ref": "#/components/parameters/format"
          }
        ],
        "responses": {
          "302": {
            "description": "Found",
            "content": {
              "text/plain": {
                "schema": {
                  "type": "string"
                },
                "examples": {
                  "DownloadsTheAttachment": {
                    "summary": "Downloads the attachment",
                    "value": "{\"message\":\"Use the Location header to download the attachment\"}"
                  }
                }
              }
            }
          },
          "404": {
            "$ref": "#/components/responses/404_not_found"
          }
        },
        "operationId": "get_administration_id_sales_invoices_sales_invoice_id_attachments_id_download"
      }
    },
    "/{administration_id}/sales_invoices/{sales_invoice_id}/attachments/{id}{format}": {
      "delete": {
        "summary": "Delete an attachment",
        "description": "Deletes an attachment of an attachable.\n\n### Required scope(s)\n `sales_invoices`",
        "tags": [
          "Sales invoices"
        ],
        "security": [
          {
            "bearerAuth": [
              "sales_invoices"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/administration_id"
          },
          {
            "name": "sales_invoice_id",
            "in": "path",
            "required": true,
            "schema": {
              "$ref": "#/components/schemas/identifier"
            }
          },
          {
            "name": "id",
            "in": "path",
            "required": true,
            "schema": {
              "$ref": "#/components/schemas/identifier"
            }
          },
          {
            "$ref": "#/components/parameters/format"
          }
        ],
        "responses": {
          "204": {
            "description": "Attachment deleted"
          },
          "404": {
            "$ref": "#/components/responses/404_not_found"
          }
        },
        "operationId": "delete_administration_id_sales_invoices_sales_invoice_id_attachments_id"
      }
    },
    "/{administration_id}/sales_invoices/{sales_invoice_id}/notes/{id}{format}": {
      "delete": {
        "summary": "Destroys note from entity",
        "description": "Deletes a note from the sales invoice.\n\n### Required scope(s)\n `sales_invoices`",
        "tags": [
          "Sales invoices"
        ],
        "security": [
          {
            "bearerAuth": [
              "sales_invoices"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/administration_id"
          },
          {
            "name": "sales_invoice_id",
            "in": "path",
            "required": true,
            "schema": {
              "$ref": "#/components/schemas/identifier"
            }
          },
          {
            "name": "id",
            "in": "path",
            "required": true,
            "schema": {
              "$ref": "#/components/schemas/identifier"
            }
          },
          {
            "$ref": "#/components/parameters/format"
          }
        ],
        "responses": {
          "204": {
            "description": "Note deleted"
          },
          "400": {
            "description": "Bad request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/symbolic_error"
                },
                "examples": {
                  "ReturnsA400StatusWhenUserHasNoPermissionsToNotes": {
                    "summary": "Returns a 400 status when user has no permissions to notes",
                    "value": {
                      "error": "User has no permissions to notes for SalesInvoice",
                      "symbolic": {
                        "user": "insufficient_permissions"
                      }
                    }
                  }
                }
              }
            }
          }
        },
        "operationId": "delete_administration_id_sales_invoices_sales_invoice_id_notes_id"
      }
    },
    "/{administration_id}/sales_invoices/{sales_invoice_id}/notes{format}": {
      "post": {
        "summary": "Adds note to entity",
        "description": "Adds a note to the sales invoice.\n\n### Required scope(s)\n `sales_invoices`",
        "tags": [
          "Sales invoices"
        ],
        "security": [
          {
            "bearerAuth": [
              "sales_invoices"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/administration_id"
          },
          {
            "name": "sales_invoice_id",
            "in": "path",
            "required": true,
            "schema": {
              "$ref": "#/components/schemas/identifier"
            }
          },
          {
            "$ref": "#/components/parameters/format"
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/*": {
              "schema": {
                "unevaluatedProperties": false,
                "type": "object",
                "properties": {
                  "note": {
                    "type": "object",
                    "unevaluatedProperties": false,
                    "properties": {
                      "note": {
                        "type": "string",
                        "description": "**Required**. Text for the note or to-do."
                      },
                      "todo": {
                        "type": [
                          "boolean",
                          "string"
                        ],
                        "description": "If `true` the note is a to-do."
                      },
                      "assignee_id": {
                        "$ref": "#/components/schemas/identifier",
                        "description": "Assign to-do to user. Should be a valid user id. If assignee_id is provided the note will be a to-do."
                      }
                    },
                    "required": []
                  }
                },
                "required": []
              },
              "examples": {
                "CreateANote": {
                  "summary": "Create a note",
                  "value": {
                    "note": {
                      "note": "Text of the note",
                      "assignee_id": 502689149679044540,
                      "todo": true
                    }
                  }
                }
              }
            }
          }
        },
        "responses": {
          "201": {
            "description": "Note created",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/note_response"
                },
                "examples": {
                  "CreateANote": {
                    "summary": "Create a note",
                    "value": {
                      "id": "502689149691627474",
                      "administration_id": 123,
                      "entity_id": "502689149580478400",
                      "entity_type": "SalesInvoice",
                      "user_id": "502689108256097381",
                      "assignee_id": "502689149679044560",
                      "todo": true,
                      "note": "Text of the note",
                      "completed_at": null,
                      "completed_by_id": null,
                      "todo_type": null,
                      "data": {},
                      "created_at": "2026-11-02T12:15:52.917Z",
                      "updated_at": "2026-11-02T12:15:52.917Z"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "Bad request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/symbolic_error"
                },
                "examples": {
                  "ReturnsA400StatusWhenUserHasNoPermissionsToNotes": {
                    "summary": "Returns a 400 status when user has no permissions to notes",
                    "value": {
                      "error": "User has no permissions to notes for SalesInvoice",
                      "symbolic": {
                        "user": "insufficient_permissions"
                      }
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "Unprocessable entity",
            "content": {
              "application/json": {
                "schema": {
                  "anyOf": [
                    {
                      "$ref": "#/components/schemas/symbolic_error"
                    },
                    {
                      "$ref": "#/components/schemas/non_symbolic_error"
                    }
                  ]
                },
                "examples": {
                  "ReturnsA422StatusWhenTheNoteIsNotValid": {
                    "summary": "Returns a 422 status when the note is not valid",
                    "value": {
                      "error": {
                        "note": [
                          "can't be blank"
                        ],
                        "todo_type": [
                          "can't be blank"
                        ]
                      },
                      "details": {
                        "note": [
                          {
                            "error": "blank"
                          }
                        ],
                        "todo_type": [
                          {
                            "error": "blank"
                          }
                        ]
                      }
                    }
                  }
                }
              }
            }
          }
        },
        "operationId": "post_administration_id_sales_invoices_sales_invoice_id_notes"
      }
    },
    "/{administration_id}/sales_invoices/{sales_invoice_id}/payments/{id}{format}": {
      "delete": {
        "summary": "Delete a payment",
        "description": "Delete a payment from a sales invoice.\n\nWhen the payment is linked to a financial mutation, the token also needs the `bank` scope. Such a payment is\nunlinked from the mutation instead and stays on the invoice, unless it was created by linking it to that\nmutation.\n\n### Required scope(s)\n `sales_invoices`",
        "tags": [
          "Sales invoices"
        ],
        "security": [
          {
            "bearerAuth": [
              "sales_invoices"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/administration_id"
          },
          {
            "name": "sales_invoice_id",
            "in": "path",
            "required": true,
            "schema": {
              "$ref": "#/components/schemas/identifier"
            }
          },
          {
            "name": "id",
            "in": "path",
            "required": true,
            "schema": {
              "$ref": "#/components/schemas/identifier"
            }
          },
          {
            "$ref": "#/components/parameters/format"
          }
        ],
        "responses": {
          "204": {
            "description": "Payment deleted"
          },
          "404": {
            "$ref": "#/components/responses/404_not_found"
          },
          "422": {
            "$ref": "#/components/responses/422_unprocessable_entity"
          }
        },
        "operationId": "delete_administration_id_sales_invoices_sales_invoice_id_payments_id"
      }
    },
    "/{administration_id}/sales_invoices/{sales_invoice_id}/payments{format}": {
      "post": {
        "summary": "Create a payment",
        "description": "Registers a payment for a sales invoice.\n\nA `cash_payment` with `financial_account_id` and without `financial_mutation_id` also needs the `bank` scope.\nAn `invoices_settlement` against a purchase invoice also needs the `documents` scope.\n\n### Required scope(s)\n `sales_invoices`",
        "tags": [
          "Sales invoices"
        ],
        "security": [
          {
            "bearerAuth": [
              "sales_invoices"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/administration_id"
          },
          {
            "name": "sales_invoice_id",
            "in": "path",
            "required": true,
            "schema": {
              "$ref": "#/components/schemas/identifier"
            }
          },
          {
            "$ref": "#/components/parameters/format"
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/*": {
              "schema": {
                "unevaluatedProperties": false,
                "type": "object",
                "properties": {
                  "payment": {
                    "type": "object",
                    "unevaluatedProperties": false,
                    "properties": {
                      "payment_date": {
                        "type": "string",
                        "description": "The date on which the payment was made."
                      },
                      "price": {
                        "$ref": "#/components/schemas/money",
                        "description": "The amount paid in the document's currency."
                      },
                      "price_base": {
                        "$ref": "#/components/schemas/money",
                        "description": "Amount paid expressed in the base currency of the administration. Required when the document uses a different currency than the administration's base currency."
                      },
                      "financial_account_id": {
                        "$ref": "#/components/schemas/identifier",
                        "description": "The ID of the financial account (bank account or cash register) associated with this payment. Required for `private_payment` and `cash_payment` actions. Should be a valid financial account id."
                      },
                      "financial_mutation_id": {
                        "$ref": "#/components/schemas/identifier",
                        "description": "The ID of the bank transaction to link this payment to. Required for `bank_transfer` actions. Should be a valid financial mutation id."
                      },
                      "transaction_identifier": {
                        "type": "string",
                        "description": "An external transaction reference, e.g. a bank transaction ID or PSP reference. Used to match the payment with financial mutations."
                      },
                      "manual_payment_action": {
                        "type": "string",
                        "description": "Can be `private_payment` (needs financial_account_id), `payment_without_proof`, `cash_payment` (needs financial_account_id), `rounding_error`, `bank_transfer` (needs financial_mutation_id), `balance_settlement` (needs ledger_account_id) or `invoices_settlement` (needs invoice_id). `payment_without_proof` is only accepted when the administration allows payments without proof."
                      },
                      "ledger_account_id": {
                        "$ref": "#/components/schemas/identifier",
                        "description": "The ID of the ledger account to book this payment to. Required for `balance_settlement` actions. Should be a valid ledger account id."
                      },
                      "invoice_id": {
                        "$ref": "#/components/schemas/identifier",
                        "description": "The ID of the document to settle this payment against. Required for `invoices_settlement` actions. Should be a valid document id (sales invoice, purchase invoice, receipt, etc.)."
                      }
                    },
                    "required": [
                      "payment_date",
                      "price"
                    ]
                  }
                },
                "required": []
              },
              "examples": {
                "CreateAPayment": {
                  "summary": "Create a payment",
                  "value": {
                    "payment": {
                      "payment_date": "2026-11-02T12:15:46.420Z",
                      "price": "363.0"
                    }
                  }
                }
              }
            }
          }
        },
        "responses": {
          "201": {
            "description": "Payment created",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/payment_response"
                },
                "examples": {
                  "CreateAPayment": {
                    "summary": "Create a payment",
                    "value": {
                      "id": "502689142904194260",
                      "administration_id": 123,
                      "invoice_type": "SalesInvoice",
                      "invoice_id": "502689142790948036",
                      "financial_account_id": null,
                      "user_id": "502689108256097381",
                      "payment_transaction_id": null,
                      "transaction_identifier": null,
                      "price": "363.0",
                      "price_base": "363.0",
                      "payment_date": "2026-11-02",
                      "credit_invoice_id": null,
                      "financial_mutation_id": null,
                      "ledger_account_id": "502689108803454083",
                      "linked_payment_id": null,
                      "manual_payment_action": null,
                      "created_at": "2026-11-02T12:15:46.444Z",
                      "updated_at": "2026-11-02T12:15:46.444Z"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "$ref": "#/components/responses/400_bad_request"
          },
          "404": {
            "$ref": "#/components/responses/404_not_found"
          },
          "422": {
            "$ref": "#/components/responses/422_unprocessable_entity"
          }
        },
        "operationId": "post_administration_id_sales_invoices_sales_invoice_id_payments"
      }
    },
    "/{administration_id}/sales_invoices{format}": {
      "get": {
        "summary": "List all invoices",
        "description": "Returns a paginated list of sales invoices in the administration.\n\nSorting with `sort=date_asc` does not work when the period includes today and the filter includes draft or scheduled invoices; the request then answers 400. Use for example `state:open|pending_payment|reminded|late|paid|uncollectible`, or a period that does not include today.\n\n### Required scope(s)\n `sales_invoices`",
        "tags": [
          "Sales invoices"
        ],
        "security": [
          {
            "bearerAuth": [
              "sales_invoices"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/administration_id"
          },
          {
            "$ref": "#/components/parameters/format"
          },
          {
            "name": "filter",
            "in": "query",
            "required": false,
            "description": "Filters are `key:value` terms separated by commas (e.g. `period:this_year,state:all`). Any filter you pass replaces the defaults below entirely, so include every key you need. Available filters:\n\n| **Filter** | **Type** | **Default** | **Description** |\n| - | - | - | - |\n| state | `String` | `all` | `all`, `draft`, `open`, `scheduled`, `pending_payment`, `late`, `reminded`, `paid` or `uncollectible` |\n| period | `String` | `this_year` | Matches on the invoice date. A period description (`this_week`, `prev_week`, `next_week`, `this_month`, `prev_month`, `next_month`, `this_quarter`, `prev_quarter`, `next_quarter`, `this_year`, `prev_year`, `next_year`) or a custom period (`201301..201302`, `20130101..20130131`). A custom period must have a start and an end date. It must not be longer than 10 years. For one month, use `202401..202401`, not `202401`. Without `period`, the filter does not limit the dates. The default `this_year` applies only when you send no `filter`. |\n| reference | `String` | | Select invoices with a certain reference |\n| contact_id | `Integer` | | Select invoices belonging to a certain contact |\n| recurring_sales_invoice_id | `Integer` | | Select invoices created by a certain recurring invoice |\n| workflow_id | `Integer` | | Select invoices that use a certain workflow |\n| created_after | `String` | | Select invoices created after the given time (exclusive). ISO 8601 formatted string. The time to compare with is in UTC timezone |\n| updated_after | `String` | | Select invoices updated after the given time (exclusive). ISO 8601 formatted string. The time to compare with is in UTC timezone |\n\nThe `period` filter matches on the invoice date. It does not look at the `period` of the individual details, which says which months the expenses belong to. Read `details[].period` in the response when you need those months, or use the reports endpoints, which already spread the amounts over that period. A detail's period can fall outside the filtered range, however wide you make it, so this filter cannot tell you which periods amounts fall in. Use the reports endpoints for that.\n\nYou can filter by multiple states at the same time by separating the values with a pipe (`state:draft|scheduled`). This also holds for the reference.\n\nA draft with no `invoice_date` set is only matched by a `period` when that period contains today. To list drafts irrespective of date, pass `state:draft` without a `period`; to narrow them down in time, use `created_after` or `updated_after`.",
            "schema": {
              "type": "string",
              "default": "period:this_year"
            },
            "examples": {
              "ReturnsAllInvoicesFilteredOnPeriod": {
                "summary": "Returns all invoices filtered on period",
                "value": "period:this_month"
              },
              "ReturnsAllSalesInvoicesCreatedAfterGivenDatetime": {
                "summary": "Returns all sales invoices created after given datetime",
                "value": "created_after:2026-11-01 12:16:05 UTC"
              },
              "ReturnsAnEmptyListWhenFilterContactIdDoesNotMatchAnyContact": {
                "summary": "Returns an empty list when filter contact id does not match any contact",
                "value": "contact_id:123"
              },
              "ReturnsTheOldestInvoicesFirstWhenSortedByDateAscending": {
                "summary": "Returns the oldest invoices first when sorted by date ascending",
                "value": "state:open"
              },
              "ReturnsOnlySalesInvoicesUpdatedAfterGivenDatetime": {
                "summary": "Returns only sales invoices updated after given datetime",
                "value": "updated_after:2026-11-02 12:16:13 UTC"
              }
            }
          },
          {
            "$ref": "#/components/parameters/page"
          },
          {
            "$ref": "#/components/parameters/sort"
          },
          {
            "$ref": "#/components/parameters/per_page"
          }
        ],
        "responses": {
          "200": {
            "description": "A list of sales invoices",
            "content": {
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "$ref": "#/components/schemas/sales_invoice_response"
                  }
                },
                "examples": {
                  "ReturnsAllInvoicesFilteredOnPeriod": {
                    "summary": "Returns all invoices filtered on period",
                    "value": [
                      {
                        "id": "502689161091745267",
                        "administration_id": 123,
                        "contact_id": "502689160858961359",
                        "contact": {
                          "id": "502689160858961359",
                          "administration_id": 123,
                          "company_name": "Foobar Holding B.V.",
                          "firstname": null,
                          "lastname": null,
                          "address1": "Hoofdstraat 12",
                          "address2": null,
                          "zipcode": "1234AB",
                          "city": "Amsterdam",
                          "country": "NL",
                          "phone": null,
                          "delivery_method": "Email",
                          "customer_id": "customer-1",
                          "tax_number": null,
                          "chamber_of_commerce": null,
                          "bank_account": null,
                          "is_trusted": false,
                          "max_transfer_amount": null,
                          "attention": null,
                          "email": "info@example.com",
                          "email_ubl": true,
                          "send_invoices_to_attention": null,
                          "send_invoices_to_email": "info@example.com",
                          "send_estimates_to_attention": null,
                          "send_estimates_to_email": "info@example.com",
                          "direct_debit": false,
                          "sepa_active": false,
                          "sepa_iban": null,
                          "sepa_iban_account_name": null,
                          "sepa_bic": null,
                          "sepa_mandate_id": null,
                          "sepa_mandate_date": null,
                          "sepa_sequence_type": "RCUR",
                          "credit_card_number": null,
                          "credit_card_reference": null,
                          "credit_card_type": null,
                          "tax_number_validated_at": null,
                          "tax_number_valid": null,
                          "invoice_workflow_id": null,
                          "estimate_workflow_id": null,
                          "si_identifier": null,
                          "si_identifier_type": null,
                          "moneybird_payments_mandate": false,
                          "created_at": "2026-11-02T12:16:03.568Z",
                          "updated_at": "2026-11-02T12:16:03.568Z",
                          "version": 1793621763,
                          "sales_invoices_url": "https://moneybird.dev/123/sales_invoices/0000000000000000000000000000000000000000000000000000000000000001/all",
                          "notes": [],
                          "custom_fields": [],
                          "contact_people": [],
                          "archived": false
                        },
                        "contact_person_id": null,
                        "contact_person": null,
                        "invoice_id": "2026-0003",
                        "recurring_sales_invoice_id": null,
                        "subscription_id": null,
                        "workflow_id": "502689109097055375",
                        "document_style_id": "502689109280556185",
                        "identity_id": "502689108656653419",
                        "draft_id": null,
                        "state": "open",
                        "invoice_date": "2026-11-02",
                        "due_date": "2026-11-16",
                        "payment_conditions": "We verzoeken u vriendelijk het bovenstaande bedrag van {document.total_price} voor {document.due_date} te voldoen op onze bankrekening onder vermelding van de omschrijving {document.payment_reference}. Voor vragen kunt u contact opnemen per e-mail.",
                        "payment_reference": "RF060000000000000JDGWQ4JP",
                        "short_payment_reference": "RF06JDGWQ4JP",
                        "reference": "Project X",
                        "language": "nl",
                        "currency": "EUR",
                        "discount": "0.0",
                        "original_sales_invoice_id": null,
                        "paused": false,
                        "paid_at": null,
                        "sent_at": "2026-11-02",
                        "created_at": "2026-11-02T12:16:03.789Z",
                        "updated_at": "2026-11-02T12:16:03.844Z",
                        "public_view_code": "937243",
                        "public_view_code_expires_at": "2027-02-02T12:16:03.823Z",
                        "version": 1793621763,
                        "details": [
                          {
                            "id": "502689161093842420",
                            "administration_id": 123,
                            "tax_rate_id": "502689108899923082",
                            "ledger_account_id": "502689108787725434",
                            "project_id": null,
                            "product_id": null,
                            "amount": "1 x",
                            "amount_decimal": "1.0",
                            "description": "Project X",
                            "price": "300.0",
                            "period": null,
                            "row_order": 1,
                            "total_price_excl_tax_with_discount": "300.0",
                            "total_price_excl_tax_with_discount_base": "300.0",
                            "tax_report_reference": [
                              "NL/1a"
                            ],
                            "mandatory_tax_text": null,
                            "created_at": "2026-11-02T12:16:03.791Z",
                            "updated_at": "2026-11-02T12:16:03.843Z"
                          }
                        ],
                        "payments": [],
                        "total_paid": "0.0",
                        "total_unpaid": "363.0",
                        "total_unpaid_base": "363.0",
                        "prices_are_incl_tax": false,
                        "total_price_excl_tax": "300.0",
                        "total_price_excl_tax_base": "300.0",
                        "total_price_incl_tax": "363.0",
                        "total_price_incl_tax_base": "363.0",
                        "total_discount": "0.0",
                        "marked_dubious_on": null,
                        "marked_uncollectible_on": null,
                        "reminder_count": 0,
                        "next_reminder": "2026-11-16",
                        "original_estimate_id": null,
                        "url": "http://moneybird.dev/123/external/0000000000000000000000000000000000000000000000000000000000000001/dca9881c6c878f6bb311094abb4a470fcd3c6994fcd8f75c767eee02f55a9c17/sales_invoice",
                        "payment_url": "http://moneybird.dev/123/external/0000000000000000000000000000000000000000000000000000000000000001/dca9881c6c878f6bb311094abb4a470fcd3c6994fcd8f75c767eee02f55a9c17/sales_invoice",
                        "custom_fields": [],
                        "notes": [],
                        "attachments": [],
                        "events": [
                          {
                            "administration_id": 123,
                            "user_id": "502689108256097381",
                            "action": "sales_invoice_created",
                            "link_entity_id": null,
                            "link_entity_type": null,
                            "data": {},
                            "created_at": "2026-11-02T12:16:03.794Z",
                            "updated_at": "2026-11-02T12:16:03.794Z"
                          },
                          {
                            "administration_id": 123,
                            "user_id": "502689108256097381",
                            "action": "sales_invoice_state_changed_to_open",
                            "link_entity_id": null,
                            "link_entity_type": null,
                            "data": {},
                            "created_at": "2026-11-02T12:16:03.830Z",
                            "updated_at": "2026-11-02T12:16:03.830Z"
                          },
                          {
                            "administration_id": 123,
                            "user_id": "502689108256097381",
                            "action": "sales_invoice_send_email",
                            "link_entity_id": null,
                            "link_entity_type": null,
                            "data": {
                              "email_address": "info@example.com",
                              "email_message": "Geachte Foobar Holding B.V.,\n\nIn de bijlage kunt u factuur 2026-0003 voor onze diensten vinden. Wij verzoeken u vriendelijk de factuur voor 16-11-2026 te voldoen.\n\nMet vriendelijke groet,\n\nParkietje B.V."
                            },
                            "created_at": "2026-11-02T12:16:03.853Z",
                            "updated_at": "2026-11-02T12:16:03.853Z"
                          }
                        ],
                        "tax_totals": [
                          {
                            "tax_rate_id": "502689108899923082",
                            "taxable_amount": "300.0",
                            "taxable_amount_base": "300.0",
                            "tax_amount": "63.0",
                            "tax_amount_base": "63.0"
                          }
                        ],
                        "time_entries": []
                      },
                      {
                        "id": "502689160984790500",
                        "administration_id": 123,
                        "contact_id": "502689160858961359",
                        "contact": {
                          "id": "502689160858961359",
                          "administration_id": 123,
                          "company_name": "Foobar Holding B.V.",
                          "firstname": null,
                          "lastname": null,
                          "address1": "Hoofdstraat 12",
                          "address2": null,
                          "zipcode": "1234AB",
                          "city": "Amsterdam",
                          "country": "NL",
                          "phone": null,
                          "delivery_method": "Email",
                          "customer_id": "customer-1",
                          "tax_number": null,
                          "chamber_of_commerce": null,
                          "bank_account": null,
                          "is_trusted": false,
                          "max_transfer_amount": null,
                          "attention": null,
                          "email": "info@example.com",
                          "email_ubl": true,
                          "send_invoices_to_attention": null,
                          "send_invoices_to_email": "info@example.com",
                          "send_estimates_to_attention": null,
                          "send_estimates_to_email": "info@example.com",
                          "direct_debit": false,
                          "sepa_active": false,
                          "sepa_iban": null,
                          "sepa_iban_account_name": null,
                          "sepa_bic": null,
                          "sepa_mandate_id": null,
                          "sepa_mandate_date": null,
                          "sepa_sequence_type": "RCUR",
                          "credit_card_number": null,
                          "credit_card_reference": null,
                          "credit_card_type": null,
                          "tax_number_validated_at": null,
                          "tax_number_valid": null,
                          "invoice_workflow_id": null,
                          "estimate_workflow_id": null,
                          "si_identifier": null,
                          "si_identifier_type": null,
                          "moneybird_payments_mandate": false,
                          "created_at": "2026-11-02T12:16:03.568Z",
                          "updated_at": "2026-11-02T12:16:03.568Z",
                          "version": 1793621763,
                          "sales_invoices_url": "https://moneybird.dev/123/sales_invoices/0000000000000000000000000000000000000000000000000000000000000001/all",
                          "notes": [],
                          "custom_fields": [],
                          "contact_people": [],
                          "archived": false
                        },
                        "contact_person_id": null,
                        "contact_person": null,
                        "invoice_id": "2026-0002",
                        "recurring_sales_invoice_id": null,
                        "subscription_id": null,
                        "workflow_id": "502689109097055375",
                        "document_style_id": "502689109280556185",
                        "identity_id": "502689108656653419",
                        "draft_id": null,
                        "state": "open",
                        "invoice_date": "2026-11-02",
                        "due_date": "2026-11-16",
                        "payment_conditions": "We verzoeken u vriendelijk het bovenstaande bedrag van {document.total_price} voor {document.due_date} te voldoen op onze bankrekening onder vermelding van de omschrijving {document.payment_reference}. Voor vragen kunt u contact opnemen per e-mail.",
                        "payment_reference": "RF730000000000000PEM56TFC",
                        "short_payment_reference": "RF73PEM56TFC",
                        "reference": "Project X",
                        "language": "nl",
                        "currency": "EUR",
                        "discount": "0.0",
                        "original_sales_invoice_id": null,
                        "paused": false,
                        "paid_at": null,
                        "sent_at": "2026-11-02",
                        "created_at": "2026-11-02T12:16:03.687Z",
                        "updated_at": "2026-11-02T12:16:03.746Z",
                        "public_view_code": "773458",
                        "public_view_code_expires_at": "2027-02-02T12:16:03.719Z",
                        "version": 1793621763,
                        "details": [
                          {
                            "id": "502689160986887653",
                            "administration_id": 123,
                            "tax_rate_id": "502689108899923082",
                            "ledger_account_id": "502689108787725434",
                            "project_id": null,
                            "product_id": null,
                            "amount": "1 x",
                            "amount_decimal": "1.0",
                            "description": "Project X",
                            "price": "300.0",
                            "period": null,
                            "row_order": 1,
                            "total_price_excl_tax_with_discount": "300.0",
                            "total_price_excl_tax_with_discount_base": "300.0",
                            "tax_report_reference": [
                              "NL/1a"
                            ],
                            "mandatory_tax_text": null,
                            "created_at": "2026-11-02T12:16:03.689Z",
                            "updated_at": "2026-11-02T12:16:03.745Z"
                          }
                        ],
                        "payments": [],
                        "total_paid": "0.0",
                        "total_unpaid": "363.0",
                        "total_unpaid_base": "363.0",
                        "prices_are_incl_tax": false,
                        "total_price_excl_tax": "300.0",
                        "total_price_excl_tax_base": "300.0",
                        "total_price_incl_tax": "363.0",
                        "total_price_incl_tax_base": "363.0",
                        "total_discount": "0.0",
                        "marked_dubious_on": null,
                        "marked_uncollectible_on": null,
                        "reminder_count": 0,
                        "next_reminder": "2026-11-16",
                        "original_estimate_id": null,
                        "url": "http://moneybird.dev/123/external/0000000000000000000000000000000000000000000000000000000000000001/40e4b256290cd5475acbee1ddd242135a3f48a410ba312e6fe4139e9fe3b0f3e/sales_invoice",
                        "payment_url": "http://moneybird.dev/123/external/0000000000000000000000000000000000000000000000000000000000000001/40e4b256290cd5475acbee1ddd242135a3f48a410ba312e6fe4139e9fe3b0f3e/sales_invoice",
                        "custom_fields": [],
                        "notes": [],
                        "attachments": [],
                        "events": [
                          {
                            "administration_id": 123,
                            "user_id": "502689108256097381",
                            "action": "sales_invoice_created",
                            "link_entity_id": null,
                            "link_entity_type": null,
                            "data": {},
                            "created_at": "2026-11-02T12:16:03.692Z",
                            "updated_at": "2026-11-02T12:16:03.692Z"
                          },
                          {
                            "administration_id": 123,
                            "user_id": "502689108256097381",
                            "action": "sales_invoice_state_changed_to_open",
                            "link_entity_id": null,
                            "link_entity_type": null,
                            "data": {},
                            "created_at": "2026-11-02T12:16:03.727Z",
                            "updated_at": "2026-11-02T12:16:03.727Z"
                          },
                          {
                            "administration_id": 123,
                            "user_id": "502689108256097381",
                            "action": "sales_invoice_send_email",
                            "link_entity_id": null,
                            "link_entity_type": null,
                            "data": {
                              "email_address": "info@example.com",
                              "email_message": "Geachte Foobar Holding B.V.,\n\nIn de bijlage kunt u factuur 2026-0002 voor onze diensten vinden. Wij verzoeken u vriendelijk de factuur voor 16-11-2026 te voldoen.\n\nMet vriendelijke groet,\n\nParkietje B.V."
                            },
                            "created_at": "2026-11-02T12:16:03.759Z",
                            "updated_at": "2026-11-02T12:16:03.759Z"
                          }
                        ],
                        "tax_totals": [
                          {
                            "tax_rate_id": "502689108899923082",
                            "taxable_amount": "300.0",
                            "taxable_amount_base": "300.0",
                            "tax_amount": "63.0",
                            "tax_amount_base": "63.0"
                          }
                        ],
                        "time_entries": []
                      },
                      {
                        "id": "502689160891467220",
                        "administration_id": 123,
                        "contact_id": "502689160858961359",
                        "contact": {
                          "id": "502689160858961359",
                          "administration_id": 123,
                          "company_name": "Foobar Holding B.V.",
                          "firstname": null,
                          "lastname": null,
                          "address1": "Hoofdstraat 12",
                          "address2": null,
                          "zipcode": "1234AB",
                          "city": "Amsterdam",
                          "country": "NL",
                          "phone": null,
                          "delivery_method": "Email",
                          "customer_id": "customer-1",
                          "tax_number": null,
                          "chamber_of_commerce": null,
                          "bank_account": null,
                          "is_trusted": false,
                          "max_transfer_amount": null,
                          "attention": null,
                          "email": "info@example.com",
                          "email_ubl": true,
                          "send_invoices_to_attention": null,
                          "send_invoices_to_email": "info@example.com",
                          "send_estimates_to_attention": null,
                          "send_estimates_to_email": "info@example.com",
                          "direct_debit": false,
                          "sepa_active": false,
                          "sepa_iban": null,
                          "sepa_iban_account_name": null,
                          "sepa_bic": null,
                          "sepa_mandate_id": null,
                          "sepa_mandate_date": null,
                          "sepa_sequence_type": "RCUR",
                          "credit_card_number": null,
                          "credit_card_reference": null,
                          "credit_card_type": null,
                          "tax_number_validated_at": null,
                          "tax_number_valid": null,
                          "invoice_workflow_id": null,
                          "estimate_workflow_id": null,
                          "si_identifier": null,
                          "si_identifier_type": null,
                          "moneybird_payments_mandate": false,
                          "created_at": "2026-11-02T12:16:03.568Z",
                          "updated_at": "2026-11-02T12:16:03.568Z",
                          "version": 1793621763,
                          "sales_invoices_url": "https://moneybird.dev/123/sales_invoices/0000000000000000000000000000000000000000000000000000000000000001/all",
                          "notes": [],
                          "custom_fields": [],
                          "contact_people": [],
                          "archived": false
                        },
                        "contact_person_id": "502689160863155665",
                        "contact_person": {
                          "id": null,
                          "contact_id": "502689160858961359",
                          "administration_id": 123,
                          "firstname": "Jan",
                          "lastname": "Janssen",
                          "phone": "123-456-2346",
                          "email": "janjanssen@dev.null.moneybird.net",
                          "department": "Sales",
                          "created_at": "2026-11-02T12:16:03.572Z",
                          "updated_at": "2026-11-02T12:16:03.572Z",
                          "version": 1793621763
                        },
                        "invoice_id": "2026-0001",
                        "recurring_sales_invoice_id": null,
                        "subscription_id": null,
                        "workflow_id": "502689109097055375",
                        "document_style_id": "502689109280556185",
                        "identity_id": "502689108656653419",
                        "draft_id": null,
                        "state": "open",
                        "invoice_date": "2026-11-02",
                        "due_date": "2026-11-16",
                        "payment_conditions": "We verzoeken u vriendelijk het bovenstaande bedrag van {document.total_price} voor {document.due_date} te voldoen op onze bankrekening onder vermelding van de omschrijving {document.payment_reference}. Voor vragen kunt u contact opnemen per e-mail.",
                        "payment_reference": "RF420000000000000QUCHRVAV",
                        "short_payment_reference": "RF42QUCHRVAV",
                        "reference": "Project X",
                        "language": "nl",
                        "currency": "EUR",
                        "discount": "0.0",
                        "original_sales_invoice_id": null,
                        "paused": false,
                        "paid_at": null,
                        "sent_at": "2026-11-02",
                        "created_at": "2026-11-02T12:16:03.598Z",
                        "updated_at": "2026-11-02T12:16:03.652Z",
                        "public_view_code": "747107",
                        "public_view_code_expires_at": "2027-02-02T12:16:03.630Z",
                        "version": 1793621763,
                        "details": [
                          {
                            "id": "502689160893564373",
                            "administration_id": 123,
                            "tax_rate_id": "502689108899923082",
                            "ledger_account_id": "502689108787725434",
                            "project_id": null,
                            "product_id": null,
                            "amount": "1 x",
                            "amount_decimal": "1.0",
                            "description": "Project X",
                            "price": "300.0",
                            "period": "20261101..20261130",
                            "row_order": 1,
                            "total_price_excl_tax_with_discount": "300.0",
                            "total_price_excl_tax_with_discount_base": "300.0",
                            "tax_report_reference": [
                              "NL/1a"
                            ],
                            "mandatory_tax_text": null,
                            "created_at": "2026-11-02T12:16:03.600Z",
                            "updated_at": "2026-11-02T12:16:03.651Z"
                          }
                        ],
                        "payments": [],
                        "total_paid": "0.0",
                        "total_unpaid": "363.0",
                        "total_unpaid_base": "363.0",
                        "prices_are_incl_tax": false,
                        "total_price_excl_tax": "300.0",
                        "total_price_excl_tax_base": "300.0",
                        "total_price_incl_tax": "363.0",
                        "total_price_incl_tax_base": "363.0",
                        "total_discount": "0.0",
                        "marked_dubious_on": null,
                        "marked_uncollectible_on": null,
                        "reminder_count": 0,
                        "next_reminder": "2026-11-16",
                        "original_estimate_id": null,
                        "url": "http://moneybird.dev/123/external/0000000000000000000000000000000000000000000000000000000000000001/7487b6011fe5bfd1f8cf8594f250a297d0f4ea86febe93e4b1fe66199a1c48bb/sales_invoice",
                        "payment_url": "http://moneybird.dev/123/external/0000000000000000000000000000000000000000000000000000000000000001/7487b6011fe5bfd1f8cf8594f250a297d0f4ea86febe93e4b1fe66199a1c48bb/sales_invoice",
                        "custom_fields": [],
                        "notes": [],
                        "attachments": [],
                        "events": [
                          {
                            "administration_id": 123,
                            "user_id": "502689108256097381",
                            "action": "sales_invoice_created",
                            "link_entity_id": null,
                            "link_entity_type": null,
                            "data": {},
                            "created_at": "2026-11-02T12:16:03.603Z",
                            "updated_at": "2026-11-02T12:16:03.603Z"
                          },
                          {
                            "administration_id": 123,
                            "user_id": "502689108256097381",
                            "action": "sales_invoice_state_changed_to_open",
                            "link_entity_id": null,
                            "link_entity_type": null,
                            "data": {},
                            "created_at": "2026-11-02T12:16:03.637Z",
                            "updated_at": "2026-11-02T12:16:03.637Z"
                          },
                          {
                            "administration_id": 123,
                            "user_id": "502689108256097381",
                            "action": "sales_invoice_send_email",
                            "link_entity_id": null,
                            "link_entity_type": null,
                            "data": {
                              "email_address": "info@example.com; janjanssen@dev.null.moneybird.net",
                              "email_message": "Geachte Jan Janssen,\n\nIn de bijlage kunt u factuur 2026-0001 voor onze diensten vinden. Wij verzoeken u vriendelijk de factuur voor 16-11-2026 te voldoen.\n\nMet vriendelijke groet,\n\nParkietje B.V."
                            },
                            "created_at": "2026-11-02T12:16:03.662Z",
                            "updated_at": "2026-11-02T12:16:03.662Z"
                          }
                        ],
                        "tax_totals": [
                          {
                            "tax_rate_id": "502689108899923082",
                            "taxable_amount": "300.0",
                            "taxable_amount_base": "300.0",
                            "tax_amount": "63.0",
                            "tax_amount_base": "63.0"
                          }
                        ],
                        "time_entries": []
                      }
                    ]
                  },
                  "ReturnsPaginatedSalesInvoicesOnPage2": {
                    "summary": "Returns paginated sales invoices on page 2",
                    "value": [
                      {
                        "id": "502689161367520792",
                        "administration_id": 123,
                        "contact_id": "502689161218622979",
                        "contact": {
                          "id": "502689161218622979",
                          "administration_id": 123,
                          "company_name": "Foobar Holding B.V.",
                          "firstname": null,
                          "lastname": null,
                          "address1": "Hoofdstraat 12",
                          "address2": null,
                          "zipcode": "1234AB",
                          "city": "Amsterdam",
                          "country": "NL",
                          "phone": null,
                          "delivery_method": "Email",
                          "customer_id": "customer-1",
                          "tax_number": null,
                          "chamber_of_commerce": null,
                          "bank_account": null,
                          "is_trusted": false,
                          "max_transfer_amount": null,
                          "attention": null,
                          "email": "info@example.com",
                          "email_ubl": true,
                          "send_invoices_to_attention": null,
                          "send_invoices_to_email": "info@example.com",
                          "send_estimates_to_attention": null,
                          "send_estimates_to_email": "info@example.com",
                          "direct_debit": false,
                          "sepa_active": false,
                          "sepa_iban": null,
                          "sepa_iban_account_name": null,
                          "sepa_bic": null,
                          "sepa_mandate_id": null,
                          "sepa_mandate_date": null,
                          "sepa_sequence_type": "RCUR",
                          "credit_card_number": null,
                          "credit_card_reference": null,
                          "credit_card_type": null,
                          "tax_number_validated_at": null,
                          "tax_number_valid": null,
                          "invoice_workflow_id": null,
                          "estimate_workflow_id": null,
                          "si_identifier": null,
                          "si_identifier_type": null,
                          "moneybird_payments_mandate": false,
                          "created_at": "2026-11-02T12:16:03.911Z",
                          "updated_at": "2026-11-02T12:16:03.911Z",
                          "version": 1793621763,
                          "sales_invoices_url": "https://moneybird.dev/123/sales_invoices/0000000000000000000000000000000000000000000000000000000000000001/all",
                          "notes": [],
                          "custom_fields": [],
                          "contact_people": [],
                          "archived": false
                        },
                        "contact_person_id": null,
                        "contact_person": null,
                        "invoice_id": "2026-0002",
                        "recurring_sales_invoice_id": null,
                        "subscription_id": null,
                        "workflow_id": "502689109097055375",
                        "document_style_id": "502689109280556185",
                        "identity_id": "502689108656653419",
                        "draft_id": null,
                        "state": "open",
                        "invoice_date": "2026-11-02",
                        "due_date": "2026-11-16",
                        "payment_conditions": "We verzoeken u vriendelijk het bovenstaande bedrag van {document.total_price} voor {document.due_date} te voldoen op onze bankrekening onder vermelding van de omschrijving {document.payment_reference}. Voor vragen kunt u contact opnemen per e-mail.",
                        "payment_reference": "RF840000000000000WGWNMATA",
                        "short_payment_reference": "RF84WGWNMATA",
                        "reference": "Project X",
                        "language": "nl",
                        "currency": "EUR",
                        "discount": "0.0",
                        "original_sales_invoice_id": null,
                        "paused": false,
                        "paid_at": null,
                        "sent_at": "2026-11-02",
                        "created_at": "2026-11-02T12:16:04.052Z",
                        "updated_at": "2026-11-02T12:16:04.123Z",
                        "public_view_code": "018198",
                        "public_view_code_expires_at": "2027-02-02T12:16:04.099Z",
                        "version": 1793621764,
                        "details": [
                          {
                            "id": "502689161369617945",
                            "administration_id": 123,
                            "tax_rate_id": "502689108899923082",
                            "ledger_account_id": "502689108787725434",
                            "project_id": null,
                            "product_id": null,
                            "amount": "1 x",
                            "amount_decimal": "1.0",
                            "description": "Project X",
                            "price": "300.0",
                            "period": null,
                            "row_order": 1,
                            "total_price_excl_tax_with_discount": "300.0",
                            "total_price_excl_tax_with_discount_base": "300.0",
                            "tax_report_reference": [
                              "NL/1a"
                            ],
                            "mandatory_tax_text": null,
                            "created_at": "2026-11-02T12:16:04.054Z",
                            "updated_at": "2026-11-02T12:16:04.122Z"
                          }
                        ],
                        "payments": [],
                        "total_paid": "0.0",
                        "total_unpaid": "363.0",
                        "total_unpaid_base": "363.0",
                        "prices_are_incl_tax": false,
                        "total_price_excl_tax": "300.0",
                        "total_price_excl_tax_base": "300.0",
                        "total_price_incl_tax": "363.0",
                        "total_price_incl_tax_base": "363.0",
                        "total_discount": "0.0",
                        "marked_dubious_on": null,
                        "marked_uncollectible_on": null,
                        "reminder_count": 0,
                        "next_reminder": "2026-11-16",
                        "original_estimate_id": null,
                        "url": "http://moneybird.dev/123/external/0000000000000000000000000000000000000000000000000000000000000001/ee4d4701bbab32ef284c222304c6ff1ae23a2a2b59188ecbd0d60bba381d8e6e/sales_invoice",
                        "payment_url": "http://moneybird.dev/123/external/0000000000000000000000000000000000000000000000000000000000000001/ee4d4701bbab32ef284c222304c6ff1ae23a2a2b59188ecbd0d60bba381d8e6e/sales_invoice",
                        "custom_fields": [],
                        "notes": [],
                        "attachments": [],
                        "events": [
                          {
                            "administration_id": 123,
                            "user_id": "502689108256097381",
                            "action": "sales_invoice_created",
                            "link_entity_id": null,
                            "link_entity_type": null,
                            "data": {},
                            "created_at": "2026-11-02T12:16:04.057Z",
                            "updated_at": "2026-11-02T12:16:04.057Z"
                          },
                          {
                            "administration_id": 123,
                            "user_id": "502689108256097381",
                            "action": "sales_invoice_state_changed_to_open",
                            "link_entity_id": null,
                            "link_entity_type": null,
                            "data": {},
                            "created_at": "2026-11-02T12:16:04.107Z",
                            "updated_at": "2026-11-02T12:16:04.107Z"
                          },
                          {
                            "administration_id": 123,
                            "user_id": "502689108256097381",
                            "action": "sales_invoice_send_email",
                            "link_entity_id": null,
                            "link_entity_type": null,
                            "data": {
                              "email_address": "info@example.com",
                              "email_message": "Geachte Foobar Holding B.V.,\n\nIn de bijlage kunt u factuur 2026-0002 voor onze diensten vinden. Wij verzoeken u vriendelijk de factuur voor 16-11-2026 te voldoen.\n\nMet vriendelijke groet,\n\nParkietje B.V."
                            },
                            "created_at": "2026-11-02T12:16:04.137Z",
                            "updated_at": "2026-11-02T12:16:04.137Z"
                          }
                        ],
                        "tax_totals": [
                          {
                            "tax_rate_id": "502689108899923082",
                            "taxable_amount": "300.0",
                            "taxable_amount_base": "300.0",
                            "tax_amount": "63.0",
                            "tax_amount_base": "63.0"
                          }
                        ],
                        "time_entries": []
                      }
                    ]
                  },
                  "ReturnsAllSalesInvoicesCreatedAfterGivenDatetime": {
                    "summary": "Returns all sales invoices created after given datetime",
                    "value": [
                      {
                        "id": "502689163034756855",
                        "administration_id": 123,
                        "contact_id": "502689162735912659",
                        "contact": {
                          "id": "502689162735912659",
                          "administration_id": 123,
                          "company_name": "Foobar Holding B.V.",
                          "firstname": null,
                          "lastname": null,
                          "address1": "Hoofdstraat 12",
                          "address2": null,
                          "zipcode": "1234AB",
                          "city": "Amsterdam",
                          "country": "NL",
                          "phone": null,
                          "delivery_method": "Email",
                          "customer_id": "customer-1",
                          "tax_number": null,
                          "chamber_of_commerce": null,
                          "bank_account": null,
                          "is_trusted": false,
                          "max_transfer_amount": null,
                          "attention": null,
                          "email": "info@example.com",
                          "email_ubl": true,
                          "send_invoices_to_attention": null,
                          "send_invoices_to_email": "info@example.com",
                          "send_estimates_to_attention": null,
                          "send_estimates_to_email": "info@example.com",
                          "direct_debit": false,
                          "sepa_active": false,
                          "sepa_iban": null,
                          "sepa_iban_account_name": null,
                          "sepa_bic": null,
                          "sepa_mandate_id": null,
                          "sepa_mandate_date": null,
                          "sepa_sequence_type": "RCUR",
                          "credit_card_number": null,
                          "credit_card_reference": null,
                          "credit_card_type": null,
                          "tax_number_validated_at": null,
                          "tax_number_valid": null,
                          "invoice_workflow_id": null,
                          "estimate_workflow_id": null,
                          "si_identifier": null,
                          "si_identifier_type": null,
                          "moneybird_payments_mandate": false,
                          "created_at": "2026-11-02T12:16:05.358Z",
                          "updated_at": "2026-11-02T12:16:05.358Z",
                          "version": 1793621765,
                          "sales_invoices_url": "https://moneybird.dev/123/sales_invoices/0000000000000000000000000000000000000000000000000000000000000001/all",
                          "notes": [],
                          "custom_fields": [],
                          "contact_people": [],
                          "archived": false
                        },
                        "contact_person_id": null,
                        "contact_person": null,
                        "invoice_id": "2026-0003",
                        "recurring_sales_invoice_id": null,
                        "subscription_id": null,
                        "workflow_id": "502689109097055375",
                        "document_style_id": "502689109280556185",
                        "identity_id": "502689108656653419",
                        "draft_id": null,
                        "state": "open",
                        "invoice_date": "2026-11-02",
                        "due_date": "2026-11-16",
                        "payment_conditions": "We verzoeken u vriendelijk het bovenstaande bedrag van {document.total_price} voor {document.due_date} te voldoen op onze bankrekening onder vermelding van de omschrijving {document.payment_reference}. Voor vragen kunt u contact opnemen per e-mail.",
                        "payment_reference": "RF480000000000000ZVF3HRJN",
                        "short_payment_reference": "RF48ZVF3HRJN",
                        "reference": "Project X",
                        "language": "nl",
                        "currency": "EUR",
                        "discount": "0.0",
                        "original_sales_invoice_id": null,
                        "paused": false,
                        "paid_at": null,
                        "sent_at": "2026-11-02",
                        "created_at": "2026-11-02T12:16:05.642Z",
                        "updated_at": "2026-11-02T12:16:05.713Z",
                        "public_view_code": "584893",
                        "public_view_code_expires_at": "2027-02-02T12:16:05.686Z",
                        "version": 1793621765,
                        "details": [
                          {
                            "id": "502689163037902584",
                            "administration_id": 123,
                            "tax_rate_id": "502689108899923082",
                            "ledger_account_id": "502689108787725434",
                            "project_id": null,
                            "product_id": null,
                            "amount": "1 x",
                            "amount_decimal": "1.0",
                            "description": "Project X",
                            "price": "300.0",
                            "period": null,
                            "row_order": 1,
                            "total_price_excl_tax_with_discount": "300.0",
                            "total_price_excl_tax_with_discount_base": "300.0",
                            "tax_report_reference": [
                              "NL/1a"
                            ],
                            "mandatory_tax_text": null,
                            "created_at": "2026-11-02T12:16:05.645Z",
                            "updated_at": "2026-11-02T12:16:05.712Z"
                          }
                        ],
                        "payments": [],
                        "total_paid": "0.0",
                        "total_unpaid": "363.0",
                        "total_unpaid_base": "363.0",
                        "prices_are_incl_tax": false,
                        "total_price_excl_tax": "300.0",
                        "total_price_excl_tax_base": "300.0",
                        "total_price_incl_tax": "363.0",
                        "total_price_incl_tax_base": "363.0",
                        "total_discount": "0.0",
                        "marked_dubious_on": null,
                        "marked_uncollectible_on": null,
                        "reminder_count": 0,
                        "next_reminder": "2026-11-16",
                        "original_estimate_id": null,
                        "url": "http://moneybird.dev/123/external/0000000000000000000000000000000000000000000000000000000000000001/83cad103f0a20b5c7da2fdd1649427884098105c2a1bb0260d6ff1a251617474/sales_invoice",
                        "payment_url": "http://moneybird.dev/123/external/0000000000000000000000000000000000000000000000000000000000000001/83cad103f0a20b5c7da2fdd1649427884098105c2a1bb0260d6ff1a251617474/sales_invoice",
                        "custom_fields": [],
                        "notes": [],
                        "attachments": [],
                        "events": [
                          {
                            "administration_id": 123,
                            "user_id": "502689108256097381",
                            "action": "sales_invoice_created",
                            "link_entity_id": null,
                            "link_entity_type": null,
                            "data": {},
                            "created_at": "2026-11-02T12:16:05.649Z",
                            "updated_at": "2026-11-02T12:16:05.649Z"
                          },
                          {
                            "administration_id": 123,
                            "user_id": "502689108256097381",
                            "action": "sales_invoice_state_changed_to_open",
                            "link_entity_id": null,
                            "link_entity_type": null,
                            "data": {},
                            "created_at": "2026-11-02T12:16:05.694Z",
                            "updated_at": "2026-11-02T12:16:05.694Z"
                          },
                          {
                            "administration_id": 123,
                            "user_id": "502689108256097381",
                            "action": "sales_invoice_send_email",
                            "link_entity_id": null,
                            "link_entity_type": null,
                            "data": {
                              "email_address": "info@example.com",
                              "email_message": "Geachte Foobar Holding B.V.,\n\nIn de bijlage kunt u factuur 2026-0003 voor onze diensten vinden. Wij verzoeken u vriendelijk de factuur voor 16-11-2026 te voldoen.\n\nMet vriendelijke groet,\n\nParkietje B.V."
                            },
                            "created_at": "2026-11-02T12:16:05.726Z",
                            "updated_at": "2026-11-02T12:16:05.726Z"
                          }
                        ],
                        "tax_totals": [
                          {
                            "tax_rate_id": "502689108899923082",
                            "taxable_amount": "300.0",
                            "taxable_amount_base": "300.0",
                            "tax_amount": "63.0",
                            "tax_amount_base": "63.0"
                          }
                        ],
                        "time_entries": []
                      },
                      {
                        "id": "502689162899490536",
                        "administration_id": 123,
                        "contact_id": "502689162735912659",
                        "contact": {
                          "id": "502689162735912659",
                          "administration_id": 123,
                          "company_name": "Foobar Holding B.V.",
                          "firstname": null,
                          "lastname": null,
                          "address1": "Hoofdstraat 12",
                          "address2": null,
                          "zipcode": "1234AB",
                          "city": "Amsterdam",
                          "country": "NL",
                          "phone": null,
                          "delivery_method": "Email",
                          "customer_id": "customer-1",
                          "tax_number": null,
                          "chamber_of_commerce": null,
                          "bank_account": null,
                          "is_trusted": false,
                          "max_transfer_amount": null,
                          "attention": null,
                          "email": "info@example.com",
                          "email_ubl": true,
                          "send_invoices_to_attention": null,
                          "send_invoices_to_email": "info@example.com",
                          "send_estimates_to_attention": null,
                          "send_estimates_to_email": "info@example.com",
                          "direct_debit": false,
                          "sepa_active": false,
                          "sepa_iban": null,
                          "sepa_iban_account_name": null,
                          "sepa_bic": null,
                          "sepa_mandate_id": null,
                          "sepa_mandate_date": null,
                          "sepa_sequence_type": "RCUR",
                          "credit_card_number": null,
                          "credit_card_reference": null,
                          "credit_card_type": null,
                          "tax_number_validated_at": null,
                          "tax_number_valid": null,
                          "invoice_workflow_id": null,
                          "estimate_workflow_id": null,
                          "si_identifier": null,
                          "si_identifier_type": null,
                          "moneybird_payments_mandate": false,
                          "created_at": "2026-11-02T12:16:05.358Z",
                          "updated_at": "2026-11-02T12:16:05.358Z",
                          "version": 1793621765,
                          "sales_invoices_url": "https://moneybird.dev/123/sales_invoices/0000000000000000000000000000000000000000000000000000000000000001/all",
                          "notes": [],
                          "custom_fields": [],
                          "contact_people": [],
                          "archived": false
                        },
                        "contact_person_id": null,
                        "contact_person": null,
                        "invoice_id": "2026-0002",
                        "recurring_sales_invoice_id": null,
                        "subscription_id": null,
                        "workflow_id": "502689109097055375",
                        "document_style_id": "502689109280556185",
                        "identity_id": "502689108656653419",
                        "draft_id": null,
                        "state": "open",
                        "invoice_date": "2026-11-02",
                        "due_date": "2026-11-16",
                        "payment_conditions": "We verzoeken u vriendelijk het bovenstaande bedrag van {document.total_price} voor {document.due_date} te voldoen op onze bankrekening onder vermelding van de omschrijving {document.payment_reference}. Voor vragen kunt u contact opnemen per e-mail.",
                        "payment_reference": "RF210000000000000TDNUUCQZ",
                        "short_payment_reference": "RF21TDNUUCQZ",
                        "reference": "Project X",
                        "language": "nl",
                        "currency": "EUR",
                        "discount": "0.0",
                        "original_sales_invoice_id": null,
                        "paused": false,
                        "paid_at": null,
                        "sent_at": "2026-11-02",
                        "created_at": "2026-11-02T12:16:05.514Z",
                        "updated_at": "2026-11-02T12:16:05.585Z",
                        "public_view_code": "501244",
                        "public_view_code_expires_at": "2027-02-02T12:16:05.553Z",
                        "version": 1793621765,
                        "details": [
                          {
                            "id": "502689162901587689",
                            "administration_id": 123,
                            "tax_rate_id": "502689108899923082",
                            "ledger_account_id": "502689108787725434",
                            "project_id": null,
                            "product_id": null,
                            "amount": "1 x",
                            "amount_decimal": "1.0",
                            "description": "Project X",
                            "price": "300.0",
                            "period": null,
                            "row_order": 1,
                            "total_price_excl_tax_with_discount": "300.0",
                            "total_price_excl_tax_with_discount_base": "300.0",
                            "tax_report_reference": [
                              "NL/1a"
                            ],
                            "mandatory_tax_text": null,
                            "created_at": "2026-11-02T12:16:05.516Z",
                            "updated_at": "2026-11-02T12:16:05.584Z"
                          }
                        ],
                        "payments": [],
                        "total_paid": "0.0",
                        "total_unpaid": "363.0",
                        "total_unpaid_base": "363.0",
                        "prices_are_incl_tax": false,
                        "total_price_excl_tax": "300.0",
                        "total_price_excl_tax_base": "300.0",
                        "total_price_incl_tax": "363.0",
                        "total_price_incl_tax_base": "363.0",
                        "total_discount": "0.0",
                        "marked_dubious_on": null,
                        "marked_uncollectible_on": null,
                        "reminder_count": 0,
                        "next_reminder": "2026-11-16",
                        "original_estimate_id": null,
                        "url": "http://moneybird.dev/123/external/0000000000000000000000000000000000000000000000000000000000000001/4b17ce037e158120594c794c1b0a77e520a5a58a20eb532f1f0eece24d0bce31/sales_invoice",
                        "payment_url": "http://moneybird.dev/123/external/0000000000000000000000000000000000000000000000000000000000000001/4b17ce037e158120594c794c1b0a77e520a5a58a20eb532f1f0eece24d0bce31/sales_invoice",
                        "custom_fields": [],
                        "notes": [],
                        "attachments": [],
                        "events": [
                          {
                            "administration_id": 123,
                            "user_id": "502689108256097381",
                            "action": "sales_invoice_created",
                            "link_entity_id": null,
                            "link_entity_type": null,
                            "data": {},
                            "created_at": "2026-11-02T12:16:05.519Z",
                            "updated_at": "2026-11-02T12:16:05.519Z"
                          },
                          {
                            "administration_id": 123,
                            "user_id": "502689108256097381",
                            "action": "sales_invoice_state_changed_to_open",
                            "link_entity_id": null,
                            "link_entity_type": null,
                            "data": {},
                            "created_at": "2026-11-02T12:16:05.563Z",
                            "updated_at": "2026-11-02T12:16:05.563Z"
                          },
                          {
                            "administration_id": 123,
                            "user_id": "502689108256097381",
                            "action": "sales_invoice_send_email",
                            "link_entity_id": null,
                            "link_entity_type": null,
                            "data": {
                              "email_address": "info@example.com",
                              "email_message": "Geachte Foobar Holding B.V.,\n\nIn de bijlage kunt u factuur 2026-0002 voor onze diensten vinden. Wij verzoeken u vriendelijk de factuur voor 16-11-2026 te voldoen.\n\nMet vriendelijke groet,\n\nParkietje B.V."
                            },
                            "created_at": "2026-11-02T12:16:05.602Z",
                            "updated_at": "2026-11-02T12:16:05.602Z"
                          }
                        ],
                        "tax_totals": [
                          {
                            "tax_rate_id": "502689108899923082",
                            "taxable_amount": "300.0",
                            "taxable_amount_base": "300.0",
                            "tax_amount": "63.0",
                            "tax_amount_base": "63.0"
                          }
                        ],
                        "time_entries": []
                      },
                      {
                        "id": "502689162769467096",
                        "administration_id": 123,
                        "contact_id": "502689162735912659",
                        "contact": {
                          "id": "502689162735912659",
                          "administration_id": 123,
                          "company_name": "Foobar Holding B.V.",
                          "firstname": null,
                          "lastname": null,
                          "address1": "Hoofdstraat 12",
                          "address2": null,
                          "zipcode": "1234AB",
                          "city": "Amsterdam",
                          "country": "NL",
                          "phone": null,
                          "delivery_method": "Email",
                          "customer_id": "customer-1",
                          "tax_number": null,
                          "chamber_of_commerce": null,
                          "bank_account": null,
                          "is_trusted": false,
                          "max_transfer_amount": null,
                          "attention": null,
                          "email": "info@example.com",
                          "email_ubl": true,
                          "send_invoices_to_attention": null,
                          "send_invoices_to_email": "info@example.com",
                          "send_estimates_to_attention": null,
                          "send_estimates_to_email": "info@example.com",
                          "direct_debit": false,
                          "sepa_active": false,
                          "sepa_iban": null,
                          "sepa_iban_account_name": null,
                          "sepa_bic": null,
                          "sepa_mandate_id": null,
                          "sepa_mandate_date": null,
                          "sepa_sequence_type": "RCUR",
                          "credit_card_number": null,
                          "credit_card_reference": null,
                          "credit_card_type": null,
                          "tax_number_validated_at": null,
                          "tax_number_valid": null,
                          "invoice_workflow_id": null,
                          "estimate_workflow_id": null,
                          "si_identifier": null,
                          "si_identifier_type": null,
                          "moneybird_payments_mandate": false,
                          "created_at": "2026-11-02T12:16:05.358Z",
                          "updated_at": "2026-11-02T12:16:05.358Z",
                          "version": 1793621765,
                          "sales_invoices_url": "https://moneybird.dev/123/sales_invoices/0000000000000000000000000000000000000000000000000000000000000001/all",
                          "notes": [],
                          "custom_fields": [],
                          "contact_people": [],
                          "archived": false
                        },
                        "contact_person_id": "502689162740106965",
                        "contact_person": {
                          "id": null,
                          "contact_id": "502689162735912659",
                          "administration_id": 123,
                          "firstname": "Jan",
                          "lastname": "Janssen",
                          "phone": "123-456-2346",
                          "email": "janjanssen@dev.null.moneybird.net",
                          "department": "Sales",
                          "created_at": "2026-11-02T12:16:05.362Z",
                          "updated_at": "2026-11-02T12:16:05.362Z",
                          "version": 1793621765
                        },
                        "invoice_id": "2026-0001",
                        "recurring_sales_invoice_id": null,
                        "subscription_id": null,
                        "workflow_id": "502689109097055375",
                        "document_style_id": "502689109280556185",
                        "identity_id": "502689108656653419",
                        "draft_id": null,
                        "state": "open",
                        "invoice_date": "2026-11-02",
                        "due_date": "2026-11-16",
                        "payment_conditions": "We verzoeken u vriendelijk het bovenstaande bedrag van {document.total_price} voor {document.due_date} te voldoen op onze bankrekening onder vermelding van de omschrijving {document.payment_reference}. Voor vragen kunt u contact opnemen per e-mail.",
                        "payment_reference": "RF2200000000000006GHPF6HZ",
                        "short_payment_reference": "RF226GHPF6HZ",
                        "reference": "Project X",
                        "language": "nl",
                        "currency": "EUR",
                        "discount": "0.0",
                        "original_sales_invoice_id": null,
                        "paused": false,
                        "paid_at": null,
                        "sent_at": "2026-11-02",
                        "created_at": "2026-11-02T12:16:05.389Z",
                        "updated_at": "2026-11-02T12:16:05.458Z",
                        "public_view_code": "184875",
                        "public_view_code_expires_at": "2027-02-02T12:16:05.429Z",
                        "version": 1793621765,
                        "details": [
                          {
                            "id": "502689162771564249",
                            "administration_id": 123,
                            "tax_rate_id": "502689108899923082",
                            "ledger_account_id": "502689108787725434",
                            "project_id": null,
                            "product_id": null,
                            "amount": "1 x",
                            "amount_decimal": "1.0",
                            "description": "Project X",
                            "price": "300.0",
                            "period": "20261101..20261130",
                            "row_order": 1,
                            "total_price_excl_tax_with_discount": "300.0",
                            "total_price_excl_tax_with_discount_base": "300.0",
                            "tax_report_reference": [
                              "NL/1a"
                            ],
                            "mandatory_tax_text": null,
                            "created_at": "2026-11-02T12:16:05.391Z",
                            "updated_at": "2026-11-02T12:16:05.457Z"
                          }
                        ],
                        "payments": [],
                        "total_paid": "0.0",
                        "total_unpaid": "363.0",
                        "total_unpaid_base": "363.0",
                        "prices_are_incl_tax": false,
                        "total_price_excl_tax": "300.0",
                        "total_price_excl_tax_base": "300.0",
                        "total_price_incl_tax": "363.0",
                        "total_price_incl_tax_base": "363.0",
                        "total_discount": "0.0",
                        "marked_dubious_on": null,
                        "marked_uncollectible_on": null,
                        "reminder_count": 0,
                        "next_reminder": "2026-11-16",
                        "original_estimate_id": null,
                        "url": "http://moneybird.dev/123/external/0000000000000000000000000000000000000000000000000000000000000001/30bf6d8cd3bf2489fc13292624ffe69734d6b8a3770b2a938c8321e5c62ecf40/sales_invoice",
                        "payment_url": "http://moneybird.dev/123/external/0000000000000000000000000000000000000000000000000000000000000001/30bf6d8cd3bf2489fc13292624ffe69734d6b8a3770b2a938c8321e5c62ecf40/sales_invoice",
                        "custom_fields": [],
                        "notes": [],
                        "attachments": [],
                        "events": [
                          {
                            "administration_id": 123,
                            "user_id": "502689108256097381",
                            "action": "sales_invoice_created",
                            "link_entity_id": null,
                            "link_entity_type": null,
                            "data": {},
                            "created_at": "2026-11-02T12:16:05.394Z",
                            "updated_at": "2026-11-02T12:16:05.394Z"
                          },
                          {
                            "administration_id": 123,
                            "user_id": "502689108256097381",
                            "action": "sales_invoice_state_changed_to_open",
                            "link_entity_id": null,
                            "link_entity_type": null,
                            "data": {},
                            "created_at": "2026-11-02T12:16:05.439Z",
                            "updated_at": "2026-11-02T12:16:05.439Z"
                          },
                          {
                            "administration_id": 123,
                            "user_id": "502689108256097381",
                            "action": "sales_invoice_send_email",
                            "link_entity_id": null,
                            "link_entity_type": null,
                            "data": {
                              "email_address": "info@example.com; janjanssen@dev.null.moneybird.net",
                              "email_message": "Geachte Jan Janssen,\n\nIn de bijlage kunt u factuur 2026-0001 voor onze diensten vinden. Wij verzoeken u vriendelijk de factuur voor 16-11-2026 te voldoen.\n\nMet vriendelijke groet,\n\nParkietje B.V."
                            },
                            "created_at": "2026-11-02T12:16:05.475Z",
                            "updated_at": "2026-11-02T12:16:05.475Z"
                          }
                        ],
                        "tax_totals": [
                          {
                            "tax_rate_id": "502689108899923082",
                            "taxable_amount": "300.0",
                            "taxable_amount_base": "300.0",
                            "tax_amount": "63.0",
                            "tax_amount_base": "63.0"
                          }
                        ],
                        "time_entries": []
                      }
                    ]
                  },
                  "ReturnsAnEmptyListWhenFilterContactIdDoesNotMatchAnyContact": {
                    "summary": "Returns an empty list when filter contact id does not match any contact",
                    "value": []
                  },
                  "ReturnsPaginatedSalesInvoicesOnPage1": {
                    "summary": "Returns paginated sales invoices on page 1",
                    "value": [
                      {
                        "id": "502689164293048211",
                        "administration_id": 123,
                        "contact_id": "502689164030904175",
                        "contact": {
                          "id": "502689164030904175",
                          "administration_id": 123,
                          "company_name": "Foobar Holding B.V.",
                          "firstname": null,
                          "lastname": null,
                          "address1": "Hoofdstraat 12",
                          "address2": null,
                          "zipcode": "1234AB",
                          "city": "Amsterdam",
                          "country": "NL",
                          "phone": null,
                          "delivery_method": "Email",
                          "customer_id": "customer-1",
                          "tax_number": null,
                          "chamber_of_commerce": null,
                          "bank_account": null,
                          "is_trusted": false,
                          "max_transfer_amount": null,
                          "attention": null,
                          "email": "info@example.com",
                          "email_ubl": true,
                          "send_invoices_to_attention": null,
                          "send_invoices_to_email": "info@example.com",
                          "send_estimates_to_attention": null,
                          "send_estimates_to_email": "info@example.com",
                          "direct_debit": false,
                          "sepa_active": false,
                          "sepa_iban": null,
                          "sepa_iban_account_name": null,
                          "sepa_bic": null,
                          "sepa_mandate_id": null,
                          "sepa_mandate_date": null,
                          "sepa_sequence_type": "RCUR",
                          "credit_card_number": null,
                          "credit_card_reference": null,
                          "credit_card_type": null,
                          "tax_number_validated_at": null,
                          "tax_number_valid": null,
                          "invoice_workflow_id": null,
                          "estimate_workflow_id": null,
                          "si_identifier": null,
                          "si_identifier_type": null,
                          "moneybird_payments_mandate": false,
                          "created_at": "2026-11-02T12:16:06.592Z",
                          "updated_at": "2026-11-02T12:16:06.592Z",
                          "version": 1793621766,
                          "sales_invoices_url": "https://moneybird.dev/123/sales_invoices/0000000000000000000000000000000000000000000000000000000000000001/all",
                          "notes": [],
                          "custom_fields": [],
                          "contact_people": [],
                          "archived": false
                        },
                        "contact_person_id": null,
                        "contact_person": null,
                        "invoice_id": "2026-0003",
                        "recurring_sales_invoice_id": null,
                        "subscription_id": null,
                        "workflow_id": "502689109097055375",
                        "document_style_id": "502689109280556185",
                        "identity_id": "502689108656653419",
                        "draft_id": null,
                        "state": "open",
                        "invoice_date": "2026-11-02",
                        "due_date": "2026-11-16",
                        "payment_conditions": "We verzoeken u vriendelijk het bovenstaande bedrag van {document.total_price} voor {document.due_date} te voldoen op onze bankrekening onder vermelding van de omschrijving {document.payment_reference}. Voor vragen kunt u contact opnemen per e-mail.",
                        "payment_reference": "RF98000000000000067ZGZ2DN",
                        "short_payment_reference": "RF9867ZGZ2DN",
                        "reference": "Project X",
                        "language": "nl",
                        "currency": "EUR",
                        "discount": "0.0",
                        "original_sales_invoice_id": null,
                        "paused": false,
                        "paid_at": null,
                        "sent_at": "2026-11-02",
                        "created_at": "2026-11-02T12:16:06.842Z",
                        "updated_at": "2026-11-02T12:16:06.907Z",
                        "public_view_code": "551908",
                        "public_view_code_expires_at": "2027-02-02T12:16:06.880Z",
                        "version": 1793621766,
                        "details": [
                          {
                            "id": "502689164295145364",
                            "administration_id": 123,
                            "tax_rate_id": "502689108899923082",
                            "ledger_account_id": "502689108787725434",
                            "project_id": null,
                            "product_id": null,
                            "amount": "1 x",
                            "amount_decimal": "1.0",
                            "description": "Project X",
                            "price": "300.0",
                            "period": null,
                            "row_order": 1,
                            "total_price_excl_tax_with_discount": "300.0",
                            "total_price_excl_tax_with_discount_base": "300.0",
                            "tax_report_reference": [
                              "NL/1a"
                            ],
                            "mandatory_tax_text": null,
                            "created_at": "2026-11-02T12:16:06.845Z",
                            "updated_at": "2026-11-02T12:16:06.906Z"
                          }
                        ],
                        "payments": [],
                        "total_paid": "0.0",
                        "total_unpaid": "363.0",
                        "total_unpaid_base": "363.0",
                        "prices_are_incl_tax": false,
                        "total_price_excl_tax": "300.0",
                        "total_price_excl_tax_base": "300.0",
                        "total_price_incl_tax": "363.0",
                        "total_price_incl_tax_base": "363.0",
                        "total_discount": "0.0",
                        "marked_dubious_on": null,
                        "marked_uncollectible_on": null,
                        "reminder_count": 0,
                        "next_reminder": "2026-11-16",
                        "original_estimate_id": null,
                        "url": "http://moneybird.dev/123/external/0000000000000000000000000000000000000000000000000000000000000001/aaf90fb882e60ece46b4525bec3621ec747aaebdcdc48414455abb776dab5489/sales_invoice",
                        "payment_url": "http://moneybird.dev/123/external/0000000000000000000000000000000000000000000000000000000000000001/aaf90fb882e60ece46b4525bec3621ec747aaebdcdc48414455abb776dab5489/sales_invoice",
                        "custom_fields": [],
                        "notes": [],
                        "attachments": [],
                        "events": [
                          {
                            "administration_id": 123,
                            "user_id": "502689108256097381",
                            "action": "sales_invoice_created",
                            "link_entity_id": null,
                            "link_entity_type": null,
                            "data": {},
                            "created_at": "2026-11-02T12:16:06.848Z",
                            "updated_at": "2026-11-02T12:16:06.848Z"
                          },
                          {
                            "administration_id": 123,
                            "user_id": "502689108256097381",
                            "action": "sales_invoice_state_changed_to_open",
                            "link_entity_id": null,
                            "link_entity_type": null,
                            "data": {},
                            "created_at": "2026-11-02T12:16:06.888Z",
                            "updated_at": "2026-11-02T12:16:06.888Z"
                          },
                          {
                            "administration_id": 123,
                            "user_id": "502689108256097381",
                            "action": "sales_invoice_send_email",
                            "link_entity_id": null,
                            "link_entity_type": null,
                            "data": {
                              "email_address": "info@example.com",
                              "email_message": "Geachte Foobar Holding B.V.,\n\nIn de bijlage kunt u factuur 2026-0003 voor onze diensten vinden. Wij verzoeken u vriendelijk de factuur voor 16-11-2026 te voldoen.\n\nMet vriendelijke groet,\n\nParkietje B.V."
                            },
                            "created_at": "2026-11-02T12:16:06.919Z",
                            "updated_at": "2026-11-02T12:16:06.919Z"
                          }
                        ],
                        "tax_totals": [
                          {
                            "tax_rate_id": "502689108899923082",
                            "taxable_amount": "300.0",
                            "taxable_amount_base": "300.0",
                            "tax_amount": "63.0",
                            "tax_amount_base": "63.0"
                          }
                        ],
                        "time_entries": []
                      }
                    ]
                  },
                  "ReturnsAllInvoicesOfAnAdministration": {
                    "summary": "Returns all invoices of an administration",
                    "value": [
                      {
                        "id": "502689165113034747",
                        "administration_id": 123,
                        "contact_id": "502689164820482007",
                        "contact": {
                          "id": "502689164820482007",
                          "administration_id": 123,
                          "company_name": "Foobar Holding B.V.",
                          "firstname": null,
                          "lastname": null,
                          "address1": "Hoofdstraat 12",
                          "address2": null,
                          "zipcode": "1234AB",
                          "city": "Amsterdam",
                          "country": "NL",
                          "phone": null,
                          "delivery_method": "Email",
                          "customer_id": "customer-1",
                          "tax_number": null,
                          "chamber_of_commerce": null,
                          "bank_account": null,
                          "is_trusted": false,
                          "max_transfer_amount": null,
                          "attention": null,
                          "email": "info@example.com",
                          "email_ubl": true,
                          "send_invoices_to_attention": null,
                          "send_invoices_to_email": "info@example.com",
                          "send_estimates_to_attention": null,
                          "send_estimates_to_email": "info@example.com",
                          "direct_debit": false,
                          "sepa_active": false,
                          "sepa_iban": null,
                          "sepa_iban_account_name": null,
                          "sepa_bic": null,
                          "sepa_mandate_id": null,
                          "sepa_mandate_date": null,
                          "sepa_sequence_type": "RCUR",
                          "credit_card_number": null,
                          "credit_card_reference": null,
                          "credit_card_type": null,
                          "tax_number_validated_at": null,
                          "tax_number_valid": null,
                          "invoice_workflow_id": null,
                          "estimate_workflow_id": null,
                          "si_identifier": null,
                          "si_identifier_type": null,
                          "moneybird_payments_mandate": false,
                          "created_at": "2026-11-02T12:16:07.345Z",
                          "updated_at": "2026-11-02T12:16:07.345Z",
                          "version": 1793621767,
                          "sales_invoices_url": "https://moneybird.dev/123/sales_invoices/0000000000000000000000000000000000000000000000000000000000000001/all",
                          "notes": [],
                          "custom_fields": [],
                          "contact_people": [],
                          "archived": false
                        },
                        "contact_person_id": null,
                        "contact_person": null,
                        "invoice_id": "2026-0003",
                        "recurring_sales_invoice_id": null,
                        "subscription_id": null,
                        "workflow_id": "502689109097055375",
                        "document_style_id": "502689109280556185",
                        "identity_id": "502689108656653419",
                        "draft_id": null,
                        "state": "open",
                        "invoice_date": "2026-11-02",
                        "due_date": "2026-11-16",
                        "payment_conditions": "We verzoeken u vriendelijk het bovenstaande bedrag van {document.total_price} voor {document.due_date} te voldoen op onze bankrekening onder vermelding van de omschrijving {document.payment_reference}. Voor vragen kunt u contact opnemen per e-mail.",
                        "payment_reference": "RF730000000000000J7SKAVG4",
                        "short_payment_reference": "RF73J7SKAVG4",
                        "reference": "Project X",
                        "language": "nl",
                        "currency": "EUR",
                        "discount": "0.0",
                        "original_sales_invoice_id": null,
                        "paused": false,
                        "paid_at": null,
                        "sent_at": "2026-11-02",
                        "created_at": "2026-11-02T12:16:07.624Z",
                        "updated_at": "2026-11-02T12:16:07.692Z",
                        "public_view_code": "362730",
                        "public_view_code_expires_at": "2027-02-02T12:16:07.664Z",
                        "version": 1793621767,
                        "details": [
                          {
                            "id": "502689165115131900",
                            "administration_id": 123,
                            "tax_rate_id": "502689108899923082",
                            "ledger_account_id": "502689108787725434",
                            "project_id": null,
                            "product_id": null,
                            "amount": "1 x",
                            "amount_decimal": "1.0",
                            "description": "Project X",
                            "price": "300.0",
                            "period": null,
                            "row_order": 1,
                            "total_price_excl_tax_with_discount": "300.0",
                            "total_price_excl_tax_with_discount_base": "300.0",
                            "tax_report_reference": [
                              "NL/1a"
                            ],
                            "mandatory_tax_text": null,
                            "created_at": "2026-11-02T12:16:07.626Z",
                            "updated_at": "2026-11-02T12:16:07.691Z"
                          }
                        ],
                        "payments": [],
                        "total_paid": "0.0",
                        "total_unpaid": "363.0",
                        "total_unpaid_base": "363.0",
                        "prices_are_incl_tax": false,
                        "total_price_excl_tax": "300.0",
                        "total_price_excl_tax_base": "300.0",
                        "total_price_incl_tax": "363.0",
                        "total_price_incl_tax_base": "363.0",
                        "total_discount": "0.0",
                        "marked_dubious_on": null,
                        "marked_uncollectible_on": null,
                        "reminder_count": 0,
                        "next_reminder": "2026-11-16",
                        "original_estimate_id": null,
                        "url": "http://moneybird.dev/123/external/0000000000000000000000000000000000000000000000000000000000000001/049ab5bd8f3c649861df60e80a0ca7d098ef6e3697b280033703bbe3d82a050f/sales_invoice",
                        "payment_url": "http://moneybird.dev/123/external/0000000000000000000000000000000000000000000000000000000000000001/049ab5bd8f3c649861df60e80a0ca7d098ef6e3697b280033703bbe3d82a050f/sales_invoice",
                        "custom_fields": [],
                        "notes": [],
                        "attachments": [],
                        "events": [
                          {
                            "administration_id": 123,
                            "user_id": "502689108256097381",
                            "action": "sales_invoice_created",
                            "link_entity_id": null,
                            "link_entity_type": null,
                            "data": {},
                            "created_at": "2026-11-02T12:16:07.629Z",
                            "updated_at": "2026-11-02T12:16:07.629Z"
                          },
                          {
                            "administration_id": 123,
                            "user_id": "502689108256097381",
                            "action": "sales_invoice_state_changed_to_open",
                            "link_entity_id": null,
                            "link_entity_type": null,
                            "data": {},
                            "created_at": "2026-11-02T12:16:07.674Z",
                            "updated_at": "2026-11-02T12:16:07.674Z"
                          },
                          {
                            "administration_id": 123,
                            "user_id": "502689108256097381",
                            "action": "sales_invoice_send_email",
                            "link_entity_id": null,
                            "link_entity_type": null,
                            "data": {
                              "email_address": "info@example.com",
                              "email_message": "Geachte Foobar Holding B.V.,\n\nIn de bijlage kunt u factuur 2026-0003 voor onze diensten vinden. Wij verzoeken u vriendelijk de factuur voor 16-11-2026 te voldoen.\n\nMet vriendelijke groet,\n\nParkietje B.V."
                            },
                            "created_at": "2026-11-02T12:16:07.706Z",
                            "updated_at": "2026-11-02T12:16:07.706Z"
                          }
                        ],
                        "tax_totals": [
                          {
                            "tax_rate_id": "502689108899923082",
                            "taxable_amount": "300.0",
                            "taxable_amount_base": "300.0",
                            "tax_amount": "63.0",
                            "tax_amount_base": "63.0"
                          }
                        ],
                        "time_entries": []
                      },
                      {
                        "id": "502689164986157036",
                        "administration_id": 123,
                        "contact_id": "502689164820482007",
                        "contact": {
                          "id": "502689164820482007",
                          "administration_id": 123,
                          "company_name": "Foobar Holding B.V.",
                          "firstname": null,
                          "lastname": null,
                          "address1": "Hoofdstraat 12",
                          "address2": null,
                          "zipcode": "1234AB",
                          "city": "Amsterdam",
                          "country": "NL",
                          "phone": null,
                          "delivery_method": "Email",
                          "customer_id": "customer-1",
                          "tax_number": null,
                          "chamber_of_commerce": null,
                          "bank_account": null,
                          "is_trusted": false,
                          "max_transfer_amount": null,
                          "attention": null,
                          "email": "info@example.com",
                          "email_ubl": true,
                          "send_invoices_to_attention": null,
                          "send_invoices_to_email": "info@example.com",
                          "send_estimates_to_attention": null,
                          "send_estimates_to_email": "info@example.com",
                          "direct_debit": false,
                          "sepa_active": false,
                          "sepa_iban": null,
                          "sepa_iban_account_name": null,
                          "sepa_bic": null,
                          "sepa_mandate_id": null,
                          "sepa_mandate_date": null,
                          "sepa_sequence_type": "RCUR",
                          "credit_card_number": null,
                          "credit_card_reference": null,
                          "credit_card_type": null,
                          "tax_number_validated_at": null,
                          "tax_number_valid": null,
                          "invoice_workflow_id": null,
                          "estimate_workflow_id": null,
                          "si_identifier": null,
                          "si_identifier_type": null,
                          "moneybird_payments_mandate": false,
                          "created_at": "2026-11-02T12:16:07.345Z",
                          "updated_at": "2026-11-02T12:16:07.345Z",
                          "version": 1793621767,
                          "sales_invoices_url": "https://moneybird.dev/123/sales_invoices/0000000000000000000000000000000000000000000000000000000000000001/all",
                          "notes": [],
                          "custom_fields": [],
                          "contact_people": [],
                          "archived": false
                        },
                        "contact_person_id": null,
                        "contact_person": null,
                        "invoice_id": "2026-0002",
                        "recurring_sales_invoice_id": null,
                        "subscription_id": null,
                        "workflow_id": "502689109097055375",
                        "document_style_id": "502689109280556185",
                        "identity_id": "502689108656653419",
                        "draft_id": null,
                        "state": "open",
                        "invoice_date": "2026-11-02",
                        "due_date": "2026-11-16",
                        "payment_conditions": "We verzoeken u vriendelijk het bovenstaande bedrag van {document.total_price} voor {document.due_date} te voldoen op onze bankrekening onder vermelding van de omschrijving {document.payment_reference}. Voor vragen kunt u contact opnemen per e-mail.",
                        "payment_reference": "RF660000000000000MF76WVYR",
                        "short_payment_reference": "RF66MF76WVYR",
                        "reference": "Project X",
                        "language": "nl",
                        "currency": "EUR",
                        "discount": "0.0",
                        "original_sales_invoice_id": null,
                        "paused": false,
                        "paid_at": null,
                        "sent_at": "2026-11-02",
                        "created_at": "2026-11-02T12:16:07.503Z",
                        "updated_at": "2026-11-02T12:16:07.576Z",
                        "public_view_code": "628934",
                        "public_view_code_expires_at": "2027-02-02T12:16:07.547Z",
                        "version": 1793621767,
                        "details": [
                          {
                            "id": "502689164989302765",
                            "administration_id": 123,
                            "tax_rate_id": "502689108899923082",
                            "ledger_account_id": "502689108787725434",
                            "project_id": null,
                            "product_id": null,
                            "amount": "1 x",
                            "amount_decimal": "1.0",
                            "description": "Project X",
                            "price": "300.0",
                            "period": null,
                            "row_order": 1,
                            "total_price_excl_tax_with_discount": "300.0",
                            "total_price_excl_tax_with_discount_base": "300.0",
                            "tax_report_reference": [
                              "NL/1a"
                            ],
                            "mandatory_tax_text": null,
                            "created_at": "2026-11-02T12:16:07.506Z",
                            "updated_at": "2026-11-02T12:16:07.575Z"
                          }
                        ],
                        "payments": [],
                        "total_paid": "0.0",
                        "total_unpaid": "363.0",
                        "total_unpaid_base": "363.0",
                        "prices_are_incl_tax": false,
                        "total_price_excl_tax": "300.0",
                        "total_price_excl_tax_base": "300.0",
                        "total_price_incl_tax": "363.0",
                        "total_price_incl_tax_base": "363.0",
                        "total_discount": "0.0",
                        "marked_dubious_on": null,
                        "marked_uncollectible_on": null,
                        "reminder_count": 0,
                        "next_reminder": "2026-11-16",
                        "original_estimate_id": null,
                        "url": "http://moneybird.dev/123/external/0000000000000000000000000000000000000000000000000000000000000001/2fa112dbd57b0156ab2cde4480fd29c737a6d73096c99172fd0e9e444a342901/sales_invoice",
                        "payment_url": "http://moneybird.dev/123/external/0000000000000000000000000000000000000000000000000000000000000001/2fa112dbd57b0156ab2cde4480fd29c737a6d73096c99172fd0e9e444a342901/sales_invoice",
                        "custom_fields": [],
                        "notes": [],
                        "attachments": [],
                        "events": [
                          {
                            "administration_id": 123,
                            "user_id": "502689108256097381",
                            "action": "sales_invoice_created",
                            "link_entity_id": null,
                            "link_entity_type": null,
                            "data": {},
                            "created_at": "2026-11-02T12:16:07.509Z",
                            "updated_at": "2026-11-02T12:16:07.509Z"
                          },
                          {
                            "administration_id": 123,
                            "user_id": "502689108256097381",
                            "action": "sales_invoice_state_changed_to_open",
                            "link_entity_id": null,
                            "link_entity_type": null,
                            "data": {},
                            "created_at": "2026-11-02T12:16:07.558Z",
                            "updated_at": "2026-11-02T12:16:07.558Z"
                          },
                          {
                            "administration_id": 123,
                            "user_id": "502689108256097381",
                            "action": "sales_invoice_send_email",
                            "link_entity_id": null,
                            "link_entity_type": null,
                            "data": {
                              "email_address": "info@example.com",
                              "email_message": "Geachte Foobar Holding B.V.,\n\nIn de bijlage kunt u factuur 2026-0002 voor onze diensten vinden. Wij verzoeken u vriendelijk de factuur voor 16-11-2026 te voldoen.\n\nMet vriendelijke groet,\n\nParkietje B.V."
                            },
                            "created_at": "2026-11-02T12:16:07.590Z",
                            "updated_at": "2026-11-02T12:16:07.590Z"
                          }
                        ],
                        "tax_totals": [
                          {
                            "tax_rate_id": "502689108899923082",
                            "taxable_amount": "300.0",
                            "taxable_amount_base": "300.0",
                            "tax_amount": "63.0",
                            "tax_amount_base": "63.0"
                          }
                        ],
                        "time_entries": []
                      },
                      {
                        "id": "502689164855085020",
                        "administration_id": 123,
                        "contact_id": "502689164820482007",
                        "contact": {
                          "id": "502689164820482007",
                          "administration_id": 123,
                          "company_name": "Foobar Holding B.V.",
                          "firstname": null,
                          "lastname": null,
                          "address1": "Hoofdstraat 12",
                          "address2": null,
                          "zipcode": "1234AB",
                          "city": "Amsterdam",
                          "country": "NL",
                          "phone": null,
                          "delivery_method": "Email",
                          "customer_id": "customer-1",
                          "tax_number": null,
                          "chamber_of_commerce": null,
                          "bank_account": null,
                          "is_trusted": false,
                          "max_transfer_amount": null,
                          "attention": null,
                          "email": "info@example.com",
                          "email_ubl": true,
                          "send_invoices_to_attention": null,
                          "send_invoices_to_email": "info@example.com",
                          "send_estimates_to_attention": null,
                          "send_estimates_to_email": "info@example.com",
                          "direct_debit": false,
                          "sepa_active": false,
                          "sepa_iban": null,
                          "sepa_iban_account_name": null,
                          "sepa_bic": null,
                          "sepa_mandate_id": null,
                          "sepa_mandate_date": null,
                          "sepa_sequence_type": "RCUR",
                          "credit_card_number": null,
                          "credit_card_reference": null,
                          "credit_card_type": null,
                          "tax_number_validated_at": null,
                          "tax_number_valid": null,
                          "invoice_workflow_id": null,
                          "estimate_workflow_id": null,
                          "si_identifier": null,
                          "si_identifier_type": null,
                          "moneybird_payments_mandate": false,
                          "created_at": "2026-11-02T12:16:07.345Z",
                          "updated_at": "2026-11-02T12:16:07.345Z",
                          "version": 1793621767,
                          "sales_invoices_url": "https://moneybird.dev/123/sales_invoices/0000000000000000000000000000000000000000000000000000000000000001/all",
                          "notes": [],
                          "custom_fields": [],
                          "contact_people": [],
                          "archived": false
                        },
                        "contact_person_id": "502689164824676313",
                        "contact_person": {
                          "id": null,
                          "contact_id": "502689164820482007",
                          "administration_id": 123,
                          "firstname": "Jan",
                          "lastname": "Janssen",
                          "phone": "123-456-2346",
                          "email": "janjanssen@dev.null.moneybird.net",
                          "department": "Sales",
                          "created_at": "2026-11-02T12:16:07.349Z",
                          "updated_at": "2026-11-02T12:16:07.349Z",
                          "version": 1793621767
                        },
                        "invoice_id": "2026-0001",
                        "recurring_sales_invoice_id": null,
                        "subscription_id": null,
                        "workflow_id": "502689109097055375",
                        "document_style_id": "502689109280556185",
                        "identity_id": "502689108656653419",
                        "draft_id": null,
                        "state": "open",
                        "invoice_date": "2026-11-02",
                        "due_date": "2026-11-16",
                        "payment_conditions": "We verzoeken u vriendelijk het bovenstaande bedrag van {document.total_price} voor {document.due_date} te voldoen op onze bankrekening onder vermelding van de omschrijving {document.payment_reference}. Voor vragen kunt u contact opnemen per e-mail.",
                        "payment_reference": "RF810000000000000EMYSNNAV",
                        "short_payment_reference": "RF81EMYSNNAV",
                        "reference": "Project X",
                        "language": "nl",
                        "currency": "EUR",
                        "discount": "0.0",
                        "original_sales_invoice_id": null,
                        "paused": false,
                        "paid_at": null,
                        "sent_at": "2026-11-02",
                        "created_at": "2026-11-02T12:16:07.378Z",
                        "updated_at": "2026-11-02T12:16:07.443Z",
                        "public_view_code": "289102",
                        "public_view_code_expires_at": "2027-02-02T12:16:07.415Z",
                        "version": 1793621767,
                        "details": [
                          {
                            "id": "502689164858230749",
                            "administration_id": 123,
                            "tax_rate_id": "502689108899923082",
                            "ledger_account_id": "502689108787725434",
                            "project_id": null,
                            "product_id": null,
                            "amount": "1 x",
                            "amount_decimal": "1.0",
                            "description": "Project X",
                            "price": "300.0",
                            "period": "20261101..20261130",
                            "row_order": 1,
                            "total_price_excl_tax_with_discount": "300.0",
                            "total_price_excl_tax_with_discount_base": "300.0",
                            "tax_report_reference": [
                              "NL/1a"
                            ],
                            "mandatory_tax_text": null,
                            "created_at": "2026-11-02T12:16:07.381Z",
                            "updated_at": "2026-11-02T12:16:07.442Z"
                          }
                        ],
                        "payments": [],
                        "total_paid": "0.0",
                        "total_unpaid": "363.0",
                        "total_unpaid_base": "363.0",
                        "prices_are_incl_tax": false,
                        "total_price_excl_tax": "300.0",
                        "total_price_excl_tax_base": "300.0",
                        "total_price_incl_tax": "363.0",
                        "total_price_incl_tax_base": "363.0",
                        "total_discount": "0.0",
                        "marked_dubious_on": null,
                        "marked_uncollectible_on": null,
                        "reminder_count": 0,
                        "next_reminder": "2026-11-16",
                        "original_estimate_id": null,
                        "url": "http://moneybird.dev/123/external/0000000000000000000000000000000000000000000000000000000000000001/3820c33363982d11ec7ae58aa3e0b5e3bf7168b7fffef214754171a881610f43/sales_invoice",
                        "payment_url": "http://moneybird.dev/123/external/0000000000000000000000000000000000000000000000000000000000000001/3820c33363982d11ec7ae58aa3e0b5e3bf7168b7fffef214754171a881610f43/sales_invoice",
                        "custom_fields": [],
                        "notes": [],
                        "attachments": [],
                        "events": [
                          {
                            "administration_id": 123,
                            "user_id": "502689108256097381",
                            "action": "sales_invoice_created",
                            "link_entity_id": null,
                            "link_entity_type": null,
                            "data": {},
                            "created_at": "2026-11-02T12:16:07.384Z",
                            "updated_at": "2026-11-02T12:16:07.384Z"
                          },
                          {
                            "administration_id": 123,
                            "user_id": "502689108256097381",
                            "action": "sales_invoice_state_changed_to_open",
                            "link_entity_id": null,
                            "link_entity_type": null,
                            "data": {},
                            "created_at": "2026-11-02T12:16:07.423Z",
                            "updated_at": "2026-11-02T12:16:07.423Z"
                          },
                          {
                            "administration_id": 123,
                            "user_id": "502689108256097381",
                            "action": "sales_invoice_send_email",
                            "link_entity_id": null,
                            "link_entity_type": null,
                            "data": {
                              "email_address": "info@example.com; janjanssen@dev.null.moneybird.net",
                              "email_message": "Geachte Jan Janssen,\n\nIn de bijlage kunt u factuur 2026-0001 voor onze diensten vinden. Wij verzoeken u vriendelijk de factuur voor 16-11-2026 te voldoen.\n\nMet vriendelijke groet,\n\nParkietje B.V."
                            },
                            "created_at": "2026-11-02T12:16:07.462Z",
                            "updated_at": "2026-11-02T12:16:07.462Z"
                          }
                        ],
                        "tax_totals": [
                          {
                            "tax_rate_id": "502689108899923082",
                            "taxable_amount": "300.0",
                            "taxable_amount_base": "300.0",
                            "tax_amount": "63.0",
                            "tax_amount_base": "63.0"
                          }
                        ],
                        "time_entries": []
                      }
                    ]
                  },
                  "ReturnsTheOldestInvoicesFirstWhenSortedByDateAscending": {
                    "summary": "Returns the oldest invoices first when sorted by date ascending",
                    "value": [
                      {
                        "id": "502689165612155968",
                        "administration_id": 123,
                        "contact_id": "502689165598524479",
                        "contact": {
                          "id": "502689165598524479",
                          "administration_id": 123,
                          "company_name": "Relation 1",
                          "firstname": null,
                          "lastname": null,
                          "address1": null,
                          "address2": null,
                          "zipcode": null,
                          "city": null,
                          "country": "NL",
                          "phone": null,
                          "delivery_method": "Email",
                          "customer_id": "customer-2",
                          "tax_number": null,
                          "chamber_of_commerce": null,
                          "bank_account": null,
                          "is_trusted": false,
                          "max_transfer_amount": null,
                          "attention": null,
                          "email": "invoices@example.com",
                          "email_ubl": false,
                          "send_invoices_to_attention": null,
                          "send_invoices_to_email": "invoices@example.com",
                          "send_estimates_to_attention": null,
                          "send_estimates_to_email": "estimates@example.com",
                          "direct_debit": false,
                          "sepa_active": false,
                          "sepa_iban": null,
                          "sepa_iban_account_name": null,
                          "sepa_bic": null,
                          "sepa_mandate_id": null,
                          "sepa_mandate_date": null,
                          "sepa_sequence_type": "RCUR",
                          "credit_card_number": null,
                          "credit_card_reference": null,
                          "credit_card_type": null,
                          "tax_number_validated_at": null,
                          "tax_number_valid": null,
                          "invoice_workflow_id": null,
                          "estimate_workflow_id": null,
                          "si_identifier": null,
                          "si_identifier_type": null,
                          "moneybird_payments_mandate": false,
                          "created_at": "2026-11-02T12:16:08.087Z",
                          "updated_at": "2026-11-02T12:16:08.087Z",
                          "version": 1793621768,
                          "sales_invoices_url": "https://moneybird.dev/123/sales_invoices/0000000000000000000000000000000000000000000000000000000000000002/all",
                          "notes": [],
                          "custom_fields": [],
                          "contact_people": [],
                          "archived": false
                        },
                        "contact_person_id": null,
                        "contact_person": null,
                        "invoice_id": "2026-1",
                        "recurring_sales_invoice_id": null,
                        "subscription_id": null,
                        "workflow_id": "502689109097055375",
                        "document_style_id": "502689109280556185",
                        "identity_id": "502689108656653419",
                        "draft_id": null,
                        "state": "open",
                        "invoice_date": "2025-11-02",
                        "due_date": "2025-11-16",
                        "payment_conditions": null,
                        "payment_reference": "RF74000000000000000000001",
                        "short_payment_reference": "RF741",
                        "reference": "Project X",
                        "language": "nl",
                        "currency": "EUR",
                        "discount": "0.0",
                        "original_sales_invoice_id": null,
                        "paused": false,
                        "paid_at": null,
                        "sent_at": "2026-11-02",
                        "created_at": "2026-11-02T12:16:08.100Z",
                        "updated_at": "2026-11-02T12:16:08.103Z",
                        "public_view_code": "2026-1",
                        "public_view_code_expires_at": null,
                        "version": 1793621768,
                        "details": [
                          {
                            "id": "502689165614253121",
                            "administration_id": 123,
                            "tax_rate_id": "502689108899923082",
                            "ledger_account_id": "502689108787725434",
                            "project_id": null,
                            "product_id": null,
                            "amount": "1 x",
                            "amount_decimal": "1.0",
                            "description": "Invoice detail description",
                            "price": "100.0",
                            "period": null,
                            "row_order": 0,
                            "total_price_excl_tax_with_discount": "100.0",
                            "total_price_excl_tax_with_discount_base": "100.0",
                            "tax_report_reference": [],
                            "mandatory_tax_text": null,
                            "created_at": "2026-11-02T12:16:08.102Z",
                            "updated_at": "2026-11-02T12:16:08.102Z"
                          }
                        ],
                        "payments": [],
                        "total_paid": "0.0",
                        "total_unpaid": "121.0",
                        "total_unpaid_base": "121.0",
                        "prices_are_incl_tax": false,
                        "total_price_excl_tax": "100.0",
                        "total_price_excl_tax_base": "100.0",
                        "total_price_incl_tax": "121.0",
                        "total_price_incl_tax_base": "121.0",
                        "total_discount": "0.0",
                        "marked_dubious_on": null,
                        "marked_uncollectible_on": null,
                        "reminder_count": 0,
                        "next_reminder": "2026-11-16",
                        "original_estimate_id": null,
                        "url": "http://moneybird.dev/123/external/0000000000000000000000000000000000000000000000000000000000000002/a351a7268cbd32a668c67809bf616414f7057d085808226b6b081c8444756044/sales_invoice",
                        "payment_url": "http://moneybird.dev/123/external/0000000000000000000000000000000000000000000000000000000000000002/a351a7268cbd32a668c67809bf616414f7057d085808226b6b081c8444756044/sales_invoice",
                        "custom_fields": [],
                        "notes": [],
                        "attachments": [],
                        "events": [],
                        "tax_totals": [
                          {
                            "tax_rate_id": "502689108899923082",
                            "taxable_amount": "100.0",
                            "taxable_amount_base": "100.0",
                            "tax_amount": "21.0",
                            "tax_amount_base": "21.0"
                          }
                        ],
                        "time_entries": []
                      },
                      {
                        "id": "502689165295485968",
                        "administration_id": 123,
                        "contact_id": "502689165265077259",
                        "contact": {
                          "id": "502689165265077259",
                          "administration_id": 123,
                          "company_name": "Foobar Holding B.V.",
                          "firstname": null,
                          "lastname": null,
                          "address1": "Hoofdstraat 12",
                          "address2": null,
                          "zipcode": "1234AB",
                          "city": "Amsterdam",
                          "country": "NL",
                          "phone": null,
                          "delivery_method": "Email",
                          "customer_id": "customer-1",
                          "tax_number": null,
                          "chamber_of_commerce": null,
                          "bank_account": null,
                          "is_trusted": false,
                          "max_transfer_amount": null,
                          "attention": null,
                          "email": "info@example.com",
                          "email_ubl": true,
                          "send_invoices_to_attention": null,
                          "send_invoices_to_email": "info@example.com",
                          "send_estimates_to_attention": null,
                          "send_estimates_to_email": "info@example.com",
                          "direct_debit": false,
                          "sepa_active": false,
                          "sepa_iban": null,
                          "sepa_iban_account_name": null,
                          "sepa_bic": null,
                          "sepa_mandate_id": null,
                          "sepa_mandate_date": null,
                          "sepa_sequence_type": "RCUR",
                          "credit_card_number": null,
                          "credit_card_reference": null,
                          "credit_card_type": null,
                          "tax_number_validated_at": null,
                          "tax_number_valid": null,
                          "invoice_workflow_id": null,
                          "estimate_workflow_id": null,
                          "si_identifier": null,
                          "si_identifier_type": null,
                          "moneybird_payments_mandate": false,
                          "created_at": "2026-11-02T12:16:07.769Z",
                          "updated_at": "2026-11-02T12:16:07.769Z",
                          "version": 1793621767,
                          "sales_invoices_url": "https://moneybird.dev/123/sales_invoices/0000000000000000000000000000000000000000000000000000000000000001/all",
                          "notes": [],
                          "custom_fields": [],
                          "contact_people": [],
                          "archived": false
                        },
                        "contact_person_id": "502689165268222989",
                        "contact_person": {
                          "id": null,
                          "contact_id": "502689165265077259",
                          "administration_id": 123,
                          "firstname": "Jan",
                          "lastname": "Janssen",
                          "phone": "123-456-2346",
                          "email": "janjanssen@dev.null.moneybird.net",
                          "department": "Sales",
                          "created_at": "2026-11-02T12:16:07.773Z",
                          "updated_at": "2026-11-02T12:16:07.773Z",
                          "version": 1793621767
                        },
                        "invoice_id": "2026-0001",
                        "recurring_sales_invoice_id": null,
                        "subscription_id": null,
                        "workflow_id": "502689109097055375",
                        "document_style_id": "502689109280556185",
                        "identity_id": "502689108656653419",
                        "draft_id": null,
                        "state": "open",
                        "invoice_date": "2026-11-02",
                        "due_date": "2026-11-16",
                        "payment_conditions": "We verzoeken u vriendelijk het bovenstaande bedrag van {document.total_price} voor {document.due_date} te voldoen op onze bankrekening onder vermelding van de omschrijving {document.payment_reference}. Voor vragen kunt u contact opnemen per e-mail.",
                        "payment_reference": "RF22000000000000055NKARN9",
                        "short_payment_reference": "RF2255NKARN9",
                        "reference": "Project X",
                        "language": "nl",
                        "currency": "EUR",
                        "discount": "0.0",
                        "original_sales_invoice_id": null,
                        "paused": false,
                        "paid_at": null,
                        "sent_at": "2026-11-02",
                        "created_at": "2026-11-02T12:16:07.798Z",
                        "updated_at": "2026-11-02T12:16:07.867Z",
                        "public_view_code": "637867",
                        "public_view_code_expires_at": "2027-02-02T12:16:07.841Z",
                        "version": 1793621767,
                        "details": [
                          {
                            "id": "502689165298631697",
                            "administration_id": 123,
                            "tax_rate_id": "502689108899923082",
                            "ledger_account_id": "502689108787725434",
                            "project_id": null,
                            "product_id": null,
                            "amount": "1 x",
                            "amount_decimal": "1.0",
                            "description": "Project X",
                            "price": "300.0",
                            "period": "20261101..20261130",
                            "row_order": 1,
                            "total_price_excl_tax_with_discount": "300.0",
                            "total_price_excl_tax_with_discount_base": "300.0",
                            "tax_report_reference": [
                              "NL/1a"
                            ],
                            "mandatory_tax_text": null,
                            "created_at": "2026-11-02T12:16:07.801Z",
                            "updated_at": "2026-11-02T12:16:07.866Z"
                          }
                        ],
                        "payments": [],
                        "total_paid": "0.0",
                        "total_unpaid": "363.0",
                        "total_unpaid_base": "363.0",
                        "prices_are_incl_tax": false,
                        "total_price_excl_tax": "300.0",
                        "total_price_excl_tax_base": "300.0",
                        "total_price_incl_tax": "363.0",
                        "total_price_incl_tax_base": "363.0",
                        "total_discount": "0.0",
                        "marked_dubious_on": null,
                        "marked_uncollectible_on": null,
                        "reminder_count": 0,
                        "next_reminder": "2026-11-16",
                        "original_estimate_id": null,
                        "url": "http://moneybird.dev/123/external/0000000000000000000000000000000000000000000000000000000000000001/1171e93e69e314b88a6d49785aae5b3b32eb7da769b03981e898da04c5746b55/sales_invoice",
                        "payment_url": "http://moneybird.dev/123/external/0000000000000000000000000000000000000000000000000000000000000001/1171e93e69e314b88a6d49785aae5b3b32eb7da769b03981e898da04c5746b55/sales_invoice",
                        "custom_fields": [],
                        "notes": [],
                        "attachments": [],
                        "events": [
                          {
                            "administration_id": 123,
                            "user_id": "502689108256097381",
                            "action": "sales_invoice_created",
                            "link_entity_id": null,
                            "link_entity_type": null,
                            "data": {},
                            "created_at": "2026-11-02T12:16:07.805Z",
                            "updated_at": "2026-11-02T12:16:07.805Z"
                          },
                          {
                            "administration_id": 123,
                            "user_id": "502689108256097381",
                            "action": "sales_invoice_state_changed_to_open",
                            "link_entity_id": null,
                            "link_entity_type": null,
                            "data": {},
                            "created_at": "2026-11-02T12:16:07.851Z",
                            "updated_at": "2026-11-02T12:16:07.851Z"
                          },
                          {
                            "administration_id": 123,
                            "user_id": "502689108256097381",
                            "action": "sales_invoice_send_email",
                            "link_entity_id": null,
                            "link_entity_type": null,
                            "data": {
                              "email_address": "info@example.com; janjanssen@dev.null.moneybird.net",
                              "email_message": "Geachte Jan Janssen,\n\nIn de bijlage kunt u factuur 2026-0001 voor onze diensten vinden. Wij verzoeken u vriendelijk de factuur voor 16-11-2026 te voldoen.\n\nMet vriendelijke groet,\n\nParkietje B.V."
                            },
                            "created_at": "2026-11-02T12:16:07.881Z",
                            "updated_at": "2026-11-02T12:16:07.881Z"
                          }
                        ],
                        "tax_totals": [
                          {
                            "tax_rate_id": "502689108899923082",
                            "taxable_amount": "300.0",
                            "taxable_amount_base": "300.0",
                            "tax_amount": "63.0",
                            "tax_amount_base": "63.0"
                          }
                        ],
                        "time_entries": []
                      },
                      {
                        "id": "502689165415023648",
                        "administration_id": 123,
                        "contact_id": "502689165265077259",
                        "contact": {
                          "id": "502689165265077259",
                          "administration_id": 123,
                          "company_name": "Foobar Holding B.V.",
                          "firstname": null,
                          "lastname": null,
                          "address1": "Hoofdstraat 12",
                          "address2": null,
                          "zipcode": "1234AB",
                          "city": "Amsterdam",
                          "country": "NL",
                          "phone": null,
                          "delivery_method": "Email",
                          "customer_id": "customer-1",
                          "tax_number": null,
                          "chamber_of_commerce": null,
                          "bank_account": null,
                          "is_trusted": false,
                          "max_transfer_amount": null,
                          "attention": null,
                          "email": "info@example.com",
                          "email_ubl": true,
                          "send_invoices_to_attention": null,
                          "send_invoices_to_email": "info@example.com",
                          "send_estimates_to_attention": null,
                          "send_estimates_to_email": "info@example.com",
                          "direct_debit": false,
                          "sepa_active": false,
                          "sepa_iban": null,
                          "sepa_iban_account_name": null,
                          "sepa_bic": null,
                          "sepa_mandate_id": null,
                          "sepa_mandate_date": null,
                          "sepa_sequence_type": "RCUR",
                          "credit_card_number": null,
                          "credit_card_reference": null,
                          "credit_card_type": null,
                          "tax_number_validated_at": null,
                          "tax_number_valid": null,
                          "invoice_workflow_id": null,
                          "estimate_workflow_id": null,
                          "si_identifier": null,
                          "si_identifier_type": null,
                          "moneybird_payments_mandate": false,
                          "created_at": "2026-11-02T12:16:07.769Z",
                          "updated_at": "2026-11-02T12:16:07.769Z",
                          "version": 1793621767,
                          "sales_invoices_url": "https://moneybird.dev/123/sales_invoices/0000000000000000000000000000000000000000000000000000000000000001/all",
                          "notes": [],
                          "custom_fields": [],
                          "contact_people": [],
                          "archived": false
                        },
                        "contact_person_id": null,
                        "contact_person": null,
                        "invoice_id": "2026-0002",
                        "recurring_sales_invoice_id": null,
                        "subscription_id": null,
                        "workflow_id": "502689109097055375",
                        "document_style_id": "502689109280556185",
                        "identity_id": "502689108656653419",
                        "draft_id": null,
                        "state": "open",
                        "invoice_date": "2026-11-02",
                        "due_date": "2026-11-16",
                        "payment_conditions": "We verzoeken u vriendelijk het bovenstaande bedrag van {document.total_price} voor {document.due_date} te voldoen op onze bankrekening onder vermelding van de omschrijving {document.payment_reference}. Voor vragen kunt u contact opnemen per e-mail.",
                        "payment_reference": "RF490000000000000S5CUVK3K",
                        "short_payment_reference": "RF49S5CUVK3K",
                        "reference": "Project X",
                        "language": "nl",
                        "currency": "EUR",
                        "discount": "0.0",
                        "original_sales_invoice_id": null,
                        "paused": false,
                        "paid_at": null,
                        "sent_at": "2026-11-02",
                        "created_at": "2026-11-02T12:16:07.912Z",
                        "updated_at": "2026-11-02T12:16:07.966Z",
                        "public_view_code": "466528",
                        "public_view_code_expires_at": "2027-02-02T12:16:07.944Z",
                        "version": 1793621767,
                        "details": [
                          {
                            "id": "502689165417120801",
                            "administration_id": 123,
                            "tax_rate_id": "502689108899923082",
                            "ledger_account_id": "502689108787725434",
                            "project_id": null,
                            "product_id": null,
                            "amount": "1 x",
                            "amount_decimal": "1.0",
                            "description": "Project X",
                            "price": "300.0",
                            "period": null,
                            "row_order": 1,
                            "total_price_excl_tax_with_discount": "300.0",
                            "total_price_excl_tax_with_discount_base": "300.0",
                            "tax_report_reference": [
                              "NL/1a"
                            ],
                            "mandatory_tax_text": null,
                            "created_at": "2026-11-02T12:16:07.914Z",
                            "updated_at": "2026-11-02T12:16:07.965Z"
                          }
                        ],
                        "payments": [],
                        "total_paid": "0.0",
                        "total_unpaid": "363.0",
                        "total_unpaid_base": "363.0",
                        "prices_are_incl_tax": false,
                        "total_price_excl_tax": "300.0",
                        "total_price_excl_tax_base": "300.0",
                        "total_price_incl_tax": "363.0",
                        "total_price_incl_tax_base": "363.0",
                        "total_discount": "0.0",
                        "marked_dubious_on": null,
                        "marked_uncollectible_on": null,
                        "reminder_count": 0,
                        "next_reminder": "2026-11-16",
                        "original_estimate_id": null,
                        "url": "http://moneybird.dev/123/external/0000000000000000000000000000000000000000000000000000000000000001/221231d2e433f8eecc518ef5e775f784b39409ea9e0738b4ea44e5157dce814b/sales_invoice",
                        "payment_url": "http://moneybird.dev/123/external/0000000000000000000000000000000000000000000000000000000000000001/221231d2e433f8eecc518ef5e775f784b39409ea9e0738b4ea44e5157dce814b/sales_invoice",
                        "custom_fields": [],
                        "notes": [],
                        "attachments": [],
                        "events": [
                          {
                            "administration_id": 123,
                            "user_id": "502689108256097381",
                            "action": "sales_invoice_created",
                            "link_entity_id": null,
                            "link_entity_type": null,
                            "data": {},
                            "created_at": "2026-11-02T12:16:07.917Z",
                            "updated_at": "2026-11-02T12:16:07.917Z"
                          },
                          {
                            "administration_id": 123,
                            "user_id": "502689108256097381",
                            "action": "sales_invoice_state_changed_to_open",
                            "link_entity_id": null,
                            "link_entity_type": null,
                            "data": {},
                            "created_at": "2026-11-02T12:16:07.951Z",
                            "updated_at": "2026-11-02T12:16:07.951Z"
                          },
                          {
                            "administration_id": 123,
                            "user_id": "502689108256097381",
                            "action": "sales_invoice_send_email",
                            "link_entity_id": null,
                            "link_entity_type": null,
                            "data": {
                              "email_address": "info@example.com",
                              "email_message": "Geachte Foobar Holding B.V.,\n\nIn de bijlage kunt u factuur 2026-0002 voor onze diensten vinden. Wij verzoeken u vriendelijk de factuur voor 16-11-2026 te voldoen.\n\nMet vriendelijke groet,\n\nParkietje B.V."
                            },
                            "created_at": "2026-11-02T12:16:07.983Z",
                            "updated_at": "2026-11-02T12:16:07.983Z"
                          }
                        ],
                        "tax_totals": [
                          {
                            "tax_rate_id": "502689108899923082",
                            "taxable_amount": "300.0",
                            "taxable_amount_base": "300.0",
                            "tax_amount": "63.0",
                            "tax_amount_base": "63.0"
                          }
                        ],
                        "time_entries": []
                      },
                      {
                        "id": "502689165523026991",
                        "administration_id": 123,
                        "contact_id": "502689165265077259",
                        "contact": {
                          "id": "502689165265077259",
                          "administration_id": 123,
                          "company_name": "Foobar Holding B.V.",
                          "firstname": null,
                          "lastname": null,
                          "address1": "Hoofdstraat 12",
                          "address2": null,
                          "zipcode": "1234AB",
                          "city": "Amsterdam",
                          "country": "NL",
                          "phone": null,
                          "delivery_method": "Email",
                          "customer_id": "customer-1",
                          "tax_number": null,
                          "chamber_of_commerce": null,
                          "bank_account": null,
                          "is_trusted": false,
                          "max_transfer_amount": null,
                          "attention": null,
                          "email": "info@example.com",
                          "email_ubl": true,
                          "send_invoices_to_attention": null,
                          "send_invoices_to_email": "info@example.com",
                          "send_estimates_to_attention": null,
                          "send_estimates_to_email": "info@example.com",
                          "direct_debit": false,
                          "sepa_active": false,
                          "sepa_iban": null,
                          "sepa_iban_account_name": null,
                          "sepa_bic": null,
                          "sepa_mandate_id": null,
                          "sepa_mandate_date": null,
                          "sepa_sequence_type": "RCUR",
                          "credit_card_number": null,
                          "credit_card_reference": null,
                          "credit_card_type": null,
                          "tax_number_validated_at": null,
                          "tax_number_valid": null,
                          "invoice_workflow_id": null,
                          "estimate_workflow_id": null,
                          "si_identifier": null,
                          "si_identifier_type": null,
                          "moneybird_payments_mandate": false,
                          "created_at": "2026-11-02T12:16:07.769Z",
                          "updated_at": "2026-11-02T12:16:07.769Z",
                          "version": 1793621767,
                          "sales_invoices_url": "https://moneybird.dev/123/sales_invoices/0000000000000000000000000000000000000000000000000000000000000001/all",
                          "notes": [],
                          "custom_fields": [],
                          "contact_people": [],
                          "archived": false
                        },
                        "contact_person_id": null,
                        "contact_person": null,
                        "invoice_id": "2026-0003",
                        "recurring_sales_invoice_id": null,
                        "subscription_id": null,
                        "workflow_id": "502689109097055375",
                        "document_style_id": "502689109280556185",
                        "identity_id": "502689108656653419",
                        "draft_id": null,
                        "state": "open",
                        "invoice_date": "2026-11-02",
                        "due_date": "2026-11-16",
                        "payment_conditions": "We verzoeken u vriendelijk het bovenstaande bedrag van {document.total_price} voor {document.due_date} te voldoen op onze bankrekening onder vermelding van de omschrijving {document.payment_reference}. Voor vragen kunt u contact opnemen per e-mail.",
                        "payment_reference": "RF640000000000000RCPWXKDD",
                        "short_payment_reference": "RF64RCPWXKDD",
                        "reference": "Project X",
                        "language": "nl",
                        "currency": "EUR",
                        "discount": "0.0",
                        "original_sales_invoice_id": null,
                        "paused": false,
                        "paid_at": null,
                        "sent_at": "2026-11-02",
                        "created_at": "2026-11-02T12:16:08.015Z",
                        "updated_at": "2026-11-02T12:16:08.064Z",
                        "public_view_code": "774808",
                        "public_view_code_expires_at": "2027-02-02T12:16:08.044Z",
                        "version": 1793621768,
                        "details": [
                          {
                            "id": "502689165525124144",
                            "administration_id": 123,
                            "tax_rate_id": "502689108899923082",
                            "ledger_account_id": "502689108787725434",
                            "project_id": null,
                            "product_id": null,
                            "amount": "1 x",
                            "amount_decimal": "1.0",
                            "description": "Project X",
                            "price": "300.0",
                            "period": null,
                            "row_order": 1,
                            "total_price_excl_tax_with_discount": "300.0",
                            "total_price_excl_tax_with_discount_base": "300.0",
                            "tax_report_reference": [
                              "NL/1a"
                            ],
                            "mandatory_tax_text": null,
                            "created_at": "2026-11-02T12:16:08.017Z",
                            "updated_at": "2026-11-02T12:16:08.063Z"
                          }
                        ],
                        "payments": [],
                        "total_paid": "0.0",
                        "total_unpaid": "363.0",
                        "total_unpaid_base": "363.0",
                        "prices_are_incl_tax": false,
                        "total_price_excl_tax": "300.0",
                        "total_price_excl_tax_base": "300.0",
                        "total_price_incl_tax": "363.0",
                        "total_price_incl_tax_base": "363.0",
                        "total_discount": "0.0",
                        "marked_dubious_on": null,
                        "marked_uncollectible_on": null,
                        "reminder_count": 0,
                        "next_reminder": "2026-11-16",
                        "original_estimate_id": null,
                        "url": "http://moneybird.dev/123/external/0000000000000000000000000000000000000000000000000000000000000001/cc7da673fbcfbb01db2f59dfd46c12fb7b5871835d6e08ffba2b3bbf2144f588/sales_invoice",
                        "payment_url": "http://moneybird.dev/123/external/0000000000000000000000000000000000000000000000000000000000000001/cc7da673fbcfbb01db2f59dfd46c12fb7b5871835d6e08ffba2b3bbf2144f588/sales_invoice",
                        "custom_fields": [],
                        "notes": [],
                        "attachments": [],
                        "events": [
                          {
                            "administration_id": 123,
                            "user_id": "502689108256097381",
                            "action": "sales_invoice_created",
                            "link_entity_id": null,
                            "link_entity_type": null,
                            "data": {},
                            "created_at": "2026-11-02T12:16:08.019Z",
                            "updated_at": "2026-11-02T12:16:08.019Z"
                          },
                          {
                            "administration_id": 123,
                            "user_id": "502689108256097381",
                            "action": "sales_invoice_state_changed_to_open",
                            "link_entity_id": null,
                            "link_entity_type": null,
                            "data": {},
                            "created_at": "2026-11-02T12:16:08.051Z",
                            "updated_at": "2026-11-02T12:16:08.051Z"
                          },
                          {
                            "administration_id": 123,
                            "user_id": "502689108256097381",
                            "action": "sales_invoice_send_email",
                            "link_entity_id": null,
                            "link_entity_type": null,
                            "data": {
                              "email_address": "info@example.com",
                              "email_message": "Geachte Foobar Holding B.V.,\n\nIn de bijlage kunt u factuur 2026-0003 voor onze diensten vinden. Wij verzoeken u vriendelijk de factuur voor 16-11-2026 te voldoen.\n\nMet vriendelijke groet,\n\nParkietje B.V."
                            },
                            "created_at": "2026-11-02T12:16:08.074Z",
                            "updated_at": "2026-11-02T12:16:08.074Z"
                          }
                        ],
                        "tax_totals": [
                          {
                            "tax_rate_id": "502689108899923082",
                            "taxable_amount": "300.0",
                            "taxable_amount_base": "300.0",
                            "tax_amount": "63.0",
                            "tax_amount_base": "63.0"
                          }
                        ],
                        "time_entries": []
                      }
                    ]
                  },
                  "ReturnsOnlySalesInvoicesUpdatedAfterGivenDatetime": {
                    "summary": "Returns only sales invoices updated after given datetime",
                    "value": [
                      {
                        "id": "502689165774685257",
                        "administration_id": 123,
                        "contact_id": "502689165733790788",
                        "contact": {
                          "id": "502689165733790788",
                          "administration_id": 123,
                          "company_name": "Foobar Holding B.V.",
                          "firstname": null,
                          "lastname": null,
                          "address1": "Hoofdstraat 12",
                          "address2": null,
                          "zipcode": "1234AB",
                          "city": "Amsterdam",
                          "country": "NL",
                          "phone": null,
                          "delivery_method": "Email",
                          "customer_id": "customer-1",
                          "tax_number": null,
                          "chamber_of_commerce": null,
                          "bank_account": null,
                          "is_trusted": false,
                          "max_transfer_amount": null,
                          "attention": null,
                          "email": "info@example.com",
                          "email_ubl": true,
                          "send_invoices_to_attention": null,
                          "send_invoices_to_email": "info@example.com",
                          "send_estimates_to_attention": null,
                          "send_estimates_to_email": "info@example.com",
                          "direct_debit": false,
                          "sepa_active": false,
                          "sepa_iban": null,
                          "sepa_iban_account_name": null,
                          "sepa_bic": null,
                          "sepa_mandate_id": null,
                          "sepa_mandate_date": null,
                          "sepa_sequence_type": "RCUR",
                          "credit_card_number": null,
                          "credit_card_reference": null,
                          "credit_card_type": null,
                          "tax_number_validated_at": null,
                          "tax_number_valid": null,
                          "invoice_workflow_id": null,
                          "estimate_workflow_id": null,
                          "si_identifier": null,
                          "si_identifier_type": null,
                          "moneybird_payments_mandate": false,
                          "created_at": "2026-11-02T12:16:08.216Z",
                          "updated_at": "2026-11-02T12:16:08.216Z",
                          "version": 1793621768,
                          "sales_invoices_url": "https://moneybird.dev/123/sales_invoices/0000000000000000000000000000000000000000000000000000000000000001/all",
                          "notes": [],
                          "custom_fields": [],
                          "contact_people": [],
                          "archived": false
                        },
                        "contact_person_id": "502689165737985094",
                        "contact_person": {
                          "id": null,
                          "contact_id": "502689165733790788",
                          "administration_id": 123,
                          "firstname": "Jan",
                          "lastname": "Janssen",
                          "phone": "123-456-2346",
                          "email": "janjanssen@dev.null.moneybird.net",
                          "department": "Sales",
                          "created_at": "2026-11-02T12:16:08.221Z",
                          "updated_at": "2026-11-02T12:16:08.221Z",
                          "version": 1793621768
                        },
                        "invoice_id": "2026-0001",
                        "recurring_sales_invoice_id": null,
                        "subscription_id": null,
                        "workflow_id": "502689109097055375",
                        "document_style_id": "502689109280556185",
                        "identity_id": "502689108656653419",
                        "draft_id": null,
                        "state": "open",
                        "invoice_date": "2026-11-02",
                        "due_date": "2026-11-16",
                        "payment_conditions": "We verzoeken u vriendelijk het bovenstaande bedrag van {document.total_price} voor {document.due_date} te voldoen op onze bankrekening onder vermelding van de omschrijving {document.payment_reference}. Voor vragen kunt u contact opnemen per e-mail.",
                        "payment_reference": "RF600000000000000E5JU4VH9",
                        "short_payment_reference": "RF60E5JU4VH9",
                        "reference": "foo",
                        "language": "nl",
                        "currency": "EUR",
                        "discount": "0.0",
                        "original_sales_invoice_id": null,
                        "paused": false,
                        "paid_at": null,
                        "sent_at": "2026-11-02",
                        "created_at": "2026-11-02T12:16:08.255Z",
                        "updated_at": "2026-11-02T12:17:13.646Z",
                        "public_view_code": "119206",
                        "public_view_code_expires_at": "2027-02-02T12:16:08.297Z",
                        "version": 1793621833,
                        "details": [
                          {
                            "id": "502689165777830986",
                            "administration_id": 123,
                            "tax_rate_id": "502689108899923082",
                            "ledger_account_id": "502689108787725434",
                            "project_id": null,
                            "product_id": null,
                            "amount": "1 x",
                            "amount_decimal": "1.0",
                            "description": "Project X",
                            "price": "300.0",
                            "period": "20261101..20261130",
                            "row_order": 1,
                            "total_price_excl_tax_with_discount": "300.0",
                            "total_price_excl_tax_with_discount_base": "300.0",
                            "tax_report_reference": [
                              "NL/1a"
                            ],
                            "mandatory_tax_text": null,
                            "created_at": "2026-11-02T12:16:08.258Z",
                            "updated_at": "2026-11-02T12:16:08.323Z"
                          }
                        ],
                        "payments": [],
                        "total_paid": "0.0",
                        "total_unpaid": "363.0",
                        "total_unpaid_base": "363.0",
                        "prices_are_incl_tax": false,
                        "total_price_excl_tax": "300.0",
                        "total_price_excl_tax_base": "300.0",
                        "total_price_incl_tax": "363.0",
                        "total_price_incl_tax_base": "363.0",
                        "total_discount": "0.0",
                        "marked_dubious_on": null,
                        "marked_uncollectible_on": null,
                        "reminder_count": 0,
                        "next_reminder": "2026-11-16",
                        "original_estimate_id": null,
                        "url": "http://moneybird.dev/123/external/0000000000000000000000000000000000000000000000000000000000000001/b3a4dd4c9bb5e7573dd717b11c23badeb0a6dae30c444d66d1427ac8d32a1ce6/sales_invoice",
                        "payment_url": "http://moneybird.dev/123/external/0000000000000000000000000000000000000000000000000000000000000001/b3a4dd4c9bb5e7573dd717b11c23badeb0a6dae30c444d66d1427ac8d32a1ce6/sales_invoice",
                        "custom_fields": [],
                        "notes": [],
                        "attachments": [],
                        "events": [
                          {
                            "administration_id": 123,
                            "user_id": "502689108256097381",
                            "action": "sales_invoice_created",
                            "link_entity_id": null,
                            "link_entity_type": null,
                            "data": {},
                            "created_at": "2026-11-02T12:16:08.261Z",
                            "updated_at": "2026-11-02T12:16:08.261Z"
                          },
                          {
                            "administration_id": 123,
                            "user_id": "502689108256097381",
                            "action": "sales_invoice_state_changed_to_open",
                            "link_entity_id": null,
                            "link_entity_type": null,
                            "data": {},
                            "created_at": "2026-11-02T12:16:08.305Z",
                            "updated_at": "2026-11-02T12:16:08.305Z"
                          },
                          {
                            "administration_id": 123,
                            "user_id": "502689108256097381",
                            "action": "sales_invoice_send_email",
                            "link_entity_id": null,
                            "link_entity_type": null,
                            "data": {
                              "email_address": "info@example.com; janjanssen@dev.null.moneybird.net",
                              "email_message": "Geachte Jan Janssen,\n\nIn de bijlage kunt u factuur 2026-0001 voor onze diensten vinden. Wij verzoeken u vriendelijk de factuur voor 16-11-2026 te voldoen.\n\nMet vriendelijke groet,\n\nParkietje B.V."
                            },
                            "created_at": "2026-11-02T12:16:08.338Z",
                            "updated_at": "2026-11-02T12:16:08.338Z"
                          }
                        ],
                        "tax_totals": [
                          {
                            "tax_rate_id": "502689108899923082",
                            "taxable_amount": "300.0",
                            "taxable_amount_base": "300.0",
                            "tax_amount": "63.0",
                            "tax_amount_base": "63.0"
                          }
                        ],
                        "time_entries": []
                      }
                    ]
                  },
                  "ReturnsAllInvoicesFilteredOnState": {
                    "summary": "Returns all invoices filtered on state",
                    "value": []
                  },
                  "ReturnsAnEmptyPageBeyondTheLastOne": {
                    "summary": "Returns an empty page beyond the last one",
                    "value": []
                  }
                }
              }
            }
          },
          "400": {
            "description": "Bad request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/symbolic_error"
                },
                "examples": {
                  "ReturnsA400ErrorWhenSortedByDateAscendingWithDraftsInTheFilter": {
                    "summary": "Returns a 400 error when sorted by date ascending with drafts in the filter",
                    "value": {
                      "error": "sort date_asc does not work when the period includes today and the filter includes draft or scheduled invoices. Use for example state:open|pending_payment|reminded|late|paid|uncollectible, or a period that does not include today."
                    }
                  },
                  "GiveA400ErrorWhenTheDateRangeIsFromTheBeginningOfTime": {
                    "summary": "Give a 400 error when the date range is from the beginning of time",
                    "value": {
                      "error": "Period must have both a start and end date"
                    }
                  },
                  "ReturnsAnErrorWhenTooManySalesInvoicesAreRequested": {
                    "summary": "Returns an error when too many sales invoices are requested",
                    "value": {
                      "error": "per_page does not have a valid value"
                    }
                  },
                  "GiveA400ErrorWhenTheDateRangeIsUntilTheEndOfTime": {
                    "summary": "Give a 400 error when the date range is until the end of time",
                    "value": {
                      "error": "Period must have both a start and end date"
                    }
                  },
                  "ReturnsAnErrorWhenThePageIsOutOfRange": {
                    "summary": "Returns an error when the page is out of range",
                    "value": {
                      "error": "page does not have a valid value"
                    }
                  }
                }
              }
            }
          }
        },
        "operationId": "get_administration_id_sales_invoices"
      },
      "post": {
        "summary": "Create a sales invoice",
        "description": "Create a sales invoice with the parameters defined in the request body.\n\n### Required scope(s)\n `sales_invoices`",
        "tags": [
          "Sales invoices"
        ],
        "security": [
          {
            "bearerAuth": [
              "sales_invoices"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/administration_id"
          },
          {
            "$ref": "#/components/parameters/format"
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/*": {
              "schema": {
                "unevaluatedProperties": false,
                "type": "object",
                "properties": {
                  "sales_invoice": {
                    "type": "object",
                    "unevaluatedProperties": false,
                    "properties": {
                      "contact_id": {
                        "$ref": "#/components/schemas/identifier"
                      },
                      "contact_person_id": {
                        "$ref": "#/components/schemas/identifier",
                        "description": "The ID of the contact person associated with the sales invoice. Should be a valid contact person id."
                      },
                      "original_estimate_id": {
                        "$ref": "#/components/schemas/identifier",
                        "description": "The ID of the estimate this invoice was created from. Used to link an invoice to its originating estimate."
                      },
                      "document_style_id": {
                        "$ref": "#/components/schemas/identifier",
                        "description": "Default document style is used if value is not provided. Should be a valid document style id."
                      },
                      "workflow_id": {
                        "$ref": "#/components/schemas/identifier",
                        "description": "If value is not provided, the workflow saved in the contact is used. If the contact doesn't have a default workflow, the administration's default workflow is used. Should be a valid workflow id."
                      },
                      "reference": {
                        "type": "string",
                        "description": "Your own reference for this invoice, e.g. a project code or PO number. Visible to the recipient."
                      },
                      "invoice_sequence_id": {
                        "type": [
                          "string",
                          "integer"
                        ],
                        "description": "The sequence number that is put in the invoice number template, e.g. `0042`. If not provided, the next number in the sequence is used when the invoice is sent."
                      },
                      "invoice_date": {
                        "type": "string",
                        "description": "When left empty, it is filled in when the invoice is sent.",
                        "format": "date"
                      },
                      "first_due_interval": {
                        "type": "integer",
                        "description": "The number of days after the invoice date before the invoice is due. Defaults to the first workflow step's due interval."
                      },
                      "currency": {
                        "type": "string",
                        "description": "ISO three-character currency code, e.g. EUR or USD. Defaults to the workflow's currency."
                      },
                      "prices_are_incl_tax": {
                        "type": [
                          "boolean",
                          "string"
                        ],
                        "description": "Whether the prices on the invoice are inclusive of tax. Defaults to the workflow's setting."
                      },
                      "payment_conditions": {
                        "type": "string",
                        "description": "Free-text payment conditions printed on the invoice, e.g. \"Payment within 30 days\". Defaults to the workflow's payment conditions."
                      },
                      "discount": {
                        "$ref": "#/components/schemas/number",
                        "description": "Discount percentage applied to the entire invoice, e.g. `10.0` for 10%."
                      },
                      "time_entry_ids": {
                        "type": "array",
                        "description": "An array of time entry IDs to associate with this invoice. Linked time entries will be marked as invoiced.",
                        "items": {
                          "$ref": "#/components/schemas/identifier"
                        }
                      },
                      "details_attributes": {
                        "$ref": "#/components/schemas/details_attributes"
                      },
                      "custom_fields_attributes": {
                        "$ref": "#/components/schemas/custom_fields_attributes"
                      }
                    },
                    "required": [
                      "contact_id"
                    ]
                  },
                  "from_payment_request": {
                    "type": [
                      "boolean",
                      "string"
                    ],
                    "description": "Set to `true` when the invoice was created from a Moneybird payment request."
                  }
                },
                "required": [
                  "sales_invoice"
                ]
              },
              "examples": {
                "CreateABasicSalesInvoice": {
                  "summary": "Create a basic sales invoice",
                  "value": {
                    "sales_invoice": {
                      "reference": "30052",
                      "contact_id": 502689148829697860,
                      "details_attributes": [
                        {
                          "description": "Rocking Chair",
                          "price": 129.95
                        }
                      ]
                    }
                  }
                },
                "CreateASalesInvoiceInAForeignCurrency": {
                  "summary": "Create a sales invoice in a foreign currency",
                  "value": {
                    "sales_invoice": {
                      "reference": "30052",
                      "contact_id": 502689149012150100,
                      "currency": "USD",
                      "details_attributes": [
                        {
                          "description": "Rocking Chair",
                          "price": 159.99,
                          "tax_rate_id": 502689149108619140
                        }
                      ]
                    }
                  }
                }
              }
            }
          }
        },
        "responses": {
          "201": {
            "description": "Sales invoice created",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/sales_invoice_response"
                },
                "examples": {
                  "CreateABasicSalesInvoice": {
                    "summary": "Create a basic sales invoice",
                    "value": {
                      "id": "502689148973352793",
                      "administration_id": 123,
                      "contact_id": "502689148829697860",
                      "contact": {
                        "id": "502689148829697860",
                        "administration_id": 123,
                        "company_name": "Foobar Holding B.V.",
                        "firstname": null,
                        "lastname": null,
                        "address1": "Hoofdstraat 12",
                        "address2": null,
                        "zipcode": "1234AB",
                        "city": "Amsterdam",
                        "country": "NL",
                        "phone": null,
                        "delivery_method": "Email",
                        "customer_id": "customer-1",
                        "tax_number": null,
                        "chamber_of_commerce": null,
                        "bank_account": null,
                        "is_trusted": false,
                        "max_transfer_amount": null,
                        "attention": null,
                        "email": "info@example.com",
                        "email_ubl": true,
                        "send_invoices_to_attention": null,
                        "send_invoices_to_email": "info@example.com",
                        "send_estimates_to_attention": null,
                        "send_estimates_to_email": "info@example.com",
                        "direct_debit": false,
                        "sepa_active": false,
                        "sepa_iban": null,
                        "sepa_iban_account_name": null,
                        "sepa_bic": null,
                        "sepa_mandate_id": null,
                        "sepa_mandate_date": null,
                        "sepa_sequence_type": "RCUR",
                        "credit_card_number": null,
                        "credit_card_reference": null,
                        "credit_card_type": null,
                        "tax_number_validated_at": null,
                        "tax_number_valid": null,
                        "invoice_workflow_id": null,
                        "estimate_workflow_id": null,
                        "si_identifier": null,
                        "si_identifier_type": null,
                        "moneybird_payments_mandate": false,
                        "created_at": "2026-11-02T12:15:52.095Z",
                        "updated_at": "2026-11-02T12:15:52.095Z",
                        "version": 1793621752,
                        "sales_invoices_url": "https://moneybird.dev/123/sales_invoices/0000000000000000000000000000000000000000000000000000000000000001/all",
                        "notes": [],
                        "custom_fields": [],
                        "contact_people": [
                          {
                            "id": "502689148832843590",
                            "contact_id": "502689148829697860",
                            "administration_id": 123,
                            "firstname": "Jan",
                            "lastname": "Janssen",
                            "phone": "123-456-2346",
                            "email": "janjanssen@dev.null.moneybird.net",
                            "department": "Sales",
                            "created_at": "2026-11-02T12:15:52.099Z",
                            "updated_at": "2026-11-02T12:15:52.099Z",
                            "version": 1793621752
                          }
                        ],
                        "archived": false
                      },
                      "contact_person_id": null,
                      "contact_person": null,
                      "invoice_id": null,
                      "recurring_sales_invoice_id": null,
                      "subscription_id": null,
                      "workflow_id": "502689109097055375",
                      "document_style_id": "502689109280556185",
                      "identity_id": "502689108656653419",
                      "draft_id": 2,
                      "state": "draft",
                      "invoice_date": null,
                      "due_date": "2026-11-16",
                      "payment_conditions": "We verzoeken u vriendelijk het bovenstaande bedrag van {document.total_price} voor {document.due_date} te voldoen op onze bankrekening onder vermelding van de omschrijving {document.payment_reference}. Voor vragen kunt u contact opnemen per e-mail.",
                      "payment_reference": null,
                      "short_payment_reference": null,
                      "reference": "30052",
                      "language": "nl",
                      "currency": "EUR",
                      "discount": "0.0",
                      "original_sales_invoice_id": null,
                      "paused": false,
                      "paid_at": null,
                      "sent_at": null,
                      "created_at": "2026-11-02T12:15:52.232Z",
                      "updated_at": "2026-11-02T12:15:52.236Z",
                      "public_view_code": null,
                      "public_view_code_expires_at": null,
                      "version": 1793621752,
                      "details": [
                        {
                          "id": "502689148975449946",
                          "administration_id": 123,
                          "tax_rate_id": "502689108899923082",
                          "ledger_account_id": "502689108787725434",
                          "project_id": null,
                          "product_id": null,
                          "amount": null,
                          "amount_decimal": "1.0",
                          "description": "Rocking Chair",
                          "price": "129.95",
                          "period": null,
                          "row_order": 0,
                          "total_price_excl_tax_with_discount": "129.95",
                          "total_price_excl_tax_with_discount_base": "129.95",
                          "tax_report_reference": [
                            "NL/1a"
                          ],
                          "mandatory_tax_text": null,
                          "created_at": "2026-11-02T12:15:52.235Z",
                          "updated_at": "2026-11-02T12:15:52.235Z"
                        }
                      ],
                      "payments": [],
                      "total_paid": "0.0",
                      "total_unpaid": "157.24",
                      "total_unpaid_base": "157.24",
                      "prices_are_incl_tax": false,
                      "total_price_excl_tax": "129.95",
                      "total_price_excl_tax_base": "129.95",
                      "total_price_incl_tax": "157.24",
                      "total_price_incl_tax_base": "157.24",
                      "total_discount": "0.0",
                      "marked_dubious_on": null,
                      "marked_uncollectible_on": null,
                      "reminder_count": 0,
                      "next_reminder": null,
                      "original_estimate_id": null,
                      "url": "http://moneybird.dev/123/external/0000000000000000000000000000000000000000000000000000000000000001/f7983dbdb2f0da98920e0434e918c04d6d87dc635089630429b222abd8da401c/sales_invoice",
                      "payment_url": "http://moneybird.dev/123/external/0000000000000000000000000000000000000000000000000000000000000001/f7983dbdb2f0da98920e0434e918c04d6d87dc635089630429b222abd8da401c/sales_invoice",
                      "custom_fields": [],
                      "notes": [],
                      "attachments": [],
                      "events": [
                        {
                          "administration_id": 123,
                          "user_id": "502689108256097381",
                          "action": "sales_invoice_created",
                          "link_entity_id": null,
                          "link_entity_type": null,
                          "data": {},
                          "created_at": "2026-11-02T12:15:52.237Z",
                          "updated_at": "2026-11-02T12:15:52.237Z"
                        }
                      ],
                      "tax_totals": [
                        {
                          "tax_rate_id": "502689108899923082",
                          "taxable_amount": "129.95",
                          "taxable_amount_base": "129.95",
                          "tax_amount": "27.29",
                          "tax_amount_base": "27.29"
                        }
                      ],
                      "time_entries": []
                    }
                  },
                  "CreateASalesInvoiceInAForeignCurrency": {
                    "summary": "Create a sales invoice in a foreign currency",
                    "value": {
                      "id": "502689149129590643",
                      "administration_id": 123,
                      "contact_id": "502689149012150109",
                      "contact": {
                        "id": "502689149012150109",
                        "administration_id": 123,
                        "company_name": "Foobar Holding B.V.",
                        "firstname": null,
                        "lastname": null,
                        "address1": "Hoofdstraat 12",
                        "address2": null,
                        "zipcode": "1234AB",
                        "city": "Amsterdam",
                        "country": "NL",
                        "phone": null,
                        "delivery_method": "Email",
                        "customer_id": "customer-1",
                        "tax_number": null,
                        "chamber_of_commerce": null,
                        "bank_account": null,
                        "is_trusted": false,
                        "max_transfer_amount": null,
                        "attention": null,
                        "email": "info@example.com",
                        "email_ubl": true,
                        "send_invoices_to_attention": null,
                        "send_invoices_to_email": "info@example.com",
                        "send_estimates_to_attention": null,
                        "send_estimates_to_email": "info@example.com",
                        "direct_debit": false,
                        "sepa_active": false,
                        "sepa_iban": null,
                        "sepa_iban_account_name": null,
                        "sepa_bic": null,
                        "sepa_mandate_id": null,
                        "sepa_mandate_date": null,
                        "sepa_sequence_type": "RCUR",
                        "credit_card_number": null,
                        "credit_card_reference": null,
                        "credit_card_type": null,
                        "tax_number_validated_at": null,
                        "tax_number_valid": null,
                        "invoice_workflow_id": null,
                        "estimate_workflow_id": null,
                        "si_identifier": null,
                        "si_identifier_type": null,
                        "moneybird_payments_mandate": false,
                        "created_at": "2026-11-02T12:15:52.269Z",
                        "updated_at": "2026-11-02T12:15:52.269Z",
                        "version": 1793621752,
                        "sales_invoices_url": "https://moneybird.dev/123/sales_invoices/0000000000000000000000000000000000000000000000000000000000000001/all",
                        "notes": [],
                        "custom_fields": [],
                        "contact_people": [
                          {
                            "id": "502689149014247263",
                            "contact_id": "502689149012150109",
                            "administration_id": 123,
                            "firstname": "Jan",
                            "lastname": "Janssen",
                            "phone": "123-456-2346",
                            "email": "janjanssen@dev.null.moneybird.net",
                            "department": "Sales",
                            "created_at": "2026-11-02T12:15:52.272Z",
                            "updated_at": "2026-11-02T12:15:52.272Z",
                            "version": 1793621752
                          }
                        ],
                        "archived": false
                      },
                      "contact_person_id": null,
                      "contact_person": null,
                      "invoice_id": null,
                      "recurring_sales_invoice_id": null,
                      "subscription_id": null,
                      "workflow_id": "502689109097055375",
                      "document_style_id": "502689109280556185",
                      "identity_id": "502689108656653419",
                      "draft_id": 2,
                      "state": "draft",
                      "invoice_date": null,
                      "due_date": "2026-11-16",
                      "payment_conditions": "We verzoeken u vriendelijk het bovenstaande bedrag van {document.total_price} voor {document.due_date} te voldoen op onze bankrekening onder vermelding van de omschrijving {document.payment_reference}. Voor vragen kunt u contact opnemen per e-mail.",
                      "payment_reference": null,
                      "short_payment_reference": null,
                      "reference": "30052",
                      "language": "nl",
                      "currency": "USD",
                      "discount": "0.0",
                      "original_sales_invoice_id": null,
                      "paused": false,
                      "paid_at": null,
                      "sent_at": null,
                      "created_at": "2026-11-02T12:15:52.382Z",
                      "updated_at": "2026-11-02T12:15:52.384Z",
                      "public_view_code": null,
                      "public_view_code_expires_at": null,
                      "version": 1793621752,
                      "details": [
                        {
                          "id": "502689149131687796",
                          "administration_id": 123,
                          "tax_rate_id": "502689149108619122",
                          "ledger_account_id": "502689108787725434",
                          "project_id": null,
                          "product_id": null,
                          "amount": null,
                          "amount_decimal": "1.0",
                          "description": "Rocking Chair",
                          "price": "159.99",
                          "period": null,
                          "row_order": 0,
                          "total_price_excl_tax_with_discount": "159.99",
                          "total_price_excl_tax_with_discount_base": "127.99",
                          "tax_report_reference": [
                            "NL/3a"
                          ],
                          "mandatory_tax_text": "Intracommunautaire levering, artikel 138, lid 1, Richtlijn 2006/112",
                          "created_at": "2026-11-02T12:15:52.383Z",
                          "updated_at": "2026-11-02T12:15:52.383Z"
                        }
                      ],
                      "payments": [],
                      "total_paid": "0.0",
                      "total_unpaid": "159.99",
                      "total_unpaid_base": "127.99",
                      "prices_are_incl_tax": false,
                      "total_price_excl_tax": "159.99",
                      "total_price_excl_tax_base": "127.99",
                      "total_price_incl_tax": "159.99",
                      "total_price_incl_tax_base": "127.99",
                      "total_discount": "0.0",
                      "marked_dubious_on": null,
                      "marked_uncollectible_on": null,
                      "reminder_count": 0,
                      "next_reminder": null,
                      "original_estimate_id": null,
                      "url": "http://moneybird.dev/123/external/0000000000000000000000000000000000000000000000000000000000000001/1c683e662b08bea8afba1614ec2453af460d32d1de331afb37258a3d729c543f/sales_invoice",
                      "payment_url": "http://moneybird.dev/123/external/0000000000000000000000000000000000000000000000000000000000000001/1c683e662b08bea8afba1614ec2453af460d32d1de331afb37258a3d729c543f/sales_invoice",
                      "custom_fields": [],
                      "notes": [],
                      "attachments": [],
                      "events": [
                        {
                          "administration_id": 123,
                          "user_id": "502689108256097381",
                          "action": "sales_invoice_created",
                          "link_entity_id": null,
                          "link_entity_type": null,
                          "data": {},
                          "created_at": "2026-11-02T12:15:52.385Z",
                          "updated_at": "2026-11-02T12:15:52.385Z"
                        }
                      ],
                      "tax_totals": [],
                      "time_entries": []
                    }
                  }
                }
              }
            }
          },
          "402": {
            "description": "Payment required",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/symbolic_error"
                },
                "examples": {
                  "ExceedingTheMonthlySalesInvoiceLimitOnAFreePlanResultsInAnError": {
                    "summary": "Exceeding the monthly sales invoice limit on a free plan results in an error",
                    "value": {
                      "error": "creating sales invoices is limited",
                      "symbolic": {
                        "administration": "limit_reached"
                      }
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Not found",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/symbolic_error"
                },
                "examples": {
                  "CreatingAnInvoiceWithAnUnknownCustomFieldIdResultsInAnError": {
                    "summary": "Creating an invoice with an unknown custom field id results in an error",
                    "value": {
                      "error": "Custom field with id 123456 not found for administration",
                      "symbolic": {
                        "custom_fields_attributes": "not_found"
                      }
                    }
                  }
                }
              }
            }
          },
          "422": {
            "$ref": "#/components/responses/422_unprocessable_entity"
          }
        },
        "operationId": "post_administration_id_sales_invoices"
      }
    },
    "/{administration_id}/sepa_credit_transfer{format}": {
      "post": {
        "summary": "Upload a SEPA credit transfer file to create purchase transaction batches",
        "description": "Upload a SEPA credit transfer file (pain.001.001.09/Version 2019) to create purchase transaction batches. This endpoint requires an active Moneybird Banking account in the administration.\n\n### Required scope(s)\n `bank`",
        "tags": [
          "Purchase transactions"
        ],
        "security": [
          {
            "bearerAuth": [
              "bank"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/administration_id"
          },
          {
            "$ref": "#/components/parameters/format"
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "multipart/form-data": {
              "schema": {
                "type": "object",
                "required": [
                  "file"
                ],
                "properties": {
                  "file": {
                    "type": "string",
                    "format": "binary",
                    "description": "SEPA credit transfer file (pain.001.001.09/Version 2019)"
                  },
                  "ledger_account_id": {
                    "$ref": "#/components/schemas/identifier",
                    "description": "The ID of the ledger account that all transactions in the file will be booked on. If omitted, no booking is made and the bank transaction is left to automatic booking."
                  },
                  "financial_account_id": {
                    "$ref": "#/components/schemas/identifier",
                    "description": "The ID of the Moneybird Banking financial account that will be linked to all the purchase transactions in the file. Must be an active Moneybird Banking account. If not provided, the financial account will be determined based on the debtor account in the file."
                  }
                }
              }
            }
          }
        },
        "responses": {
          "201": {
            "description": "Purchase transaction batches created successfully using the SEPA credit transfer file",
            "content": {
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "$ref": "#/components/schemas/purchase_transaction_batch_response"
                  }
                },
                "examples": {
                  "Returns201": {
                    "summary": "Returns 201",
                    "value": [
                      {
                        "id": "502689273889162469",
                        "administration_id": 123,
                        "financial_account_id": "502689273794790620",
                        "state": "open",
                        "identifier": "PMT20250910-STD",
                        "created_at": "2025-09-12T00:00:00.000Z",
                        "updated_at": "2025-09-12T00:00:00.000Z"
                      },
                      {
                        "id": "502689273893356775",
                        "administration_id": 123,
                        "financial_account_id": "502689273806324959",
                        "state": "open",
                        "identifier": "PMT20250910-INST",
                        "created_at": "2025-09-12T00:00:00.000Z",
                        "updated_at": "2025-09-12T00:00:00.000Z"
                      },
                      {
                        "id": "502689273895453929",
                        "administration_id": 123,
                        "financial_account_id": "502689273817859298",
                        "state": "open",
                        "identifier": "PMT20250910-SAL",
                        "created_at": "2025-09-12T00:00:00.000Z",
                        "updated_at": "2025-09-12T00:00:00.000Z"
                      }
                    ]
                  },
                  "CreatesPurchaseTransactionBatchesFromASepaCreditTransferFile": {
                    "summary": "Creates purchase transaction batches from a sepa credit transfer file",
                    "value": [
                      {
                        "id": "502689274713343287",
                        "administration_id": 123,
                        "financial_account_id": "502689274624214318",
                        "state": "open",
                        "identifier": "PMT20250910-STD",
                        "created_at": "2025-09-12T00:00:00.000Z",
                        "updated_at": "2025-09-12T00:00:00.000Z"
                      },
                      {
                        "id": "502689274716489017",
                        "administration_id": 123,
                        "financial_account_id": "502689274631554353",
                        "state": "open",
                        "identifier": "PMT20250910-INST",
                        "created_at": "2025-09-12T00:00:00.000Z",
                        "updated_at": "2025-09-12T00:00:00.000Z"
                      },
                      {
                        "id": "502689274719634747",
                        "administration_id": 123,
                        "financial_account_id": "502689274638894388",
                        "state": "open",
                        "identifier": "PMT20250910-SAL",
                        "created_at": "2025-09-12T00:00:00.000Z",
                        "updated_at": "2025-09-12T00:00:00.000Z"
                      }
                    ]
                  }
                }
              }
            }
          },
          "400": {
            "description": "Bad request",
            "content": {
              "application/json": {
                "schema": {
                  "anyOf": [
                    {
                      "$ref": "#/components/schemas/symbolic_error"
                    },
                    {
                      "type": "object",
                      "required": [
                        "errors"
                      ],
                      "properties": {
                        "errors": {
                          "type": "array",
                          "items": {
                            "type": "string"
                          }
                        }
                      }
                    }
                  ]
                },
                "examples": {
                  "Returns400WhenNoFileIsProvided": {
                    "summary": "Returns 400 when no file is provided",
                    "value": {
                      "errors": [
                        "File is required"
                      ]
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Unauthorized",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/symbolic_error"
                },
                "examples": {
                  "Returns401WhenUserHasNoBankPermission": {
                    "summary": "Returns 401 when user has no bank permission",
                    "value": {
                      "error": "No access to bank"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Forbidden",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/symbolic_error"
                },
                "examples": {
                  "Returns403WhenAdministrationHasNoActiveMoneybirdBankingAccounts": {
                    "summary": "Returns 403 when administration has no active moneybird banking accounts",
                    "value": {
                      "error": "No access to SEPA credit transfers"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Not found",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/symbolic_error"
                },
                "examples": {
                  "CreatesAnImportWithGivenIds": {
                    "summary": "Creates an import with given ids",
                    "value": {
                      "error": "Record not found for model name: Financial account"
                    }
                  },
                  "Returns404WhenNoFinancialAccountIsFound": {
                    "summary": "Returns 404 when no financial account is found",
                    "value": {
                      "error": "Record not found for model name: Financial account"
                    }
                  },
                  "Returns404WhenTheFinancialAccountIsAVatSavingsAccount": {
                    "summary": "Returns 404 when the financial account is a vat savings account",
                    "value": {
                      "error": "Record not found for model name: Financial account"
                    }
                  },
                  "Returns404WhenNoLedgerAccountIsFound": {
                    "summary": "Returns 404 when no ledger account is found",
                    "value": {
                      "error": "Record not found for model name: Category"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The file is not valid SEPA credit transfer XML, or the batches in it are not valid",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "required": [
                    "errors"
                  ],
                  "properties": {
                    "message": {
                      "type": "string",
                      "description": "Only present when the XML is not valid."
                    },
                    "errors": {
                      "type": "array",
                      "items": {
                        "type": "string"
                      }
                    }
                  }
                },
                "examples": {
                  "Returns422WhenCreatedBatchesAreInvalid": {
                    "summary": "Returns 422 when created batches are invalid",
                    "value": {
                      "errors": [
                        "Purchase transactions is invalid",
                        "Amount must be greater than or equal to 0.01"
                      ]
                    }
                  },
                  "Returns422WhenTheXmlIsInvalid": {
                    "summary": "Returns 422 when the xml is invalid",
                    "value": {
                      "message": "The XML is invalid",
                      "errors": [
                        "6:0: ERROR: Element '{urn:iso:std:iso:20022:tech:xsd:pain.001.001.09}CreDtTm': 'invalid-date' is not a valid value of the atomic type '{urn:iso:std:iso:20022:tech:xsd:pain.001.001.09}ISODateTime'.",
                        "7:0: ERROR: Element '{urn:iso:std:iso:20022:tech:xsd:pain.001.001.09}NbOfTxs': [facet 'pattern'] The value 'not-a-number' is not accepted by the pattern '[0-9]{1,15}'.",
                        "8:0: ERROR: Element '{urn:iso:std:iso:20022:tech:xsd:pain.001.001.09}CtrlSum': 'invalid-amount' is not a valid value of the atomic type '{urn:iso:std:iso:20022:tech:xsd:pain.001.001.09}DecimalNumber'.",
                        "10:0: ERROR: Element '{urn:iso:std:iso:20022:tech:xsd:pain.001.001.09}Nm': [facet 'minLength'] The value has a length of '0'; this underruns the allowed minimum length of '1'.",
                        "14:0: ERROR: Element '{urn:iso:std:iso:20022:tech:xsd:pain.001.001.09}PmtInfId': [facet 'minLength'] The value has a length of '0'; this underruns the allowed minimum length of '1'.",
                        "15:0: ERROR: Element '{urn:iso:std:iso:20022:tech:xsd:pain.001.001.09}PmtMtd': [facet 'enumeration'] The value 'INVALID' is not an element of the set {'CHK', 'TRF', 'TRA'}.",
                        "16:0: ERROR: Element '{urn:iso:std:iso:20022:tech:xsd:pain.001.001.09}NbOfTxs': [facet 'pattern'] The value '-1' is not accepted by the pattern '[0-9]{1,15}'.",
                        "18:0: ERROR: Element '{urn:iso:std:iso:20022:tech:xsd:pain.001.001.09}Dbtr': This element is not expected. Expected is one of ( {urn:iso:std:iso:20022:tech:xsd:pain.001.001.09}PmtTpInf, {urn:iso:std:iso:20022:tech:xsd:pain.001.001.09}ReqdExctnDt )."
                      ]
                    }
                  }
                }
              }
            }
          }
        },
        "operationId": "post_administration_id_sepa_credit_transfer"
      }
    },
    "/{administration_id}/subscription_templates/{id}/checkout_identifier{format}": {
      "get": {
        "summary": "Create online sales link [Deprecated]",
        "description": "This call generates an online sales link, which enables pre-setting the contact and start date for a subscription.\n\n### Required scope(s)\n `settings`",
        "deprecated": true,
        "x-sunset": "2025-12-31",
        "tags": [
          "Subscription templates"
        ],
        "security": [
          {
            "bearerAuth": [
              "settings"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/administration_id"
          },
          {
            "name": "id",
            "in": "path",
            "required": true,
            "schema": {
              "$ref": "#/components/schemas/identifier"
            }
          },
          {
            "$ref": "#/components/parameters/format"
          },
          {
            "name": "contact_id",
            "in": "query",
            "required": false,
            "schema": {
              "$ref": "#/components/schemas/identifier"
            },
            "examples": {
              "CreatesAnOnlineSalesLink": {
                "summary": "Creates an online sales link",
                "value": "502689262780548789"
              }
            }
          },
          {
            "name": "start_date",
            "in": "query",
            "required": false,
            "schema": {
              "type": "string",
              "format": "date"
            },
            "examples": {
              "CreatesAnOnlineSalesLink": {
                "summary": "Creates an online sales link",
                "value": "2026-11-02"
              }
            }
          },
          {
            "name": "product_id",
            "in": "query",
            "required": false,
            "schema": {
              "$ref": "#/components/schemas/identifier"
            },
            "examples": {
              "CreatesAnOnlineSalesLinkForAProduct": {
                "summary": "Creates an online sales link for a product",
                "value": "502689262957758172"
              }
            }
          }
        ],
        "responses": {
          "200": {
            "description": "A subscription template",
            "content": {
              "application/json": {
                "schema": {
                  "type": "string"
                },
                "examples": {
                  "CreatesAnOnlineSalesLink": {
                    "summary": "Creates an online sales link",
                    "value": "http://checkout.moneybird.dev/s/MGM0NVZ0S0NFeFBkNitpait4aitQVWsvSnJJS2Frc21ySHo1a1IweUZJcHc3dU4yWmhJZ3ZDTlhnVU02TEFhZ0hscERNeXlHZWRGSFhVZndEeXBDeTU1NTNnejBUdVFQVG5vPS0tNlVIZityS0VnOTlDZXU0Ty0tYm5mV3FyWmh6eG8wN2I4enBTd3RoZz09"
                  },
                  "CreatesAnOnlineSalesLinkIfNoContactIdIsProvided": {
                    "summary": "Creates an online sales link if no contact id is provided",
                    "value": "http://checkout.moneybird.dev/s/VVM3VUhYbjdpSWFxQ1ZmSFA4WUJ6NFhIV2VBc0NCZDB5WEo2L0pwUVBFLzVwbFQ3YkpJNnZvOGg4NzNoSTVZdUlGMzV4dz09LS11YS9mS2hZM21IYWovR3FsLS1Sdmp0MVRuU3RaeDhscXdFbmNFeGpBPT0="
                  },
                  "CreatesAnOnlineSalesLinkForAProduct": {
                    "summary": "Creates an online sales link for a product",
                    "value": "http://checkout.moneybird.dev/stp/NStsMzRqaGlmN0tFVG9VcmN0dmx0Mzk0TUViQXR6UTAzZ2JwY0lJajZ5U3FuTGtoR2VUTWJXNGFrYXI4Zk9BajFzUTBoUT09LS1BSDk2VnlGVFFCakl5a1hkLS1xWFZNcnNxTk44a2JPWFdRRjI1K2Z3PT0="
                  }
                }
              }
            },
            "headers": {
              "X-Deprecated-Endpoint": {
                "description": "This endpoint is deprecated and will be removed in the future.",
                "schema": {
                  "type": "string"
                }
              }
            }
          },
          "404": {
            "description": "Not found",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/symbolic_error"
                },
                "examples": {
                  "Returns404WhenTheProductIsNotFound": {
                    "summary": "Returns 404 when the product is not found",
                    "value": {
                      "error": "Product not found for subscription template"
                    }
                  },
                  "Returns404IfContactIsNotFound": {
                    "summary": "Returns 404 if contact is not found",
                    "value": {
                      "error": "Record not found for model name: Contact"
                    }
                  }
                }
              }
            }
          }
        },
        "operationId": "get_administration_id_subscription_templates_id_checkout_identifier"
      }
    },
    "/{administration_id}/subscription_templates/{id}/sales_link{format}": {
      "post": {
        "summary": "Create online sales link",
        "description": "This call generates an online sales link, and allows pre-setting the contact and start date for a subscription. The link is valid for one hour\n\n### Required scope(s)\n `settings`",
        "tags": [
          "Subscription templates"
        ],
        "security": [
          {
            "bearerAuth": [
              "settings"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/administration_id"
          },
          {
            "name": "id",
            "in": "path",
            "required": true,
            "schema": {
              "$ref": "#/components/schemas/identifier"
            }
          },
          {
            "$ref": "#/components/parameters/format"
          },
          {
            "name": "contact_id",
            "in": "query",
            "required": false,
            "schema": {
              "$ref": "#/components/schemas/identifier"
            }
          },
          {
            "name": "start_date",
            "in": "query",
            "required": false,
            "schema": {
              "type": "string",
              "format": "date"
            }
          },
          {
            "name": "product_id",
            "in": "query",
            "required": false,
            "schema": {
              "$ref": "#/components/schemas/identifier"
            }
          }
        ],
        "responses": {
          "201": {
            "description": "Online sales link created successfully",
            "content": {
              "application/json": {
                "schema": {
                  "type": "string"
                },
                "examples": {
                  "CreatesAnOnlineSalesLink": {
                    "summary": "Creates an online sales link",
                    "value": "http://checkout.moneybird.dev/o/8pl2k2klrkwR"
                  },
                  "CreatesAnOnlineSalesLinkForAProduct": {
                    "summary": "Creates an online sales link for a product",
                    "value": "http://checkout.moneybird.dev/o/RVnb6b6dD6AY"
                  },
                  "CreatesAnOnlineSalesLinkIfNoContactIdIsProvided": {
                    "summary": "Creates an online sales link if no contact id is provided",
                    "value": "http://checkout.moneybird.dev/o/dV15G5j7qxYB"
                  }
                }
              }
            }
          },
          "404": {
            "description": "Not found",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/symbolic_error"
                },
                "examples": {
                  "Returns404WhenTheProductIsNotFound": {
                    "summary": "Returns 404 when the product is not found",
                    "value": {
                      "error": "Product not found for subscription template"
                    }
                  },
                  "Returns404IfContactIsNotFound": {
                    "summary": "Returns 404 if contact is not found",
                    "value": {
                      "error": "Record not found for model name: Contact"
                    }
                  }
                }
              }
            }
          }
        },
        "operationId": "post_administration_id_subscription_templates_id_sales_link"
      }
    },
    "/{administration_id}/subscription_templates{format}": {
      "get": {
        "summary": "List all subscription templates",
        "description": "This call retrieves a paginated list of all subscription templates available in the administration.\nEach page consists of up to 100 subscription templates. To access subsequent pages, utilize the page parameter to fetch the next set of subscription templates.\n\n### Required scope(s)\n `settings`",
        "tags": [
          "Subscription templates"
        ],
        "security": [
          {
            "bearerAuth": [
              "settings"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/administration_id"
          },
          {
            "$ref": "#/components/parameters/format"
          },
          {
            "$ref": "#/components/parameters/per_page"
          },
          {
            "$ref": "#/components/parameters/page"
          }
        ],
        "responses": {
          "200": {
            "description": "A list of subscription templates",
            "content": {
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "$ref": "#/components/schemas/subscription_template_response"
                  }
                },
                "examples": {
                  "ListsSubscriptionTemplatesForTheAdministration": {
                    "summary": "Lists subscription templates for the administration",
                    "value": [
                      {
                        "id": "502689262996555492",
                        "administration_id": 123,
                        "workflow_id": "502689262988166878",
                        "document_style_id": "502689109280556185",
                        "mergeable": false,
                        "contact_can_update": true,
                        "products": [
                          {
                            "id": "502689262992361187",
                            "administration_id": 123,
                            "description": "fancy product",
                            "title": null,
                            "identifier": null,
                            "price": "10.0",
                            "currency": "EUR",
                            "frequency": 1,
                            "frequency_type": "month",
                            "tax_rate_id": "502689108899923082",
                            "ledger_account_id": "502689108787725434",
                            "created_at": "2026-11-02T12:17:40.970Z",
                            "updated_at": "2026-11-02T12:17:40.970Z"
                          }
                        ]
                      }
                    ]
                  }
                }
              }
            }
          },
          "400": {
            "description": "Bad request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/symbolic_error"
                },
                "examples": {
                  "ReturnsA400IfPageParamIsInvalid": {
                    "summary": "Returns a 400 if page param is invalid",
                    "value": {
                      "error": "Page is too small",
                      "symbolic": {
                        "page": "min"
                      }
                    }
                  }
                }
              }
            }
          }
        },
        "operationId": "get_administration_id_subscription_templates"
      }
    },
    "/{administration_id}/subscriptions/{id}/additional_charges{format}": {
      "post": {
        "summary": "Create an additional charge to be invoiced together with the subscription",
        "description": "At the end of the current subscription period, the additional charges are merged where possible and an invoice will be created for them. The invoice will be scheduled for sending together with the subscription invoice, so that they are merged on sending.\n\n### Required scope(s)\n `sales_invoices`",
        "tags": [
          "Subscriptions"
        ],
        "security": [
          {
            "bearerAuth": [
              "sales_invoices"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/administration_id"
          },
          {
            "name": "id",
            "in": "path",
            "required": true,
            "schema": {
              "$ref": "#/components/schemas/identifier"
            }
          },
          {
            "$ref": "#/components/parameters/format"
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/*": {
              "schema": {
                "type": "object",
                "unevaluatedProperties": false,
                "properties": {
                  "product_id": {
                    "$ref": "#/components/schemas/identifier"
                  },
                  "amount": {
                    "type": [
                      "string",
                      "integer"
                    ],
                    "description": "The quantity on the invoice line, e.g. `1` or `5 x`."
                  },
                  "price": {
                    "$ref": "#/components/schemas/money",
                    "description": "The price per unit. Defaults to the price of the product for this contact at the start of the period."
                  },
                  "period": {
                    "type": "string",
                    "description": "The period the charge applies to, e.g. `20250101..20250131`, `202501..202503` or `this_month`."
                  },
                  "description": {
                    "type": "string"
                  },
                  "identifier": {
                    "type": "string",
                    "description": "Your own reference for this charge."
                  }
                },
                "required": [
                  "product_id",
                  "amount",
                  "period",
                  "description"
                ]
              },
              "examples": {
                "CreateAUsageCharge": {
                  "summary": "Create a usage charge",
                  "value": {
                    "product_id": 502689128954988300,
                    "amount": "5 x",
                    "price": 100,
                    "period": "20210601..20210630",
                    "description": "Transaction Costs"
                  }
                }
              }
            }
          }
        },
        "responses": {
          "201": {
            "description": "Subscription additional charge created",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/subscription_additional_charge_response"
                },
                "examples": {
                  "CreateAUsageCharge": {
                    "summary": "Create a usage charge",
                    "value": {
                      "id": "502689129138489129",
                      "administration_id": 123,
                      "contact_id": null,
                      "subscription_id": "502689128981202716",
                      "product_id": "502689128954988310",
                      "detail_id": null,
                      "amount": "5 x",
                      "price": "100.0",
                      "period": "202106..202106",
                      "description": "Transaction Costs"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "$ref": "#/components/responses/400_bad_request"
          },
          "404": {
            "$ref": "#/components/responses/404_not_found"
          }
        },
        "operationId": "post_administration_id_subscriptions_id_additional_charges"
      },
      "get": {
        "summary": "Get additional charges",
        "description": "Get the additional charges of the given subscription.\n\n### Required scope(s)\n `sales_invoices`",
        "tags": [
          "Subscriptions"
        ],
        "security": [
          {
            "bearerAuth": [
              "sales_invoices"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/administration_id"
          },
          {
            "name": "id",
            "in": "path",
            "required": true,
            "schema": {
              "$ref": "#/components/schemas/identifier"
            }
          },
          {
            "$ref": "#/components/parameters/format"
          },
          {
            "name": "include_billed",
            "in": "query",
            "required": false,
            "schema": {
              "type": [
                "boolean",
                "string"
              ],
              "description": "If true, includes the additional charges that have already been billed. Default is false."
            },
            "examples": {
              "DoesReturnBilledAdditionalChargesIfIncludeBilledIsTrue": {
                "summary": "Does return billed additional charges if include billed is true",
                "value": "true"
              }
            }
          }
        ],
        "responses": {
          "200": {
            "description": "A subscription additional charge",
            "content": {
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "$ref": "#/components/schemas/subscription_additional_charge_response"
                  }
                },
                "examples": {
                  "DoesReturnBilledAdditionalChargesIfIncludeBilledIsTrue": {
                    "summary": "Does return billed additional charges if include billed is true",
                    "value": [
                      {
                        "id": "502689127387367054",
                        "administration_id": 123,
                        "contact_id": null,
                        "subscription_id": "502689127227983487",
                        "product_id": "502689127369541260",
                        "detail_id": null,
                        "amount": "5 x",
                        "price": "100.0",
                        "period": "202106..202106",
                        "description": "Transaction Costs"
                      },
                      {
                        "id": "502689127399949969",
                        "administration_id": 123,
                        "contact_id": null,
                        "subscription_id": "502689127227983487",
                        "product_id": "502689127392609935",
                        "detail_id": "502689127423018643",
                        "amount": "5 x",
                        "price": "100.0",
                        "period": "202106..202106",
                        "description": "Transaction Costs"
                      }
                    ]
                  },
                  "ViewsAdditionalChargesOfASubscription": {
                    "summary": "Views additional charges of a subscription",
                    "value": [
                      {
                        "id": "502689127947306694",
                        "administration_id": 123,
                        "contact_id": null,
                        "subscription_id": "502689127796311735",
                        "product_id": "502689127941015236",
                        "detail_id": null,
                        "amount": "5 x",
                        "price": "100.0",
                        "period": "202106..202106",
                        "description": "Transaction Costs"
                      }
                    ]
                  }
                }
              }
            }
          },
          "404": {
            "$ref": "#/components/responses/404_not_found"
          }
        },
        "operationId": "get_administration_id_subscriptions_id_additional_charges"
      }
    },
    "/{administration_id}/subscriptions/{id}/create_and_schedule_one_off_sales_invoice{format}": {
      "post": {
        "summary": "Create and schedule an invoice to be sent together with the subscription",
        "description": "Besides the recurring sales invoice for the subscription, you sometimes need to bill\nseparate costs like usage based charges. Ideally you want these costs to be on the\nsame invoice as the subscription invoice. This endpoint allows you to put extra invoice\ndetails on the subscription invoice.\n\nThis endpoint creates a new sales invoice and schedules it for sending on the same date as\nthe next subscription invoice. During sending, Moneybird will merge both the scheduled invoice\nand the subscription invoice. This means the contact will receive one sales invoice with\nmultiple invoice details, both from the subscription and from the one off sales invoice.\n\n### Required scope(s)\n `sales_invoices`",
        "tags": [
          "Subscriptions"
        ],
        "security": [
          {
            "bearerAuth": [
              "sales_invoices"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/administration_id"
          },
          {
            "name": "id",
            "in": "path",
            "required": true,
            "schema": {
              "$ref": "#/components/schemas/identifier"
            }
          },
          {
            "$ref": "#/components/parameters/format"
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/*": {
              "schema": {
                "unevaluatedProperties": false,
                "type": "object",
                "properties": {
                  "sales_invoice": {
                    "type": "object",
                    "unevaluatedProperties": false,
                    "properties": {
                      "details_attributes": {
                        "$ref": "#/components/schemas/details_attributes"
                      },
                      "invoice_date": {
                        "type": "string",
                        "format": "date",
                        "description": "Date to schedule the invoice for. Defaults to the date of the next subscription invoice."
                      }
                    },
                    "required": []
                  }
                },
                "required": []
              },
              "examples": {
                "CreatesASalesInvoice": {
                  "summary": "Creates a sales invoice",
                  "value": {
                    "sales_invoice": {
                      "details_attributes": {
                        "0": {
                          "description": "Extra costs subscription",
                          "price": "10.5"
                        }
                      }
                    }
                  }
                }
              }
            }
          }
        },
        "responses": {
          "201": {
            "description": "Sales invoice created",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/sales_invoice_response"
                },
                "examples": {
                  "CreatesASalesInvoice": {
                    "summary": "Creates a sales invoice",
                    "value": {
                      "id": "502689125151802875",
                      "administration_id": 123,
                      "contact_id": "502689124743906794",
                      "contact": {
                        "id": "502689124743906794",
                        "administration_id": 123,
                        "company_name": "Foobar Holding B.V.",
                        "firstname": "",
                        "lastname": "",
                        "address1": "Hoofdstraat 12",
                        "address2": "",
                        "zipcode": "1234AB",
                        "city": "Amsterdam",
                        "country": "NL",
                        "phone": "",
                        "delivery_method": "Email",
                        "customer_id": "1",
                        "tax_number": "",
                        "chamber_of_commerce": "",
                        "bank_account": "",
                        "is_trusted": false,
                        "max_transfer_amount": null,
                        "attention": "",
                        "email": "info@example.com",
                        "email_ubl": true,
                        "send_invoices_to_attention": "",
                        "send_invoices_to_email": "info@example.com",
                        "send_estimates_to_attention": "",
                        "send_estimates_to_email": "info@example.com",
                        "direct_debit": false,
                        "sepa_active": false,
                        "sepa_iban": "",
                        "sepa_iban_account_name": "",
                        "sepa_bic": "",
                        "sepa_mandate_id": "",
                        "sepa_mandate_date": null,
                        "sepa_sequence_type": "RCUR",
                        "credit_card_number": "",
                        "credit_card_reference": "",
                        "credit_card_type": null,
                        "tax_number_validated_at": null,
                        "tax_number_valid": null,
                        "invoice_workflow_id": null,
                        "estimate_workflow_id": null,
                        "si_identifier": "",
                        "si_identifier_type": null,
                        "moneybird_payments_mandate": false,
                        "created_at": "2026-11-02T12:15:29.113Z",
                        "updated_at": "2026-11-02T12:15:29.113Z",
                        "version": 1793621729,
                        "sales_invoices_url": "https://moneybird.dev/123/sales_invoices/5c7680032b2f3000385c4ddde1bfd6ef4c7e00b4cdccf4f84ed32bca4ba70de0/all",
                        "notes": [],
                        "custom_fields": [],
                        "contact_people": [],
                        "archived": false
                      },
                      "contact_person_id": null,
                      "contact_person": null,
                      "invoice_id": null,
                      "recurring_sales_invoice_id": null,
                      "subscription_id": null,
                      "workflow_id": "502689109097055375",
                      "document_style_id": "502689109280556185",
                      "identity_id": "502689108656653419",
                      "draft_id": 2,
                      "state": "scheduled",
                      "invoice_date": "2026-12-01",
                      "due_date": "2026-12-15",
                      "payment_conditions": "We verzoeken u vriendelijk het bovenstaande bedrag van {document.total_price} voor {document.due_date} te voldoen op onze bankrekening onder vermelding van de omschrijving {document.payment_reference}. Voor vragen kunt u contact opnemen per e-mail.",
                      "payment_reference": null,
                      "short_payment_reference": null,
                      "reference": null,
                      "language": "nl",
                      "currency": "EUR",
                      "discount": "0.0",
                      "original_sales_invoice_id": null,
                      "paused": false,
                      "paid_at": null,
                      "sent_at": null,
                      "created_at": "2026-11-02T12:15:29.113Z",
                      "updated_at": "2026-11-02T12:15:29.113Z",
                      "public_view_code": null,
                      "public_view_code_expires_at": null,
                      "version": 1793621729,
                      "details": [
                        {
                          "id": "502689125154948604",
                          "administration_id": 123,
                          "tax_rate_id": "502689108899923082",
                          "ledger_account_id": "502689108787725434",
                          "project_id": null,
                          "product_id": null,
                          "amount": null,
                          "amount_decimal": "1.0",
                          "description": "Extra costs subscription",
                          "price": "10.5",
                          "period": null,
                          "row_order": 0,
                          "total_price_excl_tax_with_discount": "10.5",
                          "total_price_excl_tax_with_discount_base": "10.5",
                          "tax_report_reference": [
                            "NL/1a"
                          ],
                          "mandatory_tax_text": null,
                          "created_at": "2026-11-02T12:15:29.113Z",
                          "updated_at": "2026-11-02T12:15:29.113Z"
                        }
                      ],
                      "payments": [],
                      "total_paid": "0.0",
                      "total_unpaid": "12.71",
                      "total_unpaid_base": "12.71",
                      "prices_are_incl_tax": false,
                      "total_price_excl_tax": "10.5",
                      "total_price_excl_tax_base": "10.5",
                      "total_price_incl_tax": "12.71",
                      "total_price_incl_tax_base": "12.71",
                      "total_discount": "0.0",
                      "marked_dubious_on": null,
                      "marked_uncollectible_on": null,
                      "reminder_count": 0,
                      "next_reminder": null,
                      "original_estimate_id": null,
                      "url": "http://moneybird.dev/123/external/5c7680032b2f3000385c4ddde1bfd6ef4c7e00b4cdccf4f84ed32bca4ba70de0/a1bfd70ab86828104ef4789a8a4b1e9cfcbe905dc8b9afa1f37d181af3b969b2/sales_invoice",
                      "payment_url": "http://moneybird.dev/123/external/5c7680032b2f3000385c4ddde1bfd6ef4c7e00b4cdccf4f84ed32bca4ba70de0/a1bfd70ab86828104ef4789a8a4b1e9cfcbe905dc8b9afa1f37d181af3b969b2/sales_invoice",
                      "custom_fields": [],
                      "notes": [],
                      "attachments": [],
                      "events": [
                        {
                          "administration_id": 123,
                          "user_id": "502689108256097381",
                          "action": "sales_invoice_created",
                          "link_entity_id": null,
                          "link_entity_type": null,
                          "data": {},
                          "created_at": "2026-11-02T12:15:29.113Z",
                          "updated_at": "2026-11-02T12:15:29.113Z"
                        },
                        {
                          "administration_id": 123,
                          "user_id": "502689108256097381",
                          "action": "sales_invoice_state_changed_to_scheduled",
                          "link_entity_id": null,
                          "link_entity_type": null,
                          "data": {},
                          "created_at": "2026-11-02T12:15:29.113Z",
                          "updated_at": "2026-11-02T12:15:29.113Z"
                        }
                      ],
                      "tax_totals": [
                        {
                          "tax_rate_id": "502689108899923082",
                          "taxable_amount": "10.5",
                          "taxable_amount_base": "10.5",
                          "tax_amount": "2.21",
                          "tax_amount_base": "2.21"
                        }
                      ],
                      "time_entries": []
                    }
                  }
                }
              }
            }
          },
          "400": {
            "$ref": "#/components/responses/400_bad_request"
          },
          "402": {
            "$ref": "#/components/responses/402_payment_required"
          },
          "404": {
            "$ref": "#/components/responses/404_not_found"
          }
        },
        "operationId": "post_administration_id_subscriptions_id_create_and_schedule_one_off_sales_invoice"
      }
    },
    "/{administration_id}/subscriptions/{id}{format}": {
      "get": {
        "summary": "Get subscription",
        "description": "Get a subscription.\n\n### Required scope(s)\n `sales_invoices`",
        "tags": [
          "Subscriptions"
        ],
        "security": [
          {
            "bearerAuth": [
              "sales_invoices"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/administration_id"
          },
          {
            "name": "id",
            "in": "path",
            "required": true,
            "schema": {
              "$ref": "#/components/schemas/identifier"
            }
          },
          {
            "$ref": "#/components/parameters/format"
          }
        ],
        "responses": {
          "200": {
            "description": "A subscription",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/subscription_response"
                },
                "examples": {
                  "ReturnsASubscription": {
                    "summary": "Returns a subscription",
                    "value": {
                      "id": "502689126966888044",
                      "administration_id": 123,
                      "start_date": "2017-01-01",
                      "end_date": null,
                      "frequency": 1,
                      "frequency_type": "month",
                      "reference": null,
                      "cancelled_at": null,
                      "product_id": "502689126957450858",
                      "product": {
                        "id": "502689126957450858",
                        "administration_id": 123,
                        "description": "My product description",
                        "title": null,
                        "identifier": null,
                        "price": "20.0",
                        "currency": "EUR",
                        "frequency": 1,
                        "frequency_type": "month",
                        "tax_rate_id": "502689108899923082",
                        "ledger_account_id": "502689108787725434",
                        "created_at": "2026-11-02T12:15:31.237Z",
                        "updated_at": "2026-11-02T12:15:31.237Z"
                      },
                      "contact_id": "502689126945916520",
                      "contact": {
                        "id": "502689126945916520",
                        "administration_id": 123,
                        "company_name": "Foobar Holding B.V.",
                        "firstname": "",
                        "lastname": "",
                        "address1": "Hoofdstraat 12",
                        "address2": "",
                        "zipcode": "1234AB",
                        "city": "Amsterdam",
                        "country": "NL",
                        "phone": "",
                        "delivery_method": "Email",
                        "customer_id": "1",
                        "tax_number": "",
                        "chamber_of_commerce": "",
                        "bank_account": "",
                        "is_trusted": false,
                        "max_transfer_amount": null,
                        "attention": "",
                        "email": "info@example.com",
                        "email_ubl": true,
                        "send_invoices_to_attention": "",
                        "send_invoices_to_email": "info@example.com",
                        "send_estimates_to_attention": "",
                        "send_estimates_to_email": "info@example.com",
                        "direct_debit": false,
                        "sepa_active": false,
                        "sepa_iban": "",
                        "sepa_iban_account_name": "",
                        "sepa_bic": "",
                        "sepa_mandate_id": "",
                        "sepa_mandate_date": null,
                        "sepa_sequence_type": "RCUR",
                        "credit_card_number": "",
                        "credit_card_reference": "",
                        "credit_card_type": null,
                        "tax_number_validated_at": null,
                        "tax_number_valid": null,
                        "invoice_workflow_id": null,
                        "estimate_workflow_id": null,
                        "si_identifier": "",
                        "si_identifier_type": null,
                        "moneybird_payments_mandate": false,
                        "created_at": "2026-11-02T12:15:31.226Z",
                        "updated_at": "2026-11-02T12:15:31.226Z",
                        "version": 1793621731,
                        "sales_invoices_url": "https://moneybird.dev/123/sales_invoices/5dc0a8cfc2717e9b9212e6f23ded8f516ce39fb4db62eee30877582192dbc05c/all",
                        "notes": [],
                        "custom_fields": [],
                        "contact_people": [],
                        "archived": false
                      },
                      "contact_person_id": null,
                      "contact_person": null,
                      "subscription_products": [
                        {
                          "start_date": "2017-01-01",
                          "end_date": null,
                          "product_id": "502689126957450858",
                          "product": {
                            "id": "502689126957450858",
                            "administration_id": 123,
                            "description": "My product description",
                            "title": null,
                            "identifier": null,
                            "price": "20.0",
                            "currency": "EUR",
                            "frequency": 1,
                            "frequency_type": "month",
                            "tax_rate_id": "502689108899923082",
                            "ledger_account_id": "502689108787725434",
                            "created_at": "2026-11-02T12:15:31.237Z",
                            "updated_at": "2026-11-02T12:15:31.237Z"
                          },
                          "amount": "1 x",
                          "discount": "0.0"
                        }
                      ],
                      "recurring_sales_invoice_id": "502689126983665263"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Not found",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/symbolic_error"
                },
                "examples": {
                  "Returns404WhenTheSubscriptionDoesNotExist": {
                    "summary": "Returns 404 when the subscription does not exist",
                    "value": {
                      "error": "Record not found for model name: Subscription"
                    }
                  }
                }
              }
            }
          }
        },
        "operationId": "get_administration_id_subscriptions_id"
      },
      "patch": {
        "summary": "Update a subscription",
        "description": "Updates the product the contact is subscribed to. This will automatically calculate the differences\nbetween the product prices and create a one off sales invoice to bill the extra charge for the remaining\nbilling period.\n\nOptionally you can provide a start date for the product change to become active.\n\n### Required scope(s)\n `sales_invoices`",
        "tags": [
          "Subscriptions"
        ],
        "security": [
          {
            "bearerAuth": [
              "sales_invoices"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/administration_id"
          },
          {
            "name": "id",
            "in": "path",
            "required": true,
            "schema": {
              "$ref": "#/components/schemas/identifier"
            }
          },
          {
            "$ref": "#/components/parameters/format"
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/*": {
              "schema": {
                "unevaluatedProperties": false,
                "type": "object",
                "properties": {
                  "subscription": {
                    "type": "object",
                    "unevaluatedProperties": false,
                    "properties": {
                      "contact_person_id": {
                        "$ref": "#/components/schemas/identifier_nullable",
                        "description": "Should be a valid contact person id."
                      },
                      "document_style_id": {
                        "$ref": "#/components/schemas/identifier",
                        "description": "Should be a valid document style id."
                      },
                      "reference": {
                        "type": "string"
                      },
                      "mergeable": {
                        "type": [
                          "boolean",
                          "string"
                        ],
                        "default": false,
                        "description": "Merge invoices from this subscription with other mergeable invoices for the same contact before sending. Only applies when invoices are sent automatically."
                      },
                      "prices_are_incl_tax": {
                        "type": [
                          "boolean",
                          "string"
                        ],
                        "default": false,
                        "description": "Whether the amounts on the generated invoices are inclusive of tax."
                      },
                      "product_id": {
                        "$ref": "#/components/schemas/identifier",
                        "description": "Should be a valid product id."
                      },
                      "start_date": {
                        "type": "string",
                        "format": "date"
                      },
                      "amount": {
                        "type": "string",
                        "description": "Quantity of the product billed each period."
                      },
                      "discount": {
                        "$ref": "#/components/schemas/number",
                        "description": "Both a decimal and a string '10,95' are accepted."
                      }
                    },
                    "required": []
                  }
                },
                "required": []
              },
              "examples": {
                "UpdatesASubscription": {
                  "summary": "Updates a subscription",
                  "value": {
                    "subscription": {
                      "product_id": 502689130665215940,
                      "discount": 10,
                      "amount": "3 x"
                    }
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Subscription updated",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/subscription_response"
                },
                "examples": {
                  "UpdatesASubscription": {
                    "summary": "Updates a subscription",
                    "value": {
                      "id": "502689130693527487",
                      "administration_id": 123,
                      "start_date": "2017-01-01",
                      "end_date": null,
                      "frequency": 1,
                      "frequency_type": "month",
                      "reference": null,
                      "cancelled_at": null,
                      "product_id": "502689130665215927",
                      "product": {
                        "id": "502689130665215927",
                        "administration_id": 123,
                        "description": "My product description",
                        "title": null,
                        "identifier": null,
                        "price": "30.0",
                        "currency": "EUR",
                        "frequency": 1,
                        "frequency_type": "month",
                        "tax_rate_id": "502689108899923082",
                        "ledger_account_id": "502689108787725434",
                        "created_at": "2026-11-02T12:15:34.772Z",
                        "updated_at": "2026-11-02T12:15:34.772Z"
                      },
                      "contact_id": "502689130675701691",
                      "contact": {
                        "id": "502689130675701691",
                        "administration_id": 123,
                        "company_name": "Foobar Holding B.V.",
                        "firstname": "",
                        "lastname": "",
                        "address1": "Hoofdstraat 12",
                        "address2": "",
                        "zipcode": "1234AB",
                        "city": "Amsterdam",
                        "country": "NL",
                        "phone": "",
                        "delivery_method": "Email",
                        "customer_id": "1",
                        "tax_number": "",
                        "chamber_of_commerce": "",
                        "bank_account": "",
                        "is_trusted": false,
                        "max_transfer_amount": null,
                        "attention": "",
                        "email": "info@example.com",
                        "email_ubl": true,
                        "send_invoices_to_attention": "",
                        "send_invoices_to_email": "info@example.com",
                        "send_estimates_to_attention": "",
                        "send_estimates_to_email": "info@example.com",
                        "direct_debit": false,
                        "sepa_active": false,
                        "sepa_iban": "",
                        "sepa_iban_account_name": "",
                        "sepa_bic": "",
                        "sepa_mandate_id": "",
                        "sepa_mandate_date": null,
                        "sepa_sequence_type": "RCUR",
                        "credit_card_number": "",
                        "credit_card_reference": "",
                        "credit_card_type": null,
                        "tax_number_validated_at": null,
                        "tax_number_valid": null,
                        "invoice_workflow_id": null,
                        "estimate_workflow_id": null,
                        "si_identifier": "",
                        "si_identifier_type": null,
                        "moneybird_payments_mandate": false,
                        "created_at": "2026-11-02T12:15:34.783Z",
                        "updated_at": "2026-11-02T12:15:34.783Z",
                        "version": 1793621734,
                        "sales_invoices_url": "https://moneybird.dev/123/sales_invoices/4482153dcd323a6ef304a8ac5540f8f92a3ae35921c91968287ed5bfbc18a189/all",
                        "notes": [],
                        "custom_fields": [],
                        "contact_people": [],
                        "archived": false
                      },
                      "contact_person_id": null,
                      "contact_person": null,
                      "subscription_products": [
                        {
                          "start_date": "2017-01-01",
                          "end_date": "2026-11-01",
                          "product_id": "502689130684090301",
                          "product": {
                            "id": "502689130684090301",
                            "administration_id": 123,
                            "description": "My product description",
                            "title": null,
                            "identifier": null,
                            "price": "20.0",
                            "currency": "EUR",
                            "frequency": 1,
                            "frequency_type": "month",
                            "tax_rate_id": "502689108899923082",
                            "ledger_account_id": "502689108787725434",
                            "created_at": "2026-11-02T12:15:34.791Z",
                            "updated_at": "2026-11-02T12:15:34.791Z"
                          },
                          "amount": "1 x",
                          "discount": "0.0"
                        },
                        {
                          "start_date": "2026-11-02",
                          "end_date": null,
                          "product_id": "502689130665215927",
                          "product": {
                            "id": "502689130665215927",
                            "administration_id": 123,
                            "description": "My product description",
                            "title": null,
                            "identifier": null,
                            "price": "30.0",
                            "currency": "EUR",
                            "frequency": 1,
                            "frequency_type": "month",
                            "tax_rate_id": "502689108899923082",
                            "ledger_account_id": "502689108787725434",
                            "created_at": "2026-11-02T12:15:34.772Z",
                            "updated_at": "2026-11-02T12:15:34.772Z"
                          },
                          "amount": "3 x",
                          "discount": "10.0"
                        }
                      ],
                      "recurring_sales_invoice_id": "502689130712401858"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "$ref": "#/components/responses/400_bad_request"
          },
          "404": {
            "description": "Not found",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/symbolic_error"
                },
                "examples": {
                  "ReturnsA404IfTheSubscriptionCouldnTBeFound": {
                    "summary": "Returns a 404 if the subscription couldn't be found",
                    "value": {
                      "error": "record not found",
                      "symbolic": {
                        "id": "not_found"
                      }
                    }
                  }
                }
              }
            }
          },
          "422": {
            "$ref": "#/components/responses/422_unprocessable_entity"
          }
        },
        "operationId": "patch_administration_id_subscriptions_id"
      },
      "delete": {
        "summary": "Cancel a subscription",
        "description": "Cancels the subscription. Stops the recurring sales invoice for the contact. Optionally\nyou can provide an `end_date` to stop the subscription on a future date.\n\n### Required scope(s)\n `sales_invoices`",
        "tags": [
          "Subscriptions"
        ],
        "security": [
          {
            "bearerAuth": [
              "sales_invoices"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/administration_id"
          },
          {
            "name": "id",
            "in": "path",
            "required": true,
            "schema": {
              "$ref": "#/components/schemas/identifier"
            }
          },
          {
            "$ref": "#/components/parameters/format"
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/*": {
              "schema": {
                "unevaluatedProperties": false,
                "type": "object",
                "properties": {
                  "subscription": {
                    "type": "object",
                    "unevaluatedProperties": false,
                    "properties": {
                      "end_date": {
                        "type": "string",
                        "format": "date"
                      }
                    },
                    "required": []
                  }
                },
                "required": []
              },
              "examples": {
                "CancelsASubscriptionForTheContact": {
                  "summary": "Cancels a subscription for the contact",
                  "value": {
                    "subscription": {
                      "end_date": "2026-11-04"
                    }
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Subscription cancelled",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/subscription_response"
                },
                "examples": {
                  "CancelsASubscriptionForTheContact": {
                    "summary": "Cancels a subscription for the contact",
                    "value": {
                      "id": "502689129446770499",
                      "administration_id": 123,
                      "start_date": "2017-01-01",
                      "end_date": "2026-11-04",
                      "frequency": 1,
                      "frequency_type": "month",
                      "reference": null,
                      "cancelled_at": "2026-11-02T12:15:33.785Z",
                      "product_id": "502689129433139009",
                      "product": {
                        "id": "502689129433139009",
                        "administration_id": 123,
                        "description": "My product description",
                        "title": null,
                        "identifier": null,
                        "price": "20.0",
                        "currency": "EUR",
                        "frequency": 1,
                        "frequency_type": "month",
                        "tax_rate_id": "502689108899923082",
                        "ledger_account_id": "502689108787725434",
                        "created_at": "2026-11-02T12:15:33.598Z",
                        "updated_at": "2026-11-02T12:15:33.598Z"
                      },
                      "contact_id": "502689129420556095",
                      "contact": {
                        "id": "502689129420556095",
                        "administration_id": 123,
                        "company_name": "Foobar Holding B.V.",
                        "firstname": "",
                        "lastname": "",
                        "address1": "Hoofdstraat 12",
                        "address2": "",
                        "zipcode": "1234AB",
                        "city": "Amsterdam",
                        "country": "NL",
                        "phone": "",
                        "delivery_method": "Email",
                        "customer_id": "1",
                        "tax_number": "",
                        "chamber_of_commerce": "",
                        "bank_account": "",
                        "is_trusted": false,
                        "max_transfer_amount": null,
                        "attention": "",
                        "email": "info@example.com",
                        "email_ubl": true,
                        "send_invoices_to_attention": "",
                        "send_invoices_to_email": "info@example.com",
                        "send_estimates_to_attention": "",
                        "send_estimates_to_email": "info@example.com",
                        "direct_debit": false,
                        "sepa_active": false,
                        "sepa_iban": "",
                        "sepa_iban_account_name": "",
                        "sepa_bic": "",
                        "sepa_mandate_id": "",
                        "sepa_mandate_date": null,
                        "sepa_sequence_type": "RCUR",
                        "credit_card_number": "",
                        "credit_card_reference": "",
                        "credit_card_type": null,
                        "tax_number_validated_at": null,
                        "tax_number_valid": null,
                        "invoice_workflow_id": null,
                        "estimate_workflow_id": null,
                        "si_identifier": "",
                        "si_identifier_type": null,
                        "moneybird_payments_mandate": false,
                        "created_at": "2026-11-02T12:15:33.585Z",
                        "updated_at": "2026-11-02T12:15:33.585Z",
                        "version": 1793621733,
                        "sales_invoices_url": "https://moneybird.dev/123/sales_invoices/ea9b097d6aed3a9a4b1a3dfdb8780dd6d4aae6273e4de20ac155ad5a8c76f916/all",
                        "notes": [],
                        "custom_fields": [],
                        "contact_people": [],
                        "archived": false
                      },
                      "contact_person_id": null,
                      "contact_person": null,
                      "subscription_products": [
                        {
                          "start_date": "2017-01-01",
                          "end_date": "2026-11-04",
                          "product_id": "502689129433139009",
                          "product": {
                            "id": "502689129433139009",
                            "administration_id": 123,
                            "description": "My product description",
                            "title": null,
                            "identifier": null,
                            "price": "20.0",
                            "currency": "EUR",
                            "frequency": 1,
                            "frequency_type": "month",
                            "tax_rate_id": "502689108899923082",
                            "ledger_account_id": "502689108787725434",
                            "created_at": "2026-11-02T12:15:33.598Z",
                            "updated_at": "2026-11-02T12:15:33.598Z"
                          },
                          "amount": "1 x",
                          "discount": "0.0"
                        }
                      ],
                      "recurring_sales_invoice_id": "502689129481373510"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "$ref": "#/components/responses/400_bad_request"
          },
          "404": {
            "$ref": "#/components/responses/404_not_found"
          }
        },
        "operationId": "delete_administration_id_subscriptions_id"
      }
    },
    "/{administration_id}/subscriptions{format}": {
      "get": {
        "summary": "List subscriptions of a contact",
        "description": "Lists the subscriptions of a single contact. There is no endpoint that returns the subscriptions of every contact at once.\n\n### Required scope(s)\n `sales_invoices`",
        "tags": [
          "Subscriptions"
        ],
        "security": [
          {
            "bearerAuth": [
              "sales_invoices"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/administration_id"
          },
          {
            "$ref": "#/components/parameters/format"
          },
          {
            "name": "contact_id",
            "in": "query",
            "required": true,
            "schema": {
              "$ref": "#/components/schemas/identifier"
            },
            "examples": {
              "ListsAllSubscriptionsForAContact": {
                "summary": "Lists all subscriptions for a contact",
                "value": "502689132511757431"
              }
            }
          }
        ],
        "responses": {
          "200": {
            "description": "A list of subscriptions",
            "content": {
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "$ref": "#/components/schemas/subscription_response"
                  }
                },
                "examples": {
                  "ListsAllSubscriptionsForAContact": {
                    "summary": "Lists all subscriptions for a contact",
                    "value": [
                      {
                        "id": "502689132536923259",
                        "administration_id": 123,
                        "start_date": "2017-01-01",
                        "end_date": null,
                        "frequency": 1,
                        "frequency_type": "month",
                        "reference": null,
                        "cancelled_at": null,
                        "product_id": "502689132526437497",
                        "product": {
                          "id": "502689132526437497",
                          "administration_id": 123,
                          "description": "My product description",
                          "title": null,
                          "identifier": null,
                          "price": "20.0",
                          "currency": "EUR",
                          "frequency": 1,
                          "frequency_type": "month",
                          "tax_rate_id": "502689108899923082",
                          "ledger_account_id": "502689108787725434",
                          "created_at": "2026-11-02T12:15:36.547Z",
                          "updated_at": "2026-11-02T12:15:36.547Z"
                        },
                        "contact_id": "502689132511757431",
                        "contact": {
                          "id": "502689132511757431",
                          "administration_id": 123,
                          "company_name": "Foobar Holding B.V.",
                          "firstname": "",
                          "lastname": "",
                          "address1": "Hoofdstraat 12",
                          "address2": "",
                          "zipcode": "1234AB",
                          "city": "Amsterdam",
                          "country": "NL",
                          "phone": "",
                          "delivery_method": "Email",
                          "customer_id": "1",
                          "tax_number": "",
                          "chamber_of_commerce": "",
                          "bank_account": "",
                          "is_trusted": false,
                          "max_transfer_amount": null,
                          "attention": "",
                          "email": "info@example.com",
                          "email_ubl": true,
                          "send_invoices_to_attention": "",
                          "send_invoices_to_email": "info@example.com",
                          "send_estimates_to_attention": "",
                          "send_estimates_to_email": "info@example.com",
                          "direct_debit": false,
                          "sepa_active": false,
                          "sepa_iban": "",
                          "sepa_iban_account_name": "",
                          "sepa_bic": "",
                          "sepa_mandate_id": "",
                          "sepa_mandate_date": null,
                          "sepa_sequence_type": "RCUR",
                          "credit_card_number": "",
                          "credit_card_reference": "",
                          "credit_card_type": null,
                          "tax_number_validated_at": null,
                          "tax_number_valid": null,
                          "invoice_workflow_id": null,
                          "estimate_workflow_id": null,
                          "si_identifier": "",
                          "si_identifier_type": null,
                          "moneybird_payments_mandate": false,
                          "created_at": "2026-11-02T12:15:36.533Z",
                          "updated_at": "2026-11-02T12:15:36.533Z",
                          "version": 1793621736,
                          "sales_invoices_url": "https://moneybird.dev/123/sales_invoices/dadcbaa9db9dfe3368ea3dcdd7423e59e8a997e760ef42ad643dda983eee9efd/all",
                          "notes": [],
                          "custom_fields": [],
                          "contact_people": [],
                          "archived": false
                        },
                        "contact_person_id": null,
                        "contact_person": null,
                        "subscription_products": [
                          {
                            "start_date": "2017-01-01",
                            "end_date": null,
                            "product_id": "502689132526437497",
                            "product": {
                              "id": "502689132526437497",
                              "administration_id": 123,
                              "description": "My product description",
                              "title": null,
                              "identifier": null,
                              "price": "20.0",
                              "currency": "EUR",
                              "frequency": 1,
                              "frequency_type": "month",
                              "tax_rate_id": "502689108899923082",
                              "ledger_account_id": "502689108787725434",
                              "created_at": "2026-11-02T12:15:36.547Z",
                              "updated_at": "2026-11-02T12:15:36.547Z"
                            },
                            "amount": "1 x",
                            "discount": "0.0"
                          }
                        ],
                        "recurring_sales_invoice_id": "502689132553700478"
                      }
                    ]
                  }
                }
              }
            }
          }
        },
        "operationId": "get_administration_id_subscriptions"
      },
      "post": {
        "summary": "Create a new subscription",
        "description": "Starts a new subscription for the given contact. The `product_id` points to a product with a frequency, price and description.\nA recurring sales invoice is automatically created to bill the contact for the given frequency. The first invoice will be sent on the\nstart date, but no sooner than tomorrow. The `reference` will be added to the sales invoices.\n\nOptionally you can create a subscription with a different frequency than stored in the product. Make sure the frequency of the product\nand the provided frequency are compatible. E.g. you can bill a monthly product yearly.\n\n### Required scope(s)\n `sales_invoices`",
        "tags": [
          "Subscriptions"
        ],
        "security": [
          {
            "bearerAuth": [
              "sales_invoices"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/administration_id"
          },
          {
            "$ref": "#/components/parameters/format"
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/*": {
              "schema": {
                "unevaluatedProperties": false,
                "type": "object",
                "properties": {
                  "subscription": {
                    "type": "object",
                    "unevaluatedProperties": false,
                    "properties": {
                      "start_date": {
                        "type": "string",
                        "format": "date"
                      },
                      "product_id": {
                        "$ref": "#/components/schemas/identifier",
                        "description": "Should be a valid product id."
                      },
                      "amount": {
                        "type": "string",
                        "description": "Quantity of the product billed each period."
                      },
                      "discount": {
                        "$ref": "#/components/schemas/number",
                        "description": "Both a decimal and a string '10,95' are accepted."
                      },
                      "contact_id": {
                        "$ref": "#/components/schemas/identifier",
                        "description": "Should be a valid contact id."
                      },
                      "contact_person_id": {
                        "$ref": "#/components/schemas/identifier",
                        "description": "Should be a valid contact person id."
                      },
                      "end_date": {
                        "type": "string",
                        "format": "date"
                      },
                      "reference": {
                        "type": "string"
                      },
                      "document_style_id": {
                        "$ref": "#/components/schemas/identifier",
                        "description": "Should be a valid document style id."
                      },
                      "frequency": {
                        "type": "integer",
                        "description": "Number of periods between invoices, combined with `frequency_type`. Must be compatible with the product's frequency (e.g. a monthly product can be billed yearly). Defaults to the product's frequency."
                      },
                      "frequency_type": {
                        "type": "string",
                        "enum": [
                          "day",
                          "week",
                          "month",
                          "quarter",
                          "year"
                        ],
                        "description": "Length of a single billing period, combined with `frequency`. Defaults to the product's frequency type."
                      },
                      "mergeable": {
                        "type": [
                          "boolean",
                          "string"
                        ],
                        "default": false,
                        "description": "Merge invoices from this subscription with other mergeable invoices for the same contact before sending. Only applies when invoices are sent automatically."
                      },
                      "prices_are_incl_tax": {
                        "type": [
                          "boolean",
                          "string"
                        ],
                        "default": false,
                        "description": "Whether the amounts on the generated invoices are inclusive of tax."
                      }
                    },
                    "required": [
                      "start_date",
                      "product_id",
                      "contact_id"
                    ]
                  }
                },
                "required": [
                  "subscription"
                ]
              },
              "examples": {
                "CreatesANewSubscriptionForTheContact": {
                  "summary": "Creates a new subscription for the contact",
                  "value": {
                    "subscription": {
                      "start_date": "2026-11-03",
                      "contact_id": 502689130288777100,
                      "product_id": 502689130300311400,
                      "reference": "moneybird.nl",
                      "discount": 10,
                      "amount": "5x"
                    }
                  }
                }
              }
            }
          }
        },
        "responses": {
          "201": {
            "description": "Subscription created",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/subscription_response"
                },
                "examples": {
                  "CreatesANewSubscriptionForTheContact": {
                    "summary": "Creates a new subscription for the contact",
                    "value": {
                      "id": "502689130317088648",
                      "administration_id": 123,
                      "start_date": "2026-11-03",
                      "end_date": null,
                      "frequency": 1,
                      "frequency_type": "month",
                      "reference": "moneybird.nl",
                      "cancelled_at": null,
                      "product_id": "502689130300311430",
                      "product": {
                        "id": "502689130300311430",
                        "administration_id": 123,
                        "description": "My product description",
                        "title": null,
                        "identifier": null,
                        "price": "20.0",
                        "currency": "EUR",
                        "frequency": 1,
                        "frequency_type": "month",
                        "tax_rate_id": "502689108899923082",
                        "ledger_account_id": "502689108787725434",
                        "created_at": "2026-11-02T12:15:34.425Z",
                        "updated_at": "2026-11-02T12:15:34.425Z"
                      },
                      "contact_id": "502689130288777092",
                      "contact": {
                        "id": "502689130288777092",
                        "administration_id": 123,
                        "company_name": "Foobar Holding B.V.",
                        "firstname": "",
                        "lastname": "",
                        "address1": "Hoofdstraat 12",
                        "address2": "",
                        "zipcode": "1234AB",
                        "city": "Amsterdam",
                        "country": "NL",
                        "phone": "",
                        "delivery_method": "Email",
                        "customer_id": "1",
                        "tax_number": "",
                        "chamber_of_commerce": "",
                        "bank_account": "",
                        "is_trusted": false,
                        "max_transfer_amount": null,
                        "attention": "",
                        "email": "info@example.com",
                        "email_ubl": true,
                        "send_invoices_to_attention": "",
                        "send_invoices_to_email": "info@example.com",
                        "send_estimates_to_attention": "",
                        "send_estimates_to_email": "info@example.com",
                        "direct_debit": false,
                        "sepa_active": false,
                        "sepa_iban": "",
                        "sepa_iban_account_name": "",
                        "sepa_bic": "",
                        "sepa_mandate_id": "",
                        "sepa_mandate_date": null,
                        "sepa_sequence_type": "RCUR",
                        "credit_card_number": "",
                        "credit_card_reference": "",
                        "credit_card_type": null,
                        "tax_number_validated_at": null,
                        "tax_number_valid": null,
                        "invoice_workflow_id": null,
                        "estimate_workflow_id": null,
                        "si_identifier": "",
                        "si_identifier_type": null,
                        "moneybird_payments_mandate": false,
                        "created_at": "2026-11-02T12:15:34.413Z",
                        "updated_at": "2026-11-02T12:15:34.413Z",
                        "version": 1793621734,
                        "sales_invoices_url": "https://moneybird.dev/123/sales_invoices/6c8597fa07ca10fc0e34e906ea9c0780f2a85303e12b1be7e2ed4f321967ba5a/all",
                        "notes": [],
                        "custom_fields": [],
                        "contact_people": [],
                        "archived": false
                      },
                      "contact_person_id": null,
                      "contact_person": null,
                      "subscription_products": [
                        {
                          "start_date": "2026-11-03",
                          "end_date": null,
                          "product_id": "502689130300311430",
                          "product": {
                            "id": "502689130300311430",
                            "administration_id": 123,
                            "description": "My product description",
                            "title": null,
                            "identifier": null,
                            "price": "20.0",
                            "currency": "EUR",
                            "frequency": 1,
                            "frequency_type": "month",
                            "tax_rate_id": "502689108899923082",
                            "ledger_account_id": "502689108787725434",
                            "created_at": "2026-11-02T12:15:34.425Z",
                            "updated_at": "2026-11-02T12:15:34.425Z"
                          },
                          "amount": "5x",
                          "discount": "10.0"
                        }
                      ],
                      "recurring_sales_invoice_id": "502689130337011595"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "$ref": "#/components/responses/400_bad_request"
          },
          "402": {
            "$ref": "#/components/responses/402_payment_required"
          },
          "422": {
            "$ref": "#/components/responses/422_unprocessable_entity"
          }
        },
        "operationId": "post_administration_id_subscriptions"
      }
    },
    "/{administration_id}/task_list_groups/{id}{format}": {
      "get": {
        "summary": "Returns information about a task list group",
        "description": "Returns information about a task list group, including its tasks.\n\n### Required scope(s)\n All of: `bank`, `documents`, `estimates`, `sales_invoices`, `settings` and `time_entries`",
        "tags": [
          "Task lists"
        ],
        "security": [
          {
            "bearerAuth": [
              "bank",
              "documents",
              "estimates",
              "sales_invoices",
              "settings",
              "time_entries"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/administration_id"
          },
          {
            "name": "id",
            "in": "path",
            "required": true,
            "schema": {
              "$ref": "#/components/schemas/identifier"
            }
          },
          {
            "$ref": "#/components/parameters/format"
          }
        ],
        "responses": {
          "200": {
            "description": "A task list group",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/task_list_group_response"
                },
                "examples": {
                  "ReturnsASingleGroup": {
                    "summary": "Returns a single group",
                    "value": {
                      "id": "502689197700679600",
                      "name": "Task list group #2",
                      "row_order": 1,
                      "report_type": null,
                      "created_at": "2026-11-02T12:16:38.703Z",
                      "updated_at": "2026-11-02T12:16:38.703Z",
                      "tasks": [
                        {
                          "id": "502689197701728177",
                          "administration_id": 123,
                          "name": "Task #2",
                          "description": "Description 2",
                          "row_order": 0,
                          "completed_at": null,
                          "report_type": null,
                          "task_lists_group_id": "502689197700679600",
                          "parent_task_id": null,
                          "created_at": "2026-11-02T12:16:38.703Z",
                          "updated_at": "2026-11-02T12:16:38.703Z",
                          "assignee_id": null,
                          "subtasks": [],
                          "notes": [],
                          "events": [
                            {
                              "administration_id": 123,
                              "user_id": "502689108256097381",
                              "action": "task_lists_task_created",
                              "link_entity_id": null,
                              "link_entity_type": null,
                              "data": {},
                              "created_at": "2026-11-02T12:16:38.705Z",
                              "updated_at": "2026-11-02T12:16:38.705Z"
                            }
                          ]
                        }
                      ]
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Not found",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/symbolic_error"
                },
                "examples": {
                  "Returns404WhenGroupDoesNotExist": {
                    "summary": "Returns 404 when group does not exist",
                    "value": {
                      "error": "Record not found for model name: Group"
                    }
                  }
                }
              }
            }
          }
        },
        "operationId": "get_administration_id_task_list_groups_id"
      },
      "patch": {
        "summary": "Updates a task list group",
        "description": "Updates a task list group's name or report type. Updating the report type will destroy all tasks and generate new tasks based on the new report.\n\n### Required scope(s)\n All of: `bank`, `documents`, `estimates`, `sales_invoices`, `settings` and `time_entries`",
        "tags": [
          "Task lists"
        ],
        "security": [
          {
            "bearerAuth": [
              "bank",
              "documents",
              "estimates",
              "sales_invoices",
              "settings",
              "time_entries"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/administration_id"
          },
          {
            "name": "id",
            "in": "path",
            "required": true,
            "schema": {
              "$ref": "#/components/schemas/identifier"
            }
          },
          {
            "$ref": "#/components/parameters/format"
          }
        ],
        "requestBody": {
          "content": {
            "application/*": {
              "schema": {
                "unevaluatedProperties": false,
                "type": "object",
                "properties": {
                  "group": {
                    "type": "object",
                    "unevaluatedProperties": false,
                    "properties": {
                      "name": {
                        "type": "string"
                      },
                      "report_type": {
                        "type": "string",
                        "enum": [
                          "balance_sheet",
                          "profit_loss",
                          "debtor",
                          "creditor",
                          "assets"
                        ],
                        "description": "Report this group is based on; its tasks are generated from the report."
                      }
                    }
                  }
                }
              },
              "examples": {
                "UpdatesAGroupWithoutParams": {
                  "summary": "Updates a group without params",
                  "value": {}
                },
                "UpdatesAGroup": {
                  "summary": "Updates a group",
                  "value": {
                    "group": {
                      "name": "Updated Group"
                    }
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Group updated",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/task_list_group_response"
                },
                "examples": {
                  "UpdatesAGroupWithoutParams": {
                    "summary": "Updates a group without params",
                    "value": {
                      "id": "502689198056145921",
                      "name": "Task list group #2",
                      "row_order": 1,
                      "report_type": null,
                      "created_at": "2026-11-02T12:16:39.042Z",
                      "updated_at": "2026-11-02T12:16:39.042Z",
                      "tasks": [
                        {
                          "id": "502689198057194498",
                          "administration_id": 123,
                          "name": "Task #2",
                          "description": "Description 2",
                          "row_order": 0,
                          "completed_at": null,
                          "report_type": null,
                          "task_lists_group_id": "502689198056145921",
                          "parent_task_id": null,
                          "created_at": "2026-11-02T12:16:39.042Z",
                          "updated_at": "2026-11-02T12:16:39.042Z",
                          "assignee_id": null,
                          "subtasks": [],
                          "notes": [],
                          "events": [
                            {
                              "administration_id": 123,
                              "user_id": "502689108256097381",
                              "action": "task_lists_task_created",
                              "link_entity_id": null,
                              "link_entity_type": null,
                              "data": {},
                              "created_at": "2026-11-02T12:16:39.043Z",
                              "updated_at": "2026-11-02T12:16:39.043Z"
                            }
                          ]
                        }
                      ]
                    }
                  },
                  "UpdatesAGroup": {
                    "summary": "Updates a group",
                    "value": {
                      "id": "502689198100186121",
                      "name": "Updated Group",
                      "row_order": 1,
                      "report_type": null,
                      "created_at": "2026-11-02T12:16:39.084Z",
                      "updated_at": "2026-11-02T12:16:39.098Z",
                      "tasks": [
                        {
                          "id": "502689198101234698",
                          "administration_id": 123,
                          "name": "Task #2",
                          "description": "Description 2",
                          "row_order": 0,
                          "completed_at": null,
                          "report_type": null,
                          "task_lists_group_id": "502689198100186121",
                          "parent_task_id": null,
                          "created_at": "2026-11-02T12:16:39.084Z",
                          "updated_at": "2026-11-02T12:16:39.084Z",
                          "assignee_id": null,
                          "subtasks": [],
                          "notes": [],
                          "events": [
                            {
                              "administration_id": 123,
                              "user_id": "502689108256097381",
                              "action": "task_lists_task_created",
                              "link_entity_id": null,
                              "link_entity_type": null,
                              "data": {},
                              "created_at": "2026-11-02T12:16:39.085Z",
                              "updated_at": "2026-11-02T12:16:39.085Z"
                            }
                          ]
                        }
                      ]
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Not found",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/symbolic_error"
                },
                "examples": {
                  "Returns404WhenGroupDoesNotExist": {
                    "summary": "Returns 404 when group does not exist",
                    "value": {
                      "error": "Record not found for model name: Group"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "Unprocessable entity",
            "content": {
              "application/json": {
                "schema": {
                  "anyOf": [
                    {
                      "$ref": "#/components/schemas/symbolic_error"
                    },
                    {
                      "$ref": "#/components/schemas/non_symbolic_error"
                    }
                  ]
                },
                "examples": {
                  "Returns422WhenTryingToUpdateAVirtualGroup": {
                    "summary": "Returns 422 when trying to update a virtual group",
                    "value": {
                      "error": "The first group cannot be modified"
                    }
                  }
                }
              }
            }
          }
        },
        "operationId": "patch_administration_id_task_list_groups_id"
      },
      "delete": {
        "summary": "Deletes a task list group",
        "description": "Permanently deletes a task list group and all its tasks.\n\n### Required scope(s)\n All of: `bank`, `documents`, `estimates`, `sales_invoices`, `settings` and `time_entries`",
        "tags": [
          "Task lists"
        ],
        "security": [
          {
            "bearerAuth": [
              "bank",
              "documents",
              "estimates",
              "sales_invoices",
              "settings",
              "time_entries"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/administration_id"
          },
          {
            "name": "id",
            "in": "path",
            "required": true,
            "schema": {
              "$ref": "#/components/schemas/identifier"
            }
          },
          {
            "$ref": "#/components/parameters/format"
          }
        ],
        "responses": {
          "204": {
            "description": "Group deleted"
          },
          "404": {
            "description": "Not found",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/symbolic_error"
                },
                "examples": {
                  "Returns404WhenGroupDoesNotExist": {
                    "summary": "Returns 404 when group does not exist",
                    "value": {
                      "error": "Record not found for model name: Group"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "Unprocessable entity",
            "content": {
              "application/json": {
                "schema": {
                  "anyOf": [
                    {
                      "$ref": "#/components/schemas/symbolic_error"
                    },
                    {
                      "$ref": "#/components/schemas/non_symbolic_error"
                    }
                  ]
                },
                "examples": {
                  "Returns422WhenTryingToDeleteAVirtualGroup": {
                    "summary": "Returns 422 when trying to delete a virtual group",
                    "value": {
                      "error": "The first group cannot be deleted"
                    }
                  }
                }
              }
            }
          }
        },
        "operationId": "delete_administration_id_task_list_groups_id"
      }
    },
    "/{administration_id}/task_list_groups/{task_list_group_id}/tasks{format}": {
      "post": {
        "summary": "Creates a new task in a group",
        "description": "Creates a new task in the specified task list group.\n\n### Required scope(s)\n All of: `bank`, `documents`, `estimates`, `sales_invoices`, `settings` and `time_entries`",
        "tags": [
          "Task lists"
        ],
        "security": [
          {
            "bearerAuth": [
              "bank",
              "documents",
              "estimates",
              "sales_invoices",
              "settings",
              "time_entries"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/administration_id"
          },
          {
            "name": "task_list_group_id",
            "in": "path",
            "required": true,
            "schema": {
              "$ref": "#/components/schemas/identifier"
            }
          },
          {
            "$ref": "#/components/parameters/format"
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/*": {
              "schema": {
                "unevaluatedProperties": false,
                "type": "object",
                "properties": {
                  "task": {
                    "type": "object",
                    "unevaluatedProperties": false,
                    "properties": {
                      "name": {
                        "type": "string"
                      },
                      "description": {
                        "type": "string"
                      },
                      "report_type": {
                        "type": "string",
                        "enum": [
                          "balance_sheet",
                          "profit_loss",
                          "debtor",
                          "creditor",
                          "assets"
                        ],
                        "description": "Report this task is based on; its content is generated from the report."
                      },
                      "assignee_id": {
                        "$ref": "#/components/schemas/identifier",
                        "description": "ID of the user to assign the task to."
                      },
                      "related_entity_id": {
                        "$ref": "#/components/schemas/identifier_nullable",
                        "description": "The ID of a ledger account to link to the task"
                      },
                      "generate_subtasks": {
                        "type": "boolean",
                        "description": "Whether to generate subtasks based on the related entity's children"
                      }
                    },
                    "required": [
                      "name"
                    ]
                  }
                }
              },
              "examples": {
                "CreatesANewTask": {
                  "summary": "Creates a new task",
                  "value": {
                    "task": {
                      "name": "New Task"
                    }
                  }
                }
              }
            }
          }
        },
        "responses": {
          "201": {
            "description": "Task created",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/task_list_task_response"
                },
                "examples": {
                  "CreatesANewTask": {
                    "summary": "Creates a new task",
                    "value": {
                      "id": "502689197799245765",
                      "administration_id": 123,
                      "name": "New Task",
                      "description": null,
                      "row_order": 1,
                      "completed_at": null,
                      "report_type": null,
                      "task_lists_group_id": "502689197785614274",
                      "parent_task_id": null,
                      "created_at": "2026-11-02T12:16:38.797Z",
                      "updated_at": "2026-11-02T12:16:38.797Z",
                      "assignee_id": null,
                      "subtasks": [],
                      "notes": [],
                      "events": [
                        {
                          "administration_id": 123,
                          "user_id": "502689108256097381",
                          "action": "task_lists_task_created",
                          "link_entity_id": null,
                          "link_entity_type": null,
                          "data": {},
                          "created_at": "2026-11-02T12:16:38.798Z",
                          "updated_at": "2026-11-02T12:16:38.798Z"
                        }
                      ]
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "Bad request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/symbolic_error"
                },
                "examples": {
                  "Returns400WhenParametersAreInvalid": {
                    "summary": "Returns 400 when parameters are invalid",
                    "value": {
                      "error": "task[name] is missing"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Not found",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/symbolic_error"
                },
                "examples": {
                  "Returns404WhenGroupDoesNotExist": {
                    "summary": "Returns 404 when group does not exist",
                    "value": {
                      "error": "Record not found for model name: Group"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "Unprocessable entity",
            "content": {
              "application/json": {
                "schema": {
                  "anyOf": [
                    {
                      "$ref": "#/components/schemas/symbolic_error"
                    },
                    {
                      "$ref": "#/components/schemas/non_symbolic_error"
                    }
                  ]
                },
                "examples": {
                  "Returns422WhenGroupHasGeneratedTasks": {
                    "summary": "Returns 422 when group has generated tasks",
                    "value": {
                      "error": "Tasks cannot be added to a group with generated tasks"
                    }
                  },
                  "Returns422WhenNameIsMissing": {
                    "summary": "Returns 422 when name is missing",
                    "value": {
                      "error": "Name can't be blank"
                    }
                  }
                }
              }
            }
          }
        },
        "operationId": "post_administration_id_task_list_groups_task_list_group_id_tasks"
      }
    },
    "/{administration_id}/task_list_tasks/{id}{format}": {
      "get": {
        "summary": "Returns information about a task",
        "description": "Returns information about a task, including its subtasks, notes, and events.\n\n### Required scope(s)\n All of: `bank`, `documents`, `estimates`, `sales_invoices`, `settings` and `time_entries`",
        "tags": [
          "Task lists"
        ],
        "security": [
          {
            "bearerAuth": [
              "bank",
              "documents",
              "estimates",
              "sales_invoices",
              "settings",
              "time_entries"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/administration_id"
          },
          {
            "name": "id",
            "in": "path",
            "required": true,
            "schema": {
              "$ref": "#/components/schemas/identifier"
            }
          },
          {
            "$ref": "#/components/parameters/format"
          }
        ],
        "responses": {
          "200": {
            "description": "A task",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/task_list_task_response"
                },
                "examples": {
                  "ReturnsASingleTask": {
                    "summary": "Returns a single task",
                    "value": {
                      "id": "502689278170498854",
                      "administration_id": 123,
                      "name": "Task #1",
                      "description": "Description 1",
                      "row_order": 0,
                      "completed_at": null,
                      "report_type": null,
                      "task_lists_group_id": "502689278170498853",
                      "parent_task_id": null,
                      "created_at": "2026-11-02T12:17:55.445Z",
                      "updated_at": "2026-11-02T12:17:55.445Z",
                      "assignee_id": null,
                      "subtasks": [],
                      "notes": [],
                      "events": [
                        {
                          "administration_id": 123,
                          "user_id": "502689108256097381",
                          "action": "task_lists_task_created",
                          "link_entity_id": null,
                          "link_entity_type": null,
                          "data": {},
                          "created_at": "2026-11-02T12:17:55.446Z",
                          "updated_at": "2026-11-02T12:17:55.446Z"
                        }
                      ]
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Not found",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/symbolic_error"
                },
                "examples": {
                  "Returns404WhenTaskDoesNotExist": {
                    "summary": "Returns 404 when task does not exist",
                    "value": {
                      "error": "Record not found for model name: Task"
                    }
                  }
                }
              }
            }
          }
        },
        "operationId": "get_administration_id_task_list_tasks_id"
      },
      "patch": {
        "summary": "Updates a task",
        "description": "Updates a task's attributes.\n\n### Required scope(s)\n All of: `bank`, `documents`, `estimates`, `sales_invoices`, `settings` and `time_entries`",
        "tags": [
          "Task lists"
        ],
        "security": [
          {
            "bearerAuth": [
              "bank",
              "documents",
              "estimates",
              "sales_invoices",
              "settings",
              "time_entries"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/administration_id"
          },
          {
            "name": "id",
            "in": "path",
            "required": true,
            "schema": {
              "$ref": "#/components/schemas/identifier"
            }
          },
          {
            "$ref": "#/components/parameters/format"
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/*": {
              "schema": {
                "unevaluatedProperties": false,
                "type": "object",
                "properties": {
                  "task": {
                    "type": "object",
                    "unevaluatedProperties": false,
                    "properties": {
                      "name": {
                        "type": "string"
                      },
                      "description": {
                        "type": "string"
                      },
                      "report_type": {
                        "type": "string",
                        "enum": [
                          "balance_sheet",
                          "profit_loss",
                          "debtor",
                          "creditor",
                          "assets"
                        ],
                        "description": "Report this task is based on; its content is generated from the report."
                      },
                      "assignee_id": {
                        "$ref": "#/components/schemas/identifier",
                        "description": "ID of the user to assign the task to."
                      },
                      "related_entity_id": {
                        "$ref": "#/components/schemas/identifier_nullable",
                        "description": "The ID of a ledger account to link to the task"
                      },
                      "generate_subtasks": {
                        "type": "boolean",
                        "description": "Whether to generate subtasks based on the related entity's children"
                      }
                    }
                  }
                }
              },
              "examples": {
                "UpdatesATask": {
                  "summary": "Updates a task",
                  "value": {
                    "task": {
                      "name": "Updated Task"
                    }
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Task updated",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/task_list_task_response"
                },
                "examples": {
                  "UpdatesATask": {
                    "summary": "Updates a task",
                    "value": {
                      "id": "502689278538549095",
                      "administration_id": 123,
                      "name": "Updated Task",
                      "description": "Description 1",
                      "row_order": 0,
                      "completed_at": null,
                      "report_type": null,
                      "task_lists_group_id": "502689278537500518",
                      "parent_task_id": null,
                      "created_at": "2026-11-02T12:17:55.796Z",
                      "updated_at": "2026-11-02T12:17:55.815Z",
                      "assignee_id": null,
                      "subtasks": [],
                      "notes": [],
                      "events": [
                        {
                          "administration_id": 123,
                          "user_id": "502689108256097381",
                          "action": "task_lists_task_created",
                          "link_entity_id": null,
                          "link_entity_type": null,
                          "data": {},
                          "created_at": "2026-11-02T12:17:55.796Z",
                          "updated_at": "2026-11-02T12:17:55.796Z"
                        },
                        {
                          "administration_id": 123,
                          "user_id": "502689108256097381",
                          "action": "task_lists_task_name",
                          "link_entity_id": null,
                          "link_entity_type": null,
                          "data": {
                            "name": "Updated Task"
                          },
                          "created_at": "2026-11-02T12:17:55.816Z",
                          "updated_at": "2026-11-02T12:17:55.816Z"
                        }
                      ]
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "Bad request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/symbolic_error"
                },
                "examples": {
                  "Returns400WhenRequiredParamsAreMissing": {
                    "summary": "Returns 400 when required params are missing",
                    "value": {
                      "error": "task is missing"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Not found",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/symbolic_error"
                },
                "examples": {
                  "Returns404WhenTaskDoesNotExist": {
                    "summary": "Returns 404 when task does not exist",
                    "value": {
                      "error": "Record not found for model name: Task"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "Unprocessable entity",
            "content": {
              "application/json": {
                "schema": {
                  "anyOf": [
                    {
                      "$ref": "#/components/schemas/symbolic_error"
                    },
                    {
                      "$ref": "#/components/schemas/non_symbolic_error"
                    }
                  ]
                },
                "examples": {
                  "Returns422WhenNameIsEmpty": {
                    "summary": "Returns 422 when name is empty",
                    "value": {
                      "error": "Name can't be blank"
                    }
                  }
                }
              }
            }
          }
        },
        "operationId": "patch_administration_id_task_list_tasks_id"
      },
      "delete": {
        "summary": "Deletes a task",
        "description": "Permanently deletes a task and all its subtasks. Generated tasks cannot be deleted.\n\n### Required scope(s)\n All of: `bank`, `documents`, `estimates`, `sales_invoices`, `settings` and `time_entries`",
        "tags": [
          "Task lists"
        ],
        "security": [
          {
            "bearerAuth": [
              "bank",
              "documents",
              "estimates",
              "sales_invoices",
              "settings",
              "time_entries"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/administration_id"
          },
          {
            "name": "id",
            "in": "path",
            "required": true,
            "schema": {
              "$ref": "#/components/schemas/identifier"
            }
          },
          {
            "$ref": "#/components/parameters/format"
          }
        ],
        "responses": {
          "204": {
            "description": "Task deleted"
          },
          "404": {
            "description": "Not found",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/symbolic_error"
                },
                "examples": {
                  "Returns404WhenTaskDoesNotExist": {
                    "summary": "Returns 404 when task does not exist",
                    "value": {
                      "error": "Record not found for model name: Task"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "Unprocessable entity",
            "content": {
              "application/json": {
                "schema": {
                  "anyOf": [
                    {
                      "$ref": "#/components/schemas/symbolic_error"
                    },
                    {
                      "$ref": "#/components/schemas/non_symbolic_error"
                    }
                  ]
                },
                "examples": {
                  "Returns422WhenTaskIsGenerated": {
                    "summary": "Returns 422 when task is generated",
                    "value": {
                      "error": "Generated tasks cannot be deleted"
                    }
                  }
                }
              }
            }
          }
        },
        "operationId": "delete_administration_id_task_list_tasks_id"
      }
    },
    "/{administration_id}/task_list_tasks/{task_list_task_id}/assignment{format}": {
      "post": {
        "summary": "Assigns a user to a task",
        "description": "Assigns a user to the specified task.\n\n### Required scope(s)\n All of: `bank`, `documents`, `estimates`, `sales_invoices`, `settings` and `time_entries`",
        "tags": [
          "Task lists"
        ],
        "security": [
          {
            "bearerAuth": [
              "bank",
              "documents",
              "estimates",
              "sales_invoices",
              "settings",
              "time_entries"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/administration_id"
          },
          {
            "name": "task_list_task_id",
            "in": "path",
            "required": true,
            "schema": {
              "$ref": "#/components/schemas/identifier"
            }
          },
          {
            "$ref": "#/components/parameters/format"
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/*": {
              "schema": {
                "unevaluatedProperties": false,
                "type": "object",
                "properties": {
                  "assignee_id": {
                    "$ref": "#/components/schemas/identifier",
                    "description": "The ID of the user to assign to the task. A user must have permissions to a task or else a 404 will be thrown."
                  }
                },
                "required": [
                  "assignee_id"
                ]
              },
              "examples": {
                "AssignsAUserToTheTask": {
                  "summary": "Assigns a user to the task",
                  "value": {
                    "assignee_id": "502689108270777446"
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "User assigned to task",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/task_list_task_response"
                },
                "examples": {
                  "AssignsAUserToTheTask": {
                    "summary": "Assigns a user to the task",
                    "value": {
                      "id": "502689278434740054",
                      "administration_id": 123,
                      "name": "Task #1",
                      "description": "Description 1",
                      "row_order": 0,
                      "completed_at": null,
                      "report_type": null,
                      "task_lists_group_id": "502689278434740053",
                      "parent_task_id": null,
                      "created_at": "2026-11-02T12:17:55.697Z",
                      "updated_at": "2026-11-02T12:17:55.697Z",
                      "assignee_id": "502689108270777446",
                      "subtasks": [],
                      "notes": [],
                      "events": [
                        {
                          "administration_id": 123,
                          "user_id": "502689108256097381",
                          "action": "task_lists_task_created",
                          "link_entity_id": null,
                          "link_entity_type": null,
                          "data": {},
                          "created_at": "2026-11-02T12:17:55.698Z",
                          "updated_at": "2026-11-02T12:17:55.698Z"
                        },
                        {
                          "administration_id": 123,
                          "user_id": "502689108256097381",
                          "action": "task_lists_task_assigned",
                          "link_entity_id": null,
                          "link_entity_type": null,
                          "data": {
                            "assignee": "Mo Neybird"
                          },
                          "created_at": "2026-11-02T12:17:55.711Z",
                          "updated_at": "2026-11-02T12:17:55.711Z"
                        }
                      ]
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Not found",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/symbolic_error"
                },
                "examples": {
                  "Returns404WhenAssigneeIdIsInvalid": {
                    "summary": "Returns 404 when assignee id is invalid",
                    "value": {
                      "error": "Assignee not found"
                    }
                  },
                  "Returns404WhenTaskDoesNotExist": {
                    "summary": "Returns 404 when task does not exist",
                    "value": {
                      "error": "Record not found for model name: Task"
                    }
                  }
                }
              }
            }
          }
        },
        "operationId": "post_administration_id_task_list_tasks_task_list_task_id_assignment"
      },
      "delete": {
        "summary": "Unassigns the user from a task",
        "description": "Removes the current assignment from the specified task.\n\n### Required scope(s)\n All of: `bank`, `documents`, `estimates`, `sales_invoices`, `settings` and `time_entries`",
        "tags": [
          "Task lists"
        ],
        "security": [
          {
            "bearerAuth": [
              "bank",
              "documents",
              "estimates",
              "sales_invoices",
              "settings",
              "time_entries"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/administration_id"
          },
          {
            "name": "task_list_task_id",
            "in": "path",
            "required": true,
            "schema": {
              "$ref": "#/components/schemas/identifier"
            }
          },
          {
            "$ref": "#/components/parameters/format"
          }
        ],
        "responses": {
          "200": {
            "description": "User unassigned from task",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/task_list_task_response"
                },
                "examples": {
                  "UnassignsTheTask": {
                    "summary": "Unassigns the task",
                    "value": {
                      "id": "502689278475634525",
                      "administration_id": 123,
                      "name": "Task #1",
                      "description": "Description 1",
                      "row_order": 0,
                      "completed_at": null,
                      "report_type": null,
                      "task_lists_group_id": "502689278474585948",
                      "parent_task_id": null,
                      "created_at": "2026-11-02T12:17:55.735Z",
                      "updated_at": "2026-11-02T12:17:55.735Z",
                      "assignee_id": null,
                      "subtasks": [],
                      "notes": [],
                      "events": [
                        {
                          "administration_id": 123,
                          "user_id": "502689108256097381",
                          "action": "task_lists_task_created",
                          "link_entity_id": null,
                          "link_entity_type": null,
                          "data": {},
                          "created_at": "2026-11-02T12:17:55.736Z",
                          "updated_at": "2026-11-02T12:17:55.736Z"
                        }
                      ]
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Not found",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/symbolic_error"
                },
                "examples": {
                  "Returns404WhenTaskDoesNotExist": {
                    "summary": "Returns 404 when task does not exist",
                    "value": {
                      "error": "Record not found for model name: Task"
                    }
                  }
                }
              }
            }
          }
        },
        "operationId": "delete_administration_id_task_list_tasks_task_list_task_id_assignment"
      }
    },
    "/{administration_id}/task_list_tasks/{task_list_task_id}/completion{format}": {
      "post": {
        "summary": "Completes a task",
        "description": "Marks a task and all its subtasks as completed.\n\n### Required scope(s)\n All of: `bank`, `documents`, `estimates`, `sales_invoices`, `settings` and `time_entries`",
        "tags": [
          "Task lists"
        ],
        "security": [
          {
            "bearerAuth": [
              "bank",
              "documents",
              "estimates",
              "sales_invoices",
              "settings",
              "time_entries"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/administration_id"
          },
          {
            "name": "task_list_task_id",
            "in": "path",
            "required": true,
            "schema": {
              "$ref": "#/components/schemas/identifier"
            }
          },
          {
            "$ref": "#/components/parameters/format"
          }
        ],
        "responses": {
          "200": {
            "description": "Task completed",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/task_list_task_response"
                },
                "examples": {
                  "CompletesTheTask": {
                    "summary": "Completes the task",
                    "value": {
                      "id": "502689278326736705",
                      "administration_id": 123,
                      "name": "Task #1",
                      "description": "Description 1",
                      "row_order": 0,
                      "completed_at": "2026-11-02T12:17:55.604Z",
                      "report_type": null,
                      "task_lists_group_id": "502689278325688128",
                      "parent_task_id": null,
                      "created_at": "2026-11-02T12:17:55.593Z",
                      "updated_at": "2026-11-02T12:17:55.604Z",
                      "assignee_id": null,
                      "subtasks": [],
                      "notes": [],
                      "events": [
                        {
                          "administration_id": 123,
                          "user_id": "502689108256097381",
                          "action": "task_lists_task_created",
                          "link_entity_id": null,
                          "link_entity_type": null,
                          "data": {},
                          "created_at": "2026-11-02T12:17:55.594Z",
                          "updated_at": "2026-11-02T12:17:55.594Z"
                        },
                        {
                          "administration_id": 123,
                          "user_id": "502689108256097381",
                          "action": "task_lists_task_completed",
                          "link_entity_id": null,
                          "link_entity_type": null,
                          "data": {},
                          "created_at": "2026-11-02T12:17:55.606Z",
                          "updated_at": "2026-11-02T12:17:55.606Z"
                        }
                      ]
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Not found",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/symbolic_error"
                },
                "examples": {
                  "Returns404WhenTaskDoesNotExist": {
                    "summary": "Returns 404 when task does not exist",
                    "value": {
                      "error": "Record not found for model name: Task"
                    }
                  }
                }
              }
            }
          }
        },
        "operationId": "post_administration_id_task_list_tasks_task_list_task_id_completion"
      },
      "delete": {
        "summary": "Reopens a task",
        "description": "Reopens a completed task and possible parent tasks.\n\n### Required scope(s)\n All of: `bank`, `documents`, `estimates`, `sales_invoices`, `settings` and `time_entries`",
        "tags": [
          "Task lists"
        ],
        "security": [
          {
            "bearerAuth": [
              "bank",
              "documents",
              "estimates",
              "sales_invoices",
              "settings",
              "time_entries"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/administration_id"
          },
          {
            "name": "task_list_task_id",
            "in": "path",
            "required": true,
            "schema": {
              "$ref": "#/components/schemas/identifier"
            }
          },
          {
            "$ref": "#/components/parameters/format"
          }
        ],
        "responses": {
          "200": {
            "description": "Task reopened",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/task_list_task_response"
                },
                "examples": {
                  "ReopensTheTask": {
                    "summary": "Reopens the task",
                    "value": {
                      "id": "502689277777282762",
                      "administration_id": 123,
                      "name": "Task #1",
                      "description": "Description 1",
                      "row_order": 0,
                      "completed_at": null,
                      "report_type": null,
                      "task_lists_group_id": "502689277776234185",
                      "parent_task_id": null,
                      "created_at": "2026-11-02T12:17:55.070Z",
                      "updated_at": "2026-11-02T12:17:55.091Z",
                      "assignee_id": null,
                      "subtasks": [],
                      "notes": [],
                      "events": [
                        {
                          "administration_id": 123,
                          "user_id": "502689108256097381",
                          "action": "task_lists_task_created",
                          "link_entity_id": null,
                          "link_entity_type": null,
                          "data": {},
                          "created_at": "2026-11-02T12:17:55.071Z",
                          "updated_at": "2026-11-02T12:17:55.071Z"
                        },
                        {
                          "administration_id": 123,
                          "user_id": "502689108256097381",
                          "action": "task_lists_task_completed",
                          "link_entity_id": null,
                          "link_entity_type": null,
                          "data": {},
                          "created_at": "2026-11-02T12:17:55.078Z",
                          "updated_at": "2026-11-02T12:17:55.078Z"
                        },
                        {
                          "administration_id": 123,
                          "user_id": "502689108256097381",
                          "action": "task_lists_task_reopened",
                          "link_entity_id": null,
                          "link_entity_type": null,
                          "data": {},
                          "created_at": "2026-11-02T12:17:55.093Z",
                          "updated_at": "2026-11-02T12:17:55.093Z"
                        }
                      ]
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Not found",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/symbolic_error"
                },
                "examples": {
                  "Returns404WhenTaskDoesNotExist": {
                    "summary": "Returns 404 when task does not exist",
                    "value": {
                      "error": "Record not found for model name: Task"
                    }
                  }
                }
              }
            }
          }
        },
        "operationId": "delete_administration_id_task_list_tasks_task_list_task_id_completion"
      }
    },
    "/{administration_id}/task_list_tasks/{task_list_task_id}/notes{format}": {
      "post": {
        "summary": "Creates a note on a task",
        "description": "Creates a new note on the specified task.\n\n### Required scope(s)\n All of: `bank`, `documents`, `estimates`, `sales_invoices`, `settings` and `time_entries`",
        "tags": [
          "Task lists"
        ],
        "security": [
          {
            "bearerAuth": [
              "bank",
              "documents",
              "estimates",
              "sales_invoices",
              "settings",
              "time_entries"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/administration_id"
          },
          {
            "name": "task_list_task_id",
            "in": "path",
            "required": true,
            "schema": {
              "$ref": "#/components/schemas/identifier"
            }
          },
          {
            "$ref": "#/components/parameters/format"
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/*": {
              "schema": {
                "unevaluatedProperties": false,
                "type": "object",
                "properties": {
                  "note": {
                    "type": "object",
                    "unevaluatedProperties": false,
                    "properties": {
                      "note": {
                        "type": "string",
                        "description": "The note content"
                      },
                      "todo": {
                        "type": "boolean",
                        "description": "Whether the note is a to-do item"
                      }
                    },
                    "required": [
                      "note"
                    ]
                  }
                }
              },
              "examples": {
                "CreatesANote": {
                  "summary": "Creates a note",
                  "value": {
                    "note": {
                      "note": "Test note",
                      "todo": false
                    }
                  }
                }
              }
            }
          }
        },
        "responses": {
          "201": {
            "description": "Note created",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/note_response"
                },
                "examples": {
                  "CreatesANote": {
                    "summary": "Creates a note",
                    "value": {
                      "id": "502689278269065015",
                      "administration_id": 123,
                      "entity_id": "502689278256482101",
                      "entity_type": "TaskLists::Task",
                      "user_id": "502689108256097381",
                      "assignee_id": null,
                      "todo": false,
                      "note": "Test note",
                      "completed_at": null,
                      "completed_by_id": null,
                      "todo_type": null,
                      "data": {},
                      "created_at": "2026-11-02T12:17:55.538Z",
                      "updated_at": "2026-11-02T12:17:55.538Z"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Not found",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/symbolic_error"
                },
                "examples": {
                  "Returns404WhenTaskDoesNotExist": {
                    "summary": "Returns 404 when task does not exist",
                    "value": {
                      "error": "Record not found for model name: Task"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "Unprocessable entity",
            "content": {
              "application/json": {
                "schema": {
                  "anyOf": [
                    {
                      "$ref": "#/components/schemas/symbolic_error"
                    },
                    {
                      "$ref": "#/components/schemas/non_symbolic_error"
                    }
                  ]
                },
                "examples": {
                  "Returns422WhenNoteIsEmpty": {
                    "summary": "Returns 422 when note is empty",
                    "value": {
                      "error": {
                        "note": [
                          "can't be blank"
                        ],
                        "todo_type": [
                          "can't be blank"
                        ]
                      },
                      "details": {
                        "note": [
                          {
                            "error": "blank"
                          }
                        ],
                        "todo_type": [
                          {
                            "error": "blank"
                          }
                        ]
                      }
                    }
                  }
                }
              }
            }
          }
        },
        "operationId": "post_administration_id_task_list_tasks_task_list_task_id_notes"
      }
    },
    "/{administration_id}/task_list_templates/{id}{format}": {
      "get": {
        "summary": "Returns information about a task list template",
        "description": "Returns information about a task list template, including its groups and tasks.\n\n### Required scope(s)\n All of: `bank`, `documents`, `estimates`, `sales_invoices`, `settings` and `time_entries`",
        "tags": [
          "Task list templates"
        ],
        "security": [
          {
            "bearerAuth": [
              "bank",
              "documents",
              "estimates",
              "sales_invoices",
              "settings",
              "time_entries"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/administration_id"
          },
          {
            "name": "id",
            "in": "path",
            "required": true,
            "schema": {
              "$ref": "#/components/schemas/identifier"
            }
          },
          {
            "$ref": "#/components/parameters/format"
          }
        ],
        "responses": {
          "200": {
            "description": "A task list template",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/task_list_template_response"
                },
                "examples": {
                  "ReturnsASingleTemplate": {
                    "summary": "Returns a single template",
                    "value": {
                      "id": "502689219755377872",
                      "administration_id": 123,
                      "name": "Task list template #1",
                      "description": "Template description",
                      "period": "P1M",
                      "deadline_after": null,
                      "created_at": "2026-11-02T12:16:59.735Z",
                      "updated_at": "2026-11-02T12:16:59.735Z",
                      "groups": [
                        {
                          "id": "502689219757475026",
                          "name": "Task list group #1",
                          "row_order": 0,
                          "report_type": null,
                          "created_at": "2026-11-02T12:16:59.738Z",
                          "updated_at": "2026-11-02T12:16:59.738Z",
                          "tasks": [
                            {
                              "id": "502689219758523603",
                              "administration_id": 123,
                              "name": "Task #1",
                              "description": "Description 1",
                              "row_order": 0,
                              "completed_at": null,
                              "report_type": null,
                              "task_lists_group_id": "502689219757475026",
                              "parent_task_id": null,
                              "created_at": "2026-11-02T12:16:59.739Z",
                              "updated_at": "2026-11-02T12:16:59.739Z",
                              "assignee_id": null,
                              "subtasks": [],
                              "notes": [],
                              "events": [
                                {
                                  "administration_id": 123,
                                  "user_id": "502689108256097381",
                                  "action": "task_lists_task_created",
                                  "link_entity_id": null,
                                  "link_entity_type": null,
                                  "data": {},
                                  "created_at": "2026-11-02T12:16:59.740Z",
                                  "updated_at": "2026-11-02T12:16:59.740Z"
                                }
                              ]
                            }
                          ]
                        }
                      ]
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Not found",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/symbolic_error"
                },
                "examples": {
                  "Returns404WhenTemplateDoesNotExist": {
                    "summary": "Returns 404 when template does not exist",
                    "value": {
                      "error": "Record not found for model name: List template"
                    }
                  }
                }
              }
            }
          }
        },
        "operationId": "get_administration_id_task_list_templates_id"
      },
      "patch": {
        "summary": "Updates a task list template",
        "description": "Updates a task list template.\n\n### Required scope(s)\n All of: `bank`, `documents`, `estimates`, `sales_invoices`, `settings` and `time_entries`",
        "tags": [
          "Task list templates"
        ],
        "security": [
          {
            "bearerAuth": [
              "bank",
              "documents",
              "estimates",
              "sales_invoices",
              "settings",
              "time_entries"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/administration_id"
          },
          {
            "name": "id",
            "in": "path",
            "required": true,
            "schema": {
              "$ref": "#/components/schemas/identifier"
            }
          },
          {
            "$ref": "#/components/parameters/format"
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/*": {
              "schema": {
                "unevaluatedProperties": false,
                "type": "object",
                "properties": {
                  "task_list_template": {
                    "type": "object",
                    "unevaluatedProperties": false,
                    "properties": {
                      "name": {
                        "type": "string"
                      },
                      "description": {
                        "type": "string"
                      },
                      "period": {
                        "type": "string",
                        "description": "ISO 8601 duration string (e.g. P1M, P3M, P1Y) or friendly name (monthly, quarterly, yearly, none)"
                      },
                      "deadline_after": {
                        "type": "string",
                        "description": "ISO 8601 duration string representing the deadline offset from the period end"
                      }
                    }
                  }
                }
              },
              "examples": {
                "UpdatesATemplate": {
                  "summary": "Updates a template",
                  "value": {
                    "task_list_template": {
                      "name": "Updated Template"
                    }
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Template updated",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/task_list_template_response"
                },
                "examples": {
                  "UpdatesATemplate": {
                    "summary": "Updates a template",
                    "value": {
                      "id": "502689219829826778",
                      "administration_id": 123,
                      "name": "Updated Template",
                      "description": "Template description",
                      "period": "P1M",
                      "deadline_after": null,
                      "created_at": "2026-11-02T12:16:59.806Z",
                      "updated_at": "2026-11-02T12:16:59.823Z",
                      "groups": [
                        {
                          "id": "502689219832972508",
                          "name": "Task list group #1",
                          "row_order": 0,
                          "report_type": null,
                          "created_at": "2026-11-02T12:16:59.809Z",
                          "updated_at": "2026-11-02T12:16:59.809Z",
                          "tasks": [
                            {
                              "id": "502689219832972509",
                              "administration_id": 123,
                              "name": "Task #1",
                              "description": "Description 1",
                              "row_order": 0,
                              "completed_at": null,
                              "report_type": null,
                              "task_lists_group_id": "502689219832972508",
                              "parent_task_id": null,
                              "created_at": "2026-11-02T12:16:59.810Z",
                              "updated_at": "2026-11-02T12:16:59.810Z",
                              "assignee_id": null,
                              "subtasks": [],
                              "notes": [],
                              "events": [
                                {
                                  "administration_id": 123,
                                  "user_id": "502689108256097381",
                                  "action": "task_lists_task_created",
                                  "link_entity_id": null,
                                  "link_entity_type": null,
                                  "data": {},
                                  "created_at": "2026-11-02T12:16:59.811Z",
                                  "updated_at": "2026-11-02T12:16:59.811Z"
                                }
                              ]
                            }
                          ]
                        }
                      ]
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "Bad request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/symbolic_error"
                },
                "examples": {
                  "Returns400WhenRequiredParamsAreMissing": {
                    "summary": "Returns 400 when required params are missing",
                    "value": {
                      "error": "task_list_template is missing"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Not found",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/symbolic_error"
                },
                "examples": {
                  "Returns404WhenTemplateDoesNotExist": {
                    "summary": "Returns 404 when template does not exist",
                    "value": {
                      "error": "Record not found for model name: List template"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "Unprocessable entity",
            "content": {
              "application/json": {
                "schema": {
                  "anyOf": [
                    {
                      "$ref": "#/components/schemas/symbolic_error"
                    },
                    {
                      "$ref": "#/components/schemas/non_symbolic_error"
                    }
                  ]
                },
                "examples": {
                  "Returns422WhenNameIsEmpty": {
                    "summary": "Returns 422 when name is empty",
                    "value": {
                      "error": "Name can't be blank"
                    }
                  }
                }
              }
            }
          }
        },
        "operationId": "patch_administration_id_task_list_templates_id"
      },
      "delete": {
        "summary": "Deletes a task list template",
        "description": "Permanently deletes a task list template and all its groups and tasks.\n\n### Required scope(s)\n All of: `bank`, `documents`, `estimates`, `sales_invoices`, `settings` and `time_entries`",
        "tags": [
          "Task list templates"
        ],
        "security": [
          {
            "bearerAuth": [
              "bank",
              "documents",
              "estimates",
              "sales_invoices",
              "settings",
              "time_entries"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/administration_id"
          },
          {
            "name": "id",
            "in": "path",
            "required": true,
            "schema": {
              "$ref": "#/components/schemas/identifier"
            }
          },
          {
            "$ref": "#/components/parameters/format"
          }
        ],
        "responses": {
          "204": {
            "description": "Template deleted"
          },
          "404": {
            "description": "Not found",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/symbolic_error"
                },
                "examples": {
                  "Returns404WhenTemplateDoesNotExist": {
                    "summary": "Returns 404 when template does not exist",
                    "value": {
                      "error": "Record not found for model name: List template"
                    }
                  }
                }
              }
            }
          }
        },
        "operationId": "delete_administration_id_task_list_templates_id"
      }
    },
    "/{administration_id}/task_list_templates/{task_list_template_id}/groups{format}": {
      "post": {
        "summary": "Creates a new group in a task list template",
        "description": "Creates a new group in the specified task list template.\n\n### Required scope(s)\n All of: `bank`, `documents`, `estimates`, `sales_invoices`, `settings` and `time_entries`",
        "tags": [
          "Task list templates"
        ],
        "security": [
          {
            "bearerAuth": [
              "bank",
              "documents",
              "estimates",
              "sales_invoices",
              "settings",
              "time_entries"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/administration_id"
          },
          {
            "name": "task_list_template_id",
            "in": "path",
            "required": true,
            "schema": {
              "$ref": "#/components/schemas/identifier"
            }
          },
          {
            "$ref": "#/components/parameters/format"
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/*": {
              "schema": {
                "unevaluatedProperties": false,
                "type": "object",
                "properties": {
                  "group": {
                    "type": "object",
                    "unevaluatedProperties": false,
                    "properties": {
                      "name": {
                        "type": "string"
                      },
                      "report_type": {
                        "type": "string",
                        "enum": [
                          "balance_sheet",
                          "profit_loss",
                          "debtor",
                          "creditor",
                          "assets"
                        ],
                        "description": "Report this group is based on; its tasks are generated from the report."
                      }
                    },
                    "required": [
                      "name"
                    ]
                  }
                }
              },
              "examples": {
                "CreatesANewGroup": {
                  "summary": "Creates a new group",
                  "value": {
                    "group": {
                      "name": "New Group"
                    }
                  }
                }
              }
            }
          }
        },
        "responses": {
          "201": {
            "description": "Group created",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/task_list_group_response"
                },
                "examples": {
                  "CreatesANewGroup": {
                    "summary": "Creates a new group",
                    "value": {
                      "id": "502689219404104858",
                      "name": "New Group",
                      "row_order": 1,
                      "report_type": null,
                      "created_at": "2026-11-02T12:16:59.401Z",
                      "updated_at": "2026-11-02T12:16:59.401Z",
                      "tasks": []
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "Bad request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/symbolic_error"
                },
                "examples": {
                  "Returns400WhenRequiredParamsAreMissing": {
                    "summary": "Returns 400 when required params are missing",
                    "value": {
                      "error": "group is missing, group[name] is missing"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Not found",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/symbolic_error"
                },
                "examples": {
                  "Returns404WhenTemplateDoesNotExist": {
                    "summary": "Returns 404 when template does not exist",
                    "value": {
                      "error": "Record not found for model name: List template"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "Unprocessable entity",
            "content": {
              "application/json": {
                "schema": {
                  "anyOf": [
                    {
                      "$ref": "#/components/schemas/symbolic_error"
                    },
                    {
                      "$ref": "#/components/schemas/non_symbolic_error"
                    }
                  ]
                },
                "examples": {
                  "Returns422WhenNameIsMissing": {
                    "summary": "Returns 422 when name is missing",
                    "value": {
                      "error": "Name can't be blank"
                    }
                  }
                }
              }
            }
          }
        },
        "operationId": "post_administration_id_task_list_templates_task_list_template_id_groups"
      }
    },
    "/{administration_id}/task_list_templates/{task_list_template_id}/task_lists{format}": {
      "post": {
        "summary": "Creates a task list from a template",
        "description": "Creates a new task list based on the specified template.\n\n### Required scope(s)\n All of: `bank`, `documents`, `estimates`, `sales_invoices`, `settings` and `time_entries`",
        "tags": [
          "Task lists"
        ],
        "security": [
          {
            "bearerAuth": [
              "bank",
              "documents",
              "estimates",
              "sales_invoices",
              "settings",
              "time_entries"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/administration_id"
          },
          {
            "name": "task_list_template_id",
            "in": "path",
            "required": true,
            "schema": {
              "$ref": "#/components/schemas/identifier"
            }
          },
          {
            "$ref": "#/components/parameters/format"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/*": {
              "schema": {
                "unevaluatedProperties": false,
                "type": "object",
                "properties": {
                  "task_list": {
                    "type": "object",
                    "unevaluatedProperties": false,
                    "properties": {
                      "name": {
                        "type": "string"
                      },
                      "description": {
                        "type": "string"
                      },
                      "deadline_on": {
                        "type": "string",
                        "format": "date"
                      },
                      "period_begin": {
                        "type": "string",
                        "format": "date"
                      },
                      "period_end": {
                        "type": "string",
                        "format": "date"
                      }
                    }
                  }
                }
              },
              "examples": {
                "CreatesATaskListFromTheTemplate": {
                  "summary": "Creates a task list from the template",
                  "value": {}
                }
              }
            }
          }
        },
        "responses": {
          "201": {
            "description": "Task list created",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/task_list_response"
                },
                "examples": {
                  "CreatesATaskListFromTheTemplate": {
                    "summary": "Creates a task list from the template",
                    "value": {
                      "id": "502689219599140023",
                      "administration_id": 123,
                      "name": "Task list template #1",
                      "description": "Template description",
                      "deadline_on": null,
                      "period_begin": "2026-10-01",
                      "period_end": "2026-10-31",
                      "completed": false,
                      "template_id": "502689219560342706",
                      "total_tasks_count": 1,
                      "completed_tasks_count": 0,
                      "created_at": "2026-11-02T12:16:59.587Z",
                      "updated_at": "2026-11-02T12:16:59.587Z",
                      "groups": [
                        {
                          "id": "502689219603334329",
                          "name": "Task list group #1",
                          "row_order": 0,
                          "report_type": null,
                          "created_at": "2026-11-02T12:16:59.590Z",
                          "updated_at": "2026-11-02T12:16:59.590Z",
                          "tasks": [
                            {
                              "id": "502689219604382906",
                              "administration_id": 123,
                              "name": "Task #1",
                              "description": "Description 1",
                              "row_order": 0,
                              "completed_at": null,
                              "report_type": null,
                              "task_lists_group_id": "502689219603334329",
                              "parent_task_id": null,
                              "created_at": "2026-11-02T12:16:59.591Z",
                              "updated_at": "2026-11-02T12:16:59.591Z",
                              "assignee_id": null,
                              "subtasks": [],
                              "notes": [],
                              "events": [
                                {
                                  "administration_id": 123,
                                  "user_id": "502689108256097381",
                                  "action": "task_lists_task_created",
                                  "link_entity_id": null,
                                  "link_entity_type": null,
                                  "data": {},
                                  "created_at": "2026-11-02T12:16:59.593Z",
                                  "updated_at": "2026-11-02T12:16:59.593Z"
                                }
                              ]
                            }
                          ]
                        }
                      ]
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "Bad request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/symbolic_error"
                },
                "examples": {
                  "Returns400WhenParamsAreInvalidType": {
                    "summary": "Returns 400 when params are invalid type",
                    "value": {
                      "error": "task_list is invalid"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Not found",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/symbolic_error"
                },
                "examples": {
                  "Returns404WhenTemplateDoesNotExist": {
                    "summary": "Returns 404 when template does not exist",
                    "value": {
                      "error": "Record not found for model name: List template"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "Unprocessable entity",
            "content": {
              "application/json": {
                "schema": {
                  "anyOf": [
                    {
                      "$ref": "#/components/schemas/symbolic_error"
                    },
                    {
                      "$ref": "#/components/schemas/non_symbolic_error"
                    }
                  ]
                },
                "examples": {
                  "Returns422WhenTaskListParamsAreInvalid": {
                    "summary": "Returns 422 when task list params are invalid",
                    "value": {
                      "error": "Name can't be blank"
                    }
                  }
                }
              }
            }
          }
        },
        "operationId": "post_administration_id_task_list_templates_task_list_template_id_task_lists"
      }
    },
    "/{administration_id}/task_list_templates{format}": {
      "get": {
        "summary": "List all task list templates of an administration",
        "description": "Returns all task list templates in the administration.\n\n### Required scope(s)\n All of: `bank`, `documents`, `estimates`, `sales_invoices`, `settings` and `time_entries`",
        "tags": [
          "Task list templates"
        ],
        "security": [
          {
            "bearerAuth": [
              "bank",
              "documents",
              "estimates",
              "sales_invoices",
              "settings",
              "time_entries"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/administration_id"
          },
          {
            "$ref": "#/components/parameters/format"
          }
        ],
        "responses": {
          "200": {
            "description": "A list of task list templates",
            "content": {
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "$ref": "#/components/schemas/task_list_template_response"
                  }
                },
                "examples": {
                  "ReturnsTheListOfTemplates": {
                    "summary": "Returns the list of templates",
                    "value": [
                      {
                        "id": "502689219794175189",
                        "administration_id": 123,
                        "name": "Task list template #1",
                        "description": "Template description",
                        "period": "P1M",
                        "deadline_after": null,
                        "created_at": "2026-11-02T12:16:59.772Z",
                        "updated_at": "2026-11-02T12:16:59.772Z",
                        "groups": [
                          {
                            "id": "502689219797320919",
                            "name": "Task list group #1",
                            "row_order": 0,
                            "report_type": null,
                            "created_at": "2026-11-02T12:16:59.775Z",
                            "updated_at": "2026-11-02T12:16:59.775Z",
                            "tasks": [
                              {
                                "id": "502689219797320920",
                                "administration_id": 123,
                                "name": "Task #1",
                                "description": "Description 1",
                                "row_order": 0,
                                "completed_at": null,
                                "report_type": null,
                                "task_lists_group_id": "502689219797320919",
                                "parent_task_id": null,
                                "created_at": "2026-11-02T12:16:59.776Z",
                                "updated_at": "2026-11-02T12:16:59.776Z",
                                "assignee_id": null,
                                "subtasks": [],
                                "notes": [],
                                "events": [
                                  {
                                    "administration_id": 123,
                                    "user_id": "502689108256097381",
                                    "action": "task_lists_task_created",
                                    "link_entity_id": null,
                                    "link_entity_type": null,
                                    "data": {},
                                    "created_at": "2026-11-02T12:16:59.777Z",
                                    "updated_at": "2026-11-02T12:16:59.777Z"
                                  }
                                ]
                              }
                            ]
                          }
                        ]
                      }
                    ]
                  }
                }
              }
            }
          }
        },
        "operationId": "get_administration_id_task_list_templates"
      },
      "post": {
        "summary": "Creates a new task list template",
        "description": "Creates a new task list template.\n\n### Required scope(s)\n All of: `bank`, `documents`, `estimates`, `sales_invoices`, `settings` and `time_entries`",
        "tags": [
          "Task list templates"
        ],
        "security": [
          {
            "bearerAuth": [
              "bank",
              "documents",
              "estimates",
              "sales_invoices",
              "settings",
              "time_entries"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/administration_id"
          },
          {
            "$ref": "#/components/parameters/format"
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/*": {
              "schema": {
                "unevaluatedProperties": false,
                "type": "object",
                "properties": {
                  "task_list_template": {
                    "type": "object",
                    "unevaluatedProperties": false,
                    "properties": {
                      "name": {
                        "type": "string"
                      },
                      "description": {
                        "type": "string"
                      },
                      "period": {
                        "type": "string",
                        "description": "ISO 8601 duration string (e.g. P1M, P3M, P1Y) or friendly name (monthly, quarterly, yearly, none)"
                      },
                      "deadline_after": {
                        "type": "string",
                        "description": "ISO 8601 duration string representing the deadline offset from the period end"
                      }
                    },
                    "required": [
                      "name"
                    ]
                  }
                }
              },
              "examples": {
                "CreatesANewTemplate": {
                  "summary": "Creates a new template",
                  "value": {
                    "task_list_template": {
                      "name": "New Template"
                    }
                  }
                }
              }
            }
          }
        },
        "responses": {
          "201": {
            "description": "Template created",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/task_list_template_response"
                },
                "examples": {
                  "CreatesANewTemplate": {
                    "summary": "Creates a new template",
                    "value": {
                      "id": "502689220192634124",
                      "administration_id": 123,
                      "name": "New Template",
                      "description": null,
                      "period": "P1M",
                      "deadline_after": null,
                      "created_at": "2026-11-02T12:17:00.152Z",
                      "updated_at": "2026-11-02T12:17:00.152Z",
                      "groups": [
                        {
                          "id": "502689220196828430",
                          "name": null,
                          "row_order": 0,
                          "report_type": null,
                          "created_at": "2026-11-02T12:17:00.157Z",
                          "updated_at": "2026-11-02T12:17:00.157Z",
                          "tasks": []
                        }
                      ]
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "Bad request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/symbolic_error"
                },
                "examples": {
                  "Returns400WhenRequiredParamsAreMissing": {
                    "summary": "Returns 400 when required params are missing",
                    "value": {
                      "error": "task_list_template is missing, task_list_template[name] is missing"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "Unprocessable entity",
            "content": {
              "application/json": {
                "schema": {
                  "anyOf": [
                    {
                      "$ref": "#/components/schemas/symbolic_error"
                    },
                    {
                      "$ref": "#/components/schemas/non_symbolic_error"
                    }
                  ]
                },
                "examples": {
                  "Returns422WhenNameIsMissing": {
                    "summary": "Returns 422 when name is missing",
                    "value": {
                      "error": "Name can't be blank"
                    }
                  }
                }
              }
            }
          }
        },
        "operationId": "post_administration_id_task_list_templates"
      }
    },
    "/{administration_id}/task_lists/{id}{format}": {
      "get": {
        "summary": "Returns information about a task list",
        "description": "Returns information about a task list, including its groups, tasks, and subtasks.\n\n### Required scope(s)\n All of: `bank`, `documents`, `estimates`, `sales_invoices`, `settings` and `time_entries`",
        "tags": [
          "Task lists"
        ],
        "security": [
          {
            "bearerAuth": [
              "bank",
              "documents",
              "estimates",
              "sales_invoices",
              "settings",
              "time_entries"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/administration_id"
          },
          {
            "name": "id",
            "in": "path",
            "required": true,
            "schema": {
              "$ref": "#/components/schemas/identifier"
            }
          },
          {
            "$ref": "#/components/parameters/format"
          }
        ],
        "responses": {
          "200": {
            "description": "A task list",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/task_list_response"
                },
                "examples": {
                  "ReturnsASingleTaskList": {
                    "summary": "Returns a single task list",
                    "value": {
                      "id": "502689284628678369",
                      "administration_id": 123,
                      "name": "Task list #1",
                      "description": "List description",
                      "deadline_on": null,
                      "period_begin": "2026-07-01",
                      "period_end": "2026-09-30",
                      "completed": false,
                      "template_id": null,
                      "total_tasks_count": 1,
                      "completed_tasks_count": 0,
                      "created_at": "2026-11-02T12:18:01.603Z",
                      "updated_at": "2026-11-02T12:18:01.603Z",
                      "groups": [
                        {
                          "id": "502689284631824099",
                          "name": "Task list group #1",
                          "row_order": 0,
                          "report_type": null,
                          "created_at": "2026-11-02T12:18:01.606Z",
                          "updated_at": "2026-11-02T12:18:01.606Z",
                          "tasks": [
                            {
                              "id": "502689284631824100",
                              "administration_id": 123,
                              "name": "Task #1",
                              "description": "Description 1",
                              "row_order": 0,
                              "completed_at": null,
                              "report_type": null,
                              "task_lists_group_id": "502689284631824099",
                              "parent_task_id": null,
                              "created_at": "2026-11-02T12:18:01.607Z",
                              "updated_at": "2026-11-02T12:18:01.607Z",
                              "assignee_id": null,
                              "subtasks": [],
                              "notes": [],
                              "events": [
                                {
                                  "administration_id": 123,
                                  "user_id": "502689108256097381",
                                  "action": "task_lists_task_created",
                                  "link_entity_id": null,
                                  "link_entity_type": null,
                                  "data": {},
                                  "created_at": "2026-11-02T12:18:01.608Z",
                                  "updated_at": "2026-11-02T12:18:01.608Z"
                                }
                              ]
                            }
                          ]
                        }
                      ]
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Not found",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/symbolic_error"
                },
                "examples": {
                  "Returns404WhenTaskListDoesNotExist": {
                    "summary": "Returns 404 when task list does not exist",
                    "value": {
                      "error": "Record not found for model name: List"
                    }
                  }
                }
              }
            }
          }
        },
        "operationId": "get_administration_id_task_lists_id"
      },
      "patch": {
        "summary": "Updates a task list",
        "description": "Updates a task list's name, description, or deadline.\n\n### Required scope(s)\n All of: `bank`, `documents`, `estimates`, `sales_invoices`, `settings` and `time_entries`",
        "tags": [
          "Task lists"
        ],
        "security": [
          {
            "bearerAuth": [
              "bank",
              "documents",
              "estimates",
              "sales_invoices",
              "settings",
              "time_entries"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/administration_id"
          },
          {
            "name": "id",
            "in": "path",
            "required": true,
            "schema": {
              "$ref": "#/components/schemas/identifier"
            }
          },
          {
            "$ref": "#/components/parameters/format"
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/*": {
              "schema": {
                "unevaluatedProperties": false,
                "type": "object",
                "properties": {
                  "task_list": {
                    "type": "object",
                    "unevaluatedProperties": false,
                    "properties": {
                      "name": {
                        "type": "string"
                      },
                      "description": {
                        "type": "string"
                      },
                      "deadline_on": {
                        "type": "string",
                        "format": "date"
                      }
                    }
                  }
                },
                "required": []
              },
              "examples": {
                "UpdatesATaskList": {
                  "summary": "Updates a task list",
                  "value": {
                    "task_list": {
                      "name": "Updated Name"
                    }
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Task list updated",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/task_list_response"
                },
                "examples": {
                  "UpdatesATaskList": {
                    "summary": "Updates a task list",
                    "value": {
                      "id": "502689284149479069",
                      "administration_id": 123,
                      "name": "Updated Name",
                      "description": "List description",
                      "deadline_on": null,
                      "period_begin": "2026-07-01",
                      "period_end": "2026-09-30",
                      "completed": false,
                      "template_id": null,
                      "total_tasks_count": 1,
                      "completed_tasks_count": 0,
                      "created_at": "2026-11-02T12:18:01.146Z",
                      "updated_at": "2026-11-02T12:18:01.164Z",
                      "groups": [
                        {
                          "id": "502689284154721951",
                          "name": "Task list group #1",
                          "row_order": 0,
                          "report_type": null,
                          "created_at": "2026-11-02T12:18:01.151Z",
                          "updated_at": "2026-11-02T12:18:01.151Z",
                          "tasks": [
                            {
                              "id": "502689284155770528",
                              "administration_id": 123,
                              "name": "Task #1",
                              "description": "Description 1",
                              "row_order": 0,
                              "completed_at": null,
                              "report_type": null,
                              "task_lists_group_id": "502689284154721951",
                              "parent_task_id": null,
                              "created_at": "2026-11-02T12:18:01.152Z",
                              "updated_at": "2026-11-02T12:18:01.152Z",
                              "assignee_id": null,
                              "subtasks": [],
                              "notes": [],
                              "events": [
                                {
                                  "administration_id": 123,
                                  "user_id": "502689108256097381",
                                  "action": "task_lists_task_created",
                                  "link_entity_id": null,
                                  "link_entity_type": null,
                                  "data": {},
                                  "created_at": "2026-11-02T12:18:01.154Z",
                                  "updated_at": "2026-11-02T12:18:01.154Z"
                                }
                              ]
                            }
                          ]
                        }
                      ]
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "Bad request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/symbolic_error"
                },
                "examples": {
                  "ReturnsA400WhenTheGivenParametersAreInvalid": {
                    "summary": "Returns a 400 when the given parameters are invalid",
                    "value": {
                      "error": "task_list is missing"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Not found",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/symbolic_error"
                },
                "examples": {
                  "Returns404WhenTaskListDoesNotExist": {
                    "summary": "Returns 404 when task list does not exist",
                    "value": {
                      "error": "Record not found for model name: List"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "Unprocessable entity",
            "content": {
              "application/json": {
                "schema": {
                  "anyOf": [
                    {
                      "$ref": "#/components/schemas/symbolic_error"
                    },
                    {
                      "$ref": "#/components/schemas/non_symbolic_error"
                    }
                  ]
                },
                "examples": {
                  "Returns422WhenNameIsEmpty": {
                    "summary": "Returns 422 when name is empty",
                    "value": {
                      "error": "Name can't be blank"
                    }
                  }
                }
              }
            }
          }
        },
        "operationId": "patch_administration_id_task_lists_id"
      },
      "delete": {
        "summary": "Deletes a task list",
        "description": "Permanently deletes a task list and all its groups and tasks.\n\n### Required scope(s)\n All of: `bank`, `documents`, `estimates`, `sales_invoices`, `settings` and `time_entries`",
        "tags": [
          "Task lists"
        ],
        "security": [
          {
            "bearerAuth": [
              "bank",
              "documents",
              "estimates",
              "sales_invoices",
              "settings",
              "time_entries"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/administration_id"
          },
          {
            "name": "id",
            "in": "path",
            "required": true,
            "schema": {
              "$ref": "#/components/schemas/identifier"
            }
          },
          {
            "$ref": "#/components/parameters/format"
          }
        ],
        "responses": {
          "204": {
            "description": "Task list deleted"
          },
          "404": {
            "description": "Not found",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/symbolic_error"
                },
                "examples": {
                  "Returns404WhenTaskListDoesNotExist": {
                    "summary": "Returns 404 when task list does not exist",
                    "value": {
                      "error": "Record not found for model name: List"
                    }
                  }
                }
              }
            }
          }
        },
        "operationId": "delete_administration_id_task_lists_id"
      }
    },
    "/{administration_id}/task_lists/{task_list_id}/groups{format}": {
      "post": {
        "summary": "Creates a new group in a task list",
        "description": "Creates a new group in the specified task list.\n\n### Required scope(s)\n All of: `bank`, `documents`, `estimates`, `sales_invoices`, `settings` and `time_entries`",
        "tags": [
          "Task lists"
        ],
        "security": [
          {
            "bearerAuth": [
              "bank",
              "documents",
              "estimates",
              "sales_invoices",
              "settings",
              "time_entries"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/administration_id"
          },
          {
            "name": "task_list_id",
            "in": "path",
            "required": true,
            "schema": {
              "$ref": "#/components/schemas/identifier"
            }
          },
          {
            "$ref": "#/components/parameters/format"
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/*": {
              "schema": {
                "unevaluatedProperties": false,
                "type": "object",
                "properties": {
                  "group": {
                    "type": "object",
                    "unevaluatedProperties": false,
                    "properties": {
                      "name": {
                        "type": "string"
                      },
                      "report_type": {
                        "type": "string",
                        "enum": [
                          "balance_sheet",
                          "profit_loss",
                          "debtor",
                          "creditor",
                          "assets"
                        ],
                        "description": "Report this group is based on; its tasks are generated from the report."
                      }
                    },
                    "required": [
                      "name"
                    ]
                  }
                },
                "required": []
              },
              "examples": {
                "CreatesANewGroup": {
                  "summary": "Creates a new group",
                  "value": {
                    "group": {
                      "name": "New Group"
                    }
                  }
                }
              }
            }
          }
        },
        "responses": {
          "201": {
            "description": "Group created",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/task_list_group_response"
                },
                "examples": {
                  "CreatesANewGroup": {
                    "summary": "Creates a new group",
                    "value": {
                      "id": "502689283978561159",
                      "name": "New Group",
                      "row_order": 1,
                      "report_type": null,
                      "created_at": "2026-11-02T12:18:00.984Z",
                      "updated_at": "2026-11-02T12:18:00.984Z",
                      "tasks": []
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "Bad request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/symbolic_error"
                },
                "examples": {
                  "ReturnsA400WhenTheGivenParametersAreInvalid": {
                    "summary": "Returns a 400 when the given parameters are invalid",
                    "value": {
                      "error": "group is missing, group[name] is missing"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Not found",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/symbolic_error"
                },
                "examples": {
                  "Returns404WhenTaskListDoesNotExist": {
                    "summary": "Returns 404 when task list does not exist",
                    "value": {
                      "error": "Record not found for model name: List"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "Unprocessable entity",
            "content": {
              "application/json": {
                "schema": {
                  "anyOf": [
                    {
                      "$ref": "#/components/schemas/symbolic_error"
                    },
                    {
                      "$ref": "#/components/schemas/non_symbolic_error"
                    }
                  ]
                },
                "examples": {
                  "Returns422WhenNameIsMissing": {
                    "summary": "Returns 422 when name is missing",
                    "value": {
                      "error": "Name can't be blank"
                    }
                  }
                }
              }
            }
          }
        },
        "operationId": "post_administration_id_task_lists_task_list_id_groups"
      }
    },
    "/{administration_id}/task_lists{format}": {
      "get": {
        "summary": "List all task lists of an administration",
        "description": "Returns a paginated list of task lists in the administration. Each page contains 30 task lists by default. Use the `page` parameter to fetch the next page.\n\n### Required scope(s)\n All of: `bank`, `documents`, `estimates`, `sales_invoices`, `settings` and `time_entries`",
        "tags": [
          "Task lists"
        ],
        "security": [
          {
            "bearerAuth": [
              "bank",
              "documents",
              "estimates",
              "sales_invoices",
              "settings",
              "time_entries"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/administration_id"
          },
          {
            "$ref": "#/components/parameters/format"
          },
          {
            "$ref": "#/components/parameters/per_page",
            "description": "Amount of task lists per page, default: 30"
          },
          {
            "$ref": "#/components/parameters/page",
            "description": "The page to fetch, starting at 1."
          }
        ],
        "responses": {
          "200": {
            "description": "A list of task lists",
            "content": {
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "$ref": "#/components/schemas/task_list_response"
                  }
                },
                "examples": {
                  "RequestsWithADifferentPage": {
                    "summary": "Requests with a different page",
                    "value": []
                  },
                  "RequestsWithAPageSizeSmallerThanDefault": {
                    "summary": "Requests with a page size smaller than default",
                    "value": [
                      {
                        "id": "502689283737388649",
                        "administration_id": 123,
                        "name": "Task list #1",
                        "description": "List description",
                        "deadline_on": null,
                        "period_begin": "2026-07-01",
                        "period_end": "2026-09-30",
                        "completed": false,
                        "template_id": null,
                        "total_tasks_count": 1,
                        "completed_tasks_count": 0,
                        "created_at": "2026-11-02T12:18:00.754Z",
                        "updated_at": "2026-11-02T12:18:00.754Z",
                        "groups": [
                          {
                            "id": "502689283739485803",
                            "name": "Task list group #1",
                            "row_order": 0,
                            "report_type": null,
                            "created_at": "2026-11-02T12:18:00.756Z",
                            "updated_at": "2026-11-02T12:18:00.756Z",
                            "tasks": [
                              {
                                "id": "502689283740534380",
                                "administration_id": 123,
                                "name": "Task #1",
                                "description": "Description 1",
                                "row_order": 0,
                                "completed_at": null,
                                "report_type": null,
                                "task_lists_group_id": "502689283739485803",
                                "parent_task_id": null,
                                "created_at": "2026-11-02T12:18:00.757Z",
                                "updated_at": "2026-11-02T12:18:00.757Z",
                                "assignee_id": null,
                                "subtasks": [],
                                "notes": [],
                                "events": [
                                  {
                                    "administration_id": 123,
                                    "user_id": "502689108256097381",
                                    "action": "task_lists_task_created",
                                    "link_entity_id": null,
                                    "link_entity_type": null,
                                    "data": {},
                                    "created_at": "2026-11-02T12:18:00.758Z",
                                    "updated_at": "2026-11-02T12:18:00.758Z"
                                  }
                                ]
                              }
                            ]
                          }
                        ]
                      }
                    ]
                  },
                  "FetchesWithoutPageAndPerPageAttributesUsingDefaultValues": {
                    "summary": "Fetches without page and per page attributes, using default values",
                    "value": [
                      {
                        "id": "502689283776185966",
                        "administration_id": 123,
                        "name": "Task list #1",
                        "description": "List description",
                        "deadline_on": null,
                        "period_begin": "2026-07-01",
                        "period_end": "2026-09-30",
                        "completed": false,
                        "template_id": null,
                        "total_tasks_count": 1,
                        "completed_tasks_count": 0,
                        "created_at": "2026-11-02T12:18:00.790Z",
                        "updated_at": "2026-11-02T12:18:00.790Z",
                        "groups": [
                          {
                            "id": "502689283778283120",
                            "name": "Task list group #1",
                            "row_order": 0,
                            "report_type": null,
                            "created_at": "2026-11-02T12:18:00.793Z",
                            "updated_at": "2026-11-02T12:18:00.793Z",
                            "tasks": [
                              {
                                "id": "502689283779331697",
                                "administration_id": 123,
                                "name": "Task #1",
                                "description": "Description 1",
                                "row_order": 0,
                                "completed_at": null,
                                "report_type": null,
                                "task_lists_group_id": "502689283778283120",
                                "parent_task_id": null,
                                "created_at": "2026-11-02T12:18:00.794Z",
                                "updated_at": "2026-11-02T12:18:00.794Z",
                                "assignee_id": null,
                                "subtasks": [],
                                "notes": [],
                                "events": [
                                  {
                                    "administration_id": 123,
                                    "user_id": "502689108256097381",
                                    "action": "task_lists_task_created",
                                    "link_entity_id": null,
                                    "link_entity_type": null,
                                    "data": {},
                                    "created_at": "2026-11-02T12:18:00.795Z",
                                    "updated_at": "2026-11-02T12:18:00.795Z"
                                  }
                                ]
                              }
                            ]
                          }
                        ]
                      }
                    ]
                  },
                  "RequestsWithAPageSizeLargerThanDefault": {
                    "summary": "Requests with a page size larger than default",
                    "value": [
                      {
                        "id": "502689283820226163",
                        "administration_id": 123,
                        "name": "Task list #1",
                        "description": "List description",
                        "deadline_on": null,
                        "period_begin": "2026-07-01",
                        "period_end": "2026-09-30",
                        "completed": false,
                        "template_id": null,
                        "total_tasks_count": 1,
                        "completed_tasks_count": 0,
                        "created_at": "2026-11-02T12:18:00.832Z",
                        "updated_at": "2026-11-02T12:18:00.832Z",
                        "groups": [
                          {
                            "id": "502689283822323317",
                            "name": "Task list group #1",
                            "row_order": 0,
                            "report_type": null,
                            "created_at": "2026-11-02T12:18:00.835Z",
                            "updated_at": "2026-11-02T12:18:00.835Z",
                            "tasks": [
                              {
                                "id": "502689283823371894",
                                "administration_id": 123,
                                "name": "Task #1",
                                "description": "Description 1",
                                "row_order": 0,
                                "completed_at": null,
                                "report_type": null,
                                "task_lists_group_id": "502689283822323317",
                                "parent_task_id": null,
                                "created_at": "2026-11-02T12:18:00.835Z",
                                "updated_at": "2026-11-02T12:18:00.835Z",
                                "assignee_id": null,
                                "subtasks": [],
                                "notes": [],
                                "events": [
                                  {
                                    "administration_id": 123,
                                    "user_id": "502689108256097381",
                                    "action": "task_lists_task_created",
                                    "link_entity_id": null,
                                    "link_entity_type": null,
                                    "data": {},
                                    "created_at": "2026-11-02T12:18:00.836Z",
                                    "updated_at": "2026-11-02T12:18:00.836Z"
                                  }
                                ]
                              }
                            ]
                          }
                        ]
                      }
                    ]
                  }
                }
              }
            }
          },
          "400": {
            "description": "Bad request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/symbolic_error"
                },
                "examples": {
                  "Returns400WhenPerPageExceedsMaximum": {
                    "summary": "Returns 400 when per page exceeds maximum",
                    "value": {
                      "error": "per_page does not have a valid value"
                    }
                  },
                  "Returns400WhenPageIsInvalid": {
                    "summary": "Returns 400 when page is invalid",
                    "value": {
                      "error": "page is invalid, page does not have a valid value"
                    }
                  },
                  "Returns400WhenPerPageIsInvalid": {
                    "summary": "Returns 400 when per page is invalid",
                    "value": {
                      "error": "per_page is invalid, per_page does not have a valid value"
                    }
                  }
                }
              }
            }
          }
        },
        "operationId": "get_administration_id_task_lists"
      },
      "post": {
        "summary": "Creates a new task list",
        "description": "Creates a new task list. Optionally, you can provide a template_id to create the task list from a template.\n\n### Required scope(s)\n All of: `bank`, `documents`, `estimates`, `sales_invoices`, `settings` and `time_entries`",
        "tags": [
          "Task lists"
        ],
        "security": [
          {
            "bearerAuth": [
              "bank",
              "documents",
              "estimates",
              "sales_invoices",
              "settings",
              "time_entries"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/administration_id"
          },
          {
            "$ref": "#/components/parameters/format"
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/*": {
              "schema": {
                "unevaluatedProperties": false,
                "type": "object",
                "properties": {
                  "task_list": {
                    "type": "object",
                    "unevaluatedProperties": false,
                    "properties": {
                      "name": {
                        "type": "string"
                      },
                      "description": {
                        "type": "string"
                      },
                      "deadline_on": {
                        "type": "string",
                        "format": "date"
                      },
                      "period_begin": {
                        "type": "string",
                        "format": "date"
                      },
                      "period_end": {
                        "type": "string",
                        "format": "date"
                      },
                      "template_id": {
                        "$ref": "#/components/schemas/identifier",
                        "description": "ID of a task list template to create the list from"
                      }
                    },
                    "required": [
                      "name"
                    ]
                  }
                }
              },
              "examples": {
                "CreatesANewTaskList": {
                  "summary": "Creates a new task list",
                  "value": {
                    "task_list": {
                      "name": "New Task List"
                    }
                  }
                }
              }
            }
          }
        },
        "responses": {
          "201": {
            "description": "Task list created",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/task_list_response"
                },
                "examples": {
                  "CreatesANewTaskList": {
                    "summary": "Creates a new task list",
                    "value": {
                      "id": "502689284601415390",
                      "administration_id": 123,
                      "name": "New Task List",
                      "description": null,
                      "deadline_on": null,
                      "period_begin": "2026-10-01",
                      "period_end": "2026-10-31",
                      "completed": true,
                      "template_id": null,
                      "total_tasks_count": 0,
                      "completed_tasks_count": 0,
                      "created_at": "2026-11-02T12:18:01.577Z",
                      "updated_at": "2026-11-02T12:18:01.577Z",
                      "groups": [
                        {
                          "id": "502689284603512544",
                          "name": null,
                          "row_order": 0,
                          "report_type": null,
                          "created_at": "2026-11-02T12:18:01.580Z",
                          "updated_at": "2026-11-02T12:18:01.580Z",
                          "tasks": []
                        }
                      ]
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "Bad request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/symbolic_error"
                },
                "examples": {
                  "ReturnsA400WhenTheGivenParametersAreInvalid": {
                    "summary": "Returns a 400 when the given parameters are invalid",
                    "value": {
                      "error": "task_list is missing, task_list[name] is missing"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "Unprocessable entity",
            "content": {
              "application/json": {
                "schema": {
                  "anyOf": [
                    {
                      "$ref": "#/components/schemas/symbolic_error"
                    },
                    {
                      "$ref": "#/components/schemas/non_symbolic_error"
                    }
                  ]
                },
                "examples": {
                  "Returns422WhenNameIsMissing": {
                    "summary": "Returns 422 when name is missing",
                    "value": {
                      "error": "Name can't be blank"
                    }
                  }
                }
              }
            }
          }
        },
        "operationId": "post_administration_id_task_lists"
      }
    },
    "/{administration_id}/tax_rates{format}": {
      "get": {
        "summary": "List all available tax rates for the administration",
        "description": "Returns a paginated list of all available tax rates for the administration\n\n### Required scope(s)\n Any of: `settings`, `sales_invoices`, `documents` or `estimates`",
        "tags": [
          "Tax rates"
        ],
        "security": [
          {
            "bearerAuth": [
              "settings"
            ]
          },
          {
            "bearerAuth": [
              "sales_invoices"
            ]
          },
          {
            "bearerAuth": [
              "documents"
            ]
          },
          {
            "bearerAuth": [
              "estimates"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/administration_id"
          },
          {
            "$ref": "#/components/parameters/format"
          },
          {
            "name": "filter",
            "in": "query",
            "required": false,
            "description": "Filters are `key:value` terms separated by commas (e.g. `percentage:21,tax_rate_type:sales_invoice`). Any filter you pass replaces the defaults below entirely, so include every key you need. Available filters:\n\n| **Filter** | **Type** | **Default** | **Description** |\n| --- | --- | --- | --- |\n| name | `String` | | Select tax rates by their full name |\n| partial_name | `String` | | Select tax rates with this substring in their name |\n| percentage | `Integer` | | Select tax rates with the specified percentage, e.g. specify `21` for 21% |\n| tax_rate_type | `String` | | `general_journal_document`, `purchase_invoice` or `sales_invoice`. Without this filter, tax rates of all types are returned |\n| country | `String` | | Select tax rates with the specified country. Must be a 2 letter abbreviation following ISO 3166. Please note that only foreign tax rates will have this field set. Domestic tax rates will not have this set at the moment. |\n| show_tax | `Boolean` | | Use `true` to tax rates for which tax is shown on the invoice, `false` for when it's not shown. No value will select both |\n| active | `Boolean` | | Use `true` to select active tax rates. Use `false` for inactive tax rates. No value will select both |\n| created_after | `String` | | Tax rates created after the given time (exclusive). ISO 8601 formatted string. The time to compare with is in UTC timezone |\n| updated_after | `String` | | Tax rates updated after the given time (exclusive). ISO 8601 formatted string. The time to compare with is in UTC timezone |\n\nYou can filter by multiple tax rate types at the same time by separating the values with a pipe (`tax_rate_type:purchase_invoice|sales_invoice`).",
            "schema": {
              "type": "string"
            },
            "examples": {
              "ReturnsAllTaxRatesCreatedAfterGivenDatetime": {
                "summary": "Returns all tax rates created after given datetime",
                "value": "created_after:2026-11-01 12:18:31 UTC"
              },
              "ReturnsOnlyTaxRatesUpdatedAfterGivenDatetime": {
                "summary": "Returns only tax rates updated after given datetime",
                "value": "updated_after:2026-11-02 12:18:36 UTC"
              },
              "ReturnsAllTaxRatesFilteredOnPercentage": {
                "summary": "Returns all tax rates filtered on percentage",
                "value": "percentage:21"
              }
            }
          },
          {
            "$ref": "#/components/parameters/page"
          },
          {
            "$ref": "#/components/parameters/per_page"
          }
        ],
        "responses": {
          "200": {
            "description": "A list of tax rates",
            "content": {
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "$ref": "#/components/schemas/tax_rate_response"
                  }
                },
                "examples": {
                  "ReturnsPaginatedTaxRatesOnPage2": {
                    "summary": "Returns paginated tax rates on page 2",
                    "value": [
                      {
                        "id": "502689108905165963",
                        "administration_id": 123,
                        "name": "9% btw",
                        "percentage": "9.0",
                        "tax_rate_type": "sales_invoice",
                        "show_tax": true,
                        "active": true,
                        "country": null,
                        "created_at": "2026-11-02T12:15:14.021Z",
                        "updated_at": "2026-11-02T12:15:14.021Z"
                      }
                    ]
                  },
                  "ReturnsAllTaxRatesCreatedAfterGivenDatetime": {
                    "summary": "Returns all tax rates created after given datetime",
                    "value": [
                      {
                        "id": "502689108899923082",
                        "administration_id": 123,
                        "name": "21% btw",
                        "percentage": "21.0",
                        "tax_rate_type": "sales_invoice",
                        "show_tax": true,
                        "active": true,
                        "country": null,
                        "created_at": "2026-11-02T12:15:14.012Z",
                        "updated_at": "2026-11-02T12:15:14.012Z"
                      },
                      {
                        "id": "502689108905165963",
                        "administration_id": 123,
                        "name": "9% btw",
                        "percentage": "9.0",
                        "tax_rate_type": "sales_invoice",
                        "show_tax": true,
                        "active": true,
                        "country": null,
                        "created_at": "2026-11-02T12:15:14.021Z",
                        "updated_at": "2026-11-02T12:15:14.021Z"
                      },
                      {
                        "id": "502689108907263116",
                        "administration_id": 123,
                        "name": "0% btw",
                        "percentage": "0.0",
                        "tax_rate_type": "sales_invoice",
                        "show_tax": true,
                        "active": true,
                        "country": null,
                        "created_at": "2026-11-02T12:15:14.022Z",
                        "updated_at": "2026-11-02T12:15:14.022Z"
                      },
                      {
                        "id": "502689108908311693",
                        "administration_id": 123,
                        "name": "21% btw",
                        "percentage": "21.0",
                        "tax_rate_type": "purchase_invoice",
                        "show_tax": true,
                        "active": true,
                        "country": null,
                        "created_at": "2026-11-02T12:15:14.024Z",
                        "updated_at": "2026-11-02T12:15:14.024Z"
                      },
                      {
                        "id": "502689108909360270",
                        "administration_id": 123,
                        "name": "9% btw",
                        "percentage": "9.0",
                        "tax_rate_type": "purchase_invoice",
                        "show_tax": true,
                        "active": true,
                        "country": null,
                        "created_at": "2026-11-02T12:15:14.024Z",
                        "updated_at": "2026-11-02T12:15:14.024Z"
                      }
                    ]
                  },
                  "ReturnsPaginatedTaxRatesOnPage1": {
                    "summary": "Returns paginated tax rates on page 1",
                    "value": [
                      {
                        "id": "502689108899923082",
                        "administration_id": 123,
                        "name": "21% btw",
                        "percentage": "21.0",
                        "tax_rate_type": "sales_invoice",
                        "show_tax": true,
                        "active": true,
                        "country": null,
                        "created_at": "2026-11-02T12:15:14.012Z",
                        "updated_at": "2026-11-02T12:15:14.012Z"
                      }
                    ]
                  },
                  "ReturnsOnlyTaxRatesUpdatedAfterGivenDatetime": {
                    "summary": "Returns only tax rates updated after given datetime",
                    "value": [
                      {
                        "id": "502689108899923082",
                        "administration_id": 123,
                        "name": "foo",
                        "percentage": "21.0",
                        "tax_rate_type": "sales_invoice",
                        "show_tax": true,
                        "active": true,
                        "country": null,
                        "created_at": "2026-11-02T12:15:14.012Z",
                        "updated_at": "2026-11-02T12:19:36.205Z"
                      }
                    ]
                  },
                  "ReturnsAllTaxRatesFilteredOnPercentage": {
                    "summary": "Returns all tax rates filtered on percentage",
                    "value": [
                      {
                        "id": "502689108899923082",
                        "administration_id": 123,
                        "name": "21% btw",
                        "percentage": "21.0",
                        "tax_rate_type": "sales_invoice",
                        "show_tax": true,
                        "active": true,
                        "country": null,
                        "created_at": "2026-11-02T12:15:14.012Z",
                        "updated_at": "2026-11-02T12:15:14.012Z"
                      },
                      {
                        "id": "502689108908311693",
                        "administration_id": 123,
                        "name": "21% btw",
                        "percentage": "21.0",
                        "tax_rate_type": "purchase_invoice",
                        "show_tax": true,
                        "active": true,
                        "country": null,
                        "created_at": "2026-11-02T12:15:14.024Z",
                        "updated_at": "2026-11-02T12:15:14.024Z"
                      }
                    ]
                  },
                  "ReturnsAllTaxRatesOfAnAdministration": {
                    "summary": "Returns all tax rates of an administration",
                    "value": [
                      {
                        "id": "502689108899923082",
                        "administration_id": 123,
                        "name": "21% btw",
                        "percentage": "21.0",
                        "tax_rate_type": "sales_invoice",
                        "show_tax": true,
                        "active": true,
                        "country": null,
                        "created_at": "2026-11-02T12:15:14.012Z",
                        "updated_at": "2026-11-02T12:15:14.012Z"
                      },
                      {
                        "id": "502689108905165963",
                        "administration_id": 123,
                        "name": "9% btw",
                        "percentage": "9.0",
                        "tax_rate_type": "sales_invoice",
                        "show_tax": true,
                        "active": true,
                        "country": null,
                        "created_at": "2026-11-02T12:15:14.021Z",
                        "updated_at": "2026-11-02T12:15:14.021Z"
                      },
                      {
                        "id": "502689108907263116",
                        "administration_id": 123,
                        "name": "0% btw",
                        "percentage": "0.0",
                        "tax_rate_type": "sales_invoice",
                        "show_tax": true,
                        "active": true,
                        "country": null,
                        "created_at": "2026-11-02T12:15:14.022Z",
                        "updated_at": "2026-11-02T12:15:14.022Z"
                      },
                      {
                        "id": "502689108908311693",
                        "administration_id": 123,
                        "name": "21% btw",
                        "percentage": "21.0",
                        "tax_rate_type": "purchase_invoice",
                        "show_tax": true,
                        "active": true,
                        "country": null,
                        "created_at": "2026-11-02T12:15:14.024Z",
                        "updated_at": "2026-11-02T12:15:14.024Z"
                      },
                      {
                        "id": "502689108909360270",
                        "administration_id": 123,
                        "name": "9% btw",
                        "percentage": "9.0",
                        "tax_rate_type": "purchase_invoice",
                        "show_tax": true,
                        "active": true,
                        "country": null,
                        "created_at": "2026-11-02T12:15:14.024Z",
                        "updated_at": "2026-11-02T12:15:14.024Z"
                      }
                    ]
                  }
                }
              }
            }
          },
          "400": {
            "description": "Bad request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/symbolic_error"
                },
                "examples": {
                  "ReturnsAnErrorWhenTooManyTaxRatesAreRequested": {
                    "summary": "Returns an error when too many tax rates are requested",
                    "value": {
                      "error": "per_page does not have a valid value"
                    }
                  }
                }
              }
            }
          }
        },
        "operationId": "get_administration_id_tax_rates"
      }
    },
    "/{administration_id}/time_entries/{id}/resume{format}": {
      "patch": {
        "summary": "Resume a stopped timer",
        "description": "Resumes a stopped time entry. If another time entry is currently active, it will be stopped first. Can only resume timers that started today.\n\nWhen the time entry belongs to another user than the user of the token, the token also needs the `sales_invoices` scope.\n\n### Required scope(s)\n `time_entries`",
        "tags": [
          "Time entries"
        ],
        "security": [
          {
            "bearerAuth": [
              "time_entries"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/administration_id"
          },
          {
            "name": "id",
            "in": "path",
            "required": true,
            "schema": {
              "$ref": "#/components/schemas/identifier"
            }
          },
          {
            "$ref": "#/components/parameters/format"
          }
        ],
        "responses": {
          "200": {
            "description": "Time entry resumed",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/time_entry_response"
                },
                "examples": {
                  "ResumesAStoppedTimeEntry": {
                    "summary": "Resumes a stopped time entry",
                    "value": {
                      "id": "502689134775633194",
                      "administration_id": 123,
                      "contact_id": null,
                      "project_id": null,
                      "sales_invoice_id": null,
                      "user_id": "502689108256097381",
                      "started_at": "2026-11-02T11:15:00.000Z",
                      "ended_at": null,
                      "description": "Designing the website",
                      "paused_duration": 0,
                      "billable": true,
                      "created_at": "2026-11-02T12:15:38.693Z",
                      "updated_at": "2026-11-02T12:15:38.713Z",
                      "contact": null,
                      "user": {
                        "id": "502689108256097381",
                        "name": "Moneybird",
                        "created_at": "2026-11-02T12:15:13.391Z",
                        "updated_at": "2026-11-02T12:15:13.683Z"
                      },
                      "project": null,
                      "sales_invoice": null,
                      "events": [
                        {
                          "administration_id": 123,
                          "user_id": "502689108256097381",
                          "action": "time_entry_created",
                          "link_entity_id": null,
                          "link_entity_type": null,
                          "data": {},
                          "created_at": "2026-11-02T12:15:38.695Z",
                          "updated_at": "2026-11-02T12:15:38.695Z"
                        },
                        {
                          "administration_id": 123,
                          "user_id": "502689108256097381",
                          "action": "time_entry_updated",
                          "link_entity_id": null,
                          "link_entity_type": null,
                          "data": {
                            "ended_at": [
                              "2026-11-02T13:15:00.000+01:00",
                              null
                            ],
                            "updated_at": [
                              "2026-11-02T13:15:38.693+01:00",
                              "2026-11-02T13:15:38.713+01:00"
                            ]
                          },
                          "created_at": "2026-11-02T12:15:38.715Z",
                          "updated_at": "2026-11-02T12:15:38.715Z"
                        }
                      ],
                      "notes": []
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Not found",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/symbolic_error"
                },
                "examples": {
                  "Returns404WhenTimeEntryDoesNotExist": {
                    "summary": "Returns 404 when time entry does not exist",
                    "value": {
                      "error": "record not found",
                      "symbolic": {
                        "id": "not_found"
                      }
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "Unprocessable entity",
            "content": {
              "application/json": {
                "schema": {
                  "anyOf": [
                    {
                      "$ref": "#/components/schemas/symbolic_error"
                    },
                    {
                      "$ref": "#/components/schemas/non_symbolic_error"
                    }
                  ]
                },
                "examples": {
                  "ReturnsA422IfTheTimeEntryCannotBeResumed": {
                    "summary": "Returns a 422 if the time entry cannot be resumed",
                    "value": {
                      "error": {
                        "base": [
                          "Cannot resume timer"
                        ]
                      },
                      "details": {
                        "base": [
                          {
                            "error": "cannot_resume_timer"
                          }
                        ]
                      }
                    }
                  }
                }
              }
            }
          }
        },
        "operationId": "patch_administration_id_time_entries_id_resume"
      }
    },
    "/{administration_id}/time_entries/{id}/stop{format}": {
      "patch": {
        "summary": "Stops an active time entry",
        "description": "Stops an active time entry. If the time entry is already stopped, the time entry is returned unchanged.\n\nWhen the time entry belongs to another user than the user of the token, the token also needs the `sales_invoices` scope.\n\n### Required scope(s)\n `time_entries`",
        "tags": [
          "Time entries"
        ],
        "security": [
          {
            "bearerAuth": [
              "time_entries"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/administration_id"
          },
          {
            "name": "id",
            "in": "path",
            "required": true,
            "schema": {
              "$ref": "#/components/schemas/identifier"
            }
          },
          {
            "$ref": "#/components/parameters/format"
          }
        ],
        "responses": {
          "200": {
            "description": "Time entry stopped",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/time_entry_response"
                },
                "examples": {
                  "StopsAnActiveTimeEntry": {
                    "summary": "Stops an active time entry",
                    "value": {
                      "id": "502689136353740268",
                      "administration_id": 123,
                      "contact_id": null,
                      "project_id": null,
                      "sales_invoice_id": null,
                      "user_id": "502689108256097381",
                      "started_at": "2026-11-02T12:15:00.000Z",
                      "ended_at": "2026-11-02T12:15:00.000Z",
                      "description": "Designing the website",
                      "paused_duration": 0,
                      "billable": true,
                      "created_at": "2026-11-02T12:15:40.197Z",
                      "updated_at": "2026-11-02T12:15:40.218Z",
                      "contact": null,
                      "user": {
                        "id": "502689108256097381",
                        "name": "Moneybird",
                        "created_at": "2026-11-02T12:15:13.391Z",
                        "updated_at": "2026-11-02T12:15:13.683Z"
                      },
                      "project": null,
                      "sales_invoice": null,
                      "events": [
                        {
                          "administration_id": 123,
                          "user_id": "502689108256097381",
                          "action": "time_entry_created",
                          "link_entity_id": null,
                          "link_entity_type": null,
                          "data": {},
                          "created_at": "2026-11-02T12:15:40.199Z",
                          "updated_at": "2026-11-02T12:15:40.199Z"
                        },
                        {
                          "administration_id": 123,
                          "user_id": "502689108256097381",
                          "action": "time_entry_updated",
                          "link_entity_id": null,
                          "link_entity_type": null,
                          "data": {
                            "ended_at": [
                              null,
                              "2026-11-02T13:15:00.000+01:00"
                            ],
                            "updated_at": [
                              "2026-11-02T13:15:40.197+01:00",
                              "2026-11-02T13:15:40.218+01:00"
                            ]
                          },
                          "created_at": "2026-11-02T12:15:40.220Z",
                          "updated_at": "2026-11-02T12:15:40.220Z"
                        }
                      ],
                      "notes": []
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Not found",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/symbolic_error"
                },
                "examples": {
                  "Returns404WhenTimeEntryDoesNotExist": {
                    "summary": "Returns 404 when time entry does not exist",
                    "value": {
                      "error": "record not found",
                      "symbolic": {
                        "id": "not_found"
                      }
                    }
                  }
                }
              }
            }
          }
        },
        "operationId": "patch_administration_id_time_entries_id_stop"
      }
    },
    "/{administration_id}/time_entries/{id}{format}": {
      "get": {
        "summary": "Get a time entry by id",
        "description": "Returns a time entry in the administration. When the time entry belongs to another user than the user of the\ntoken, the token also needs the `sales_invoices` scope.\n\n### Required scope(s)\n `time_entries`",
        "tags": [
          "Time entries"
        ],
        "security": [
          {
            "bearerAuth": [
              "time_entries"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/administration_id"
          },
          {
            "name": "id",
            "in": "path",
            "required": true,
            "schema": {
              "$ref": "#/components/schemas/identifier"
            }
          },
          {
            "$ref": "#/components/parameters/format"
          }
        ],
        "responses": {
          "200": {
            "description": "A time entry",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/time_entry_response"
                },
                "examples": {
                  "ReturnsTimeEntryByGivenId": {
                    "summary": "Returns time entry by given id",
                    "value": {
                      "id": "502689134245053697",
                      "administration_id": 123,
                      "contact_id": "502689134232470782",
                      "project_id": "502689134236665087",
                      "sales_invoice_id": null,
                      "user_id": "502689108256097381",
                      "started_at": "2026-11-02T12:15:00.000Z",
                      "ended_at": "2026-11-02T13:15:00.000Z",
                      "description": "Designing the website",
                      "paused_duration": 0,
                      "billable": true,
                      "created_at": "2026-11-02T12:15:38.186Z",
                      "updated_at": "2026-11-02T12:15:38.186Z",
                      "contact": {
                        "id": "502689134232470782",
                        "firstname": null,
                        "lastname": null,
                        "company_name": "Foobar Holding B.V."
                      },
                      "user": {
                        "id": "502689108256097381",
                        "name": "Moneybird",
                        "created_at": "2026-11-02T12:15:13.391Z",
                        "updated_at": "2026-11-02T12:15:13.683Z"
                      },
                      "project": {
                        "id": "502689134236665087",
                        "name": "Project 1",
                        "state": "active",
                        "budget": 10
                      },
                      "sales_invoice": null,
                      "events": [
                        {
                          "administration_id": 123,
                          "user_id": "502689108256097381",
                          "action": "time_entry_created",
                          "link_entity_id": null,
                          "link_entity_type": null,
                          "data": {},
                          "created_at": "2026-11-02T12:15:38.188Z",
                          "updated_at": "2026-11-02T12:15:38.188Z"
                        }
                      ],
                      "notes": []
                    }
                  },
                  "DoesNotIncludeTheSalesInvoiceWhenTheApiUserHasNoAccessToSalesInvoices": {
                    "summary": "Does not include the sales invoice when the api user has no access to sales invoices",
                    "value": {
                      "id": "502689134346765581",
                      "administration_id": 123,
                      "contact_id": "502689134335231242",
                      "project_id": "502689134339425547",
                      "sales_invoice_id": null,
                      "user_id": "502689108256097381",
                      "started_at": "2026-11-02T12:15:00.000Z",
                      "ended_at": "2026-11-02T13:15:00.000Z",
                      "description": "Designing the website",
                      "paused_duration": 0,
                      "billable": true,
                      "created_at": "2026-11-02T12:15:38.283Z",
                      "updated_at": "2026-11-02T12:15:38.283Z",
                      "contact": {
                        "id": "502689134335231242",
                        "firstname": null,
                        "lastname": null,
                        "company_name": "Foobar Holding B.V."
                      },
                      "user": {
                        "id": "502689108256097381",
                        "name": "Moneybird",
                        "created_at": "2026-11-02T12:15:13.391Z",
                        "updated_at": "2026-11-02T12:15:13.683Z"
                      },
                      "project": {
                        "id": "502689134339425547",
                        "name": "Project 1",
                        "state": "active",
                        "budget": 10
                      },
                      "events": [
                        {
                          "administration_id": 123,
                          "user_id": "502689108256097381",
                          "action": "time_entry_created",
                          "link_entity_id": null,
                          "link_entity_type": null,
                          "data": {},
                          "created_at": "2026-11-02T12:15:38.285Z",
                          "updated_at": "2026-11-02T12:15:38.285Z"
                        }
                      ],
                      "notes": []
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Not found",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/symbolic_error"
                },
                "examples": {
                  "Returns404WhenTimeEntryDoesNotExist": {
                    "summary": "Returns 404 when time entry does not exist",
                    "value": {
                      "error": "record not found",
                      "symbolic": {
                        "id": "not_found"
                      }
                    }
                  }
                }
              }
            }
          }
        },
        "operationId": "get_administration_id_time_entries_id"
      },
      "patch": {
        "summary": "Update a time entry",
        "description": "When updating a time entry, provide only the attributes you want to update. The other attributes will not be changed.\n`started_at` and `ended_at` are rounded down to full minutes when updating a time entry, with a minimum of 1 minute between them.\n\nWhen the time entry belongs to another user than the user of the token, the token also needs the `sales_invoices` scope.\nA time entry that is on a sales invoice cannot be updated.\n\n### Required scope(s)\n `time_entries`",
        "tags": [
          "Time entries"
        ],
        "security": [
          {
            "bearerAuth": [
              "time_entries"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/administration_id"
          },
          {
            "name": "id",
            "in": "path",
            "required": true,
            "schema": {
              "$ref": "#/components/schemas/identifier"
            }
          },
          {
            "$ref": "#/components/parameters/format"
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/*": {
              "schema": {
                "unevaluatedProperties": false,
                "type": "object",
                "properties": {
                  "time_entry": {
                    "type": "object",
                    "unevaluatedProperties": false,
                    "properties": {
                      "started_at": {
                        "type": "string",
                        "format": "date-time",
                        "description": "The start time of the time entry. Rounded down to full minutes."
                      },
                      "ended_at": {
                        "type": "string",
                        "format": "date-time",
                        "description": "The end time of the time entry. Rounded down to full minutes. A time entry without `ended_at` is considered a running (active) time entry."
                      },
                      "paused_duration": {
                        "type": "integer",
                        "description": "Total paused duration in seconds, is rounded down to full minutes."
                      },
                      "contact_id": {
                        "$ref": "#/components/schemas/identifier",
                        "description": "Should be a valid contact id."
                      },
                      "project_id": {
                        "$ref": "#/components/schemas/identifier",
                        "description": "Should be a valid project id."
                      },
                      "sales_invoice_id": {
                        "$ref": "#/components/schemas/identifier",
                        "description": "Should be a valid sales invoice id."
                      },
                      "description": {
                        "type": "string",
                        "description": "A description of how the time was spent. May be shown on the invoice."
                      },
                      "billable": {
                        "type": [
                          "boolean",
                          "string"
                        ],
                        "description": "Whether this time entry is billable to the client.",
                        "default": true
                      }
                    },
                    "required": []
                  }
                },
                "required": []
              },
              "examples": {
                "UpdatingTheTimeEntryDescription": {
                  "summary": "Updating the time entry description",
                  "value": {
                    "time_entry": {
                      "description": "Updated description"
                    }
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Time entry updated",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/time_entry_response"
                },
                "examples": {
                  "UpdatingTheTimeEntryDescription": {
                    "summary": "Updating the time entry description",
                    "value": {
                      "id": "502689134863713585",
                      "administration_id": 123,
                      "contact_id": "502689134851130670",
                      "project_id": "502689134855324975",
                      "sales_invoice_id": null,
                      "user_id": "502689108256097381",
                      "started_at": "2026-11-02T12:15:00.000Z",
                      "ended_at": "2026-11-02T13:15:00.000Z",
                      "description": "Updated description",
                      "paused_duration": 0,
                      "billable": true,
                      "created_at": "2026-11-02T12:15:38.777Z",
                      "updated_at": "2026-11-02T12:15:38.792Z",
                      "contact": {
                        "id": "502689134851130670",
                        "firstname": null,
                        "lastname": null,
                        "company_name": "Foobar Holding B.V."
                      },
                      "user": {
                        "id": "502689108256097381",
                        "name": "Moneybird",
                        "created_at": "2026-11-02T12:15:13.391Z",
                        "updated_at": "2026-11-02T12:15:13.683Z"
                      },
                      "project": {
                        "id": "502689134855324975",
                        "name": "Project 1",
                        "state": "active",
                        "budget": 10
                      },
                      "sales_invoice": null,
                      "events": [
                        {
                          "administration_id": 123,
                          "user_id": "502689108256097381",
                          "action": "time_entry_created",
                          "link_entity_id": null,
                          "link_entity_type": null,
                          "data": {},
                          "created_at": "2026-11-02T12:15:38.778Z",
                          "updated_at": "2026-11-02T12:15:38.778Z"
                        },
                        {
                          "administration_id": 123,
                          "user_id": "502689108256097381",
                          "action": "time_entry_updated",
                          "link_entity_id": null,
                          "link_entity_type": null,
                          "data": {
                            "description": [
                              "Designing the website",
                              "Updated description"
                            ],
                            "updated_at": [
                              "2026-11-02T13:15:38.777+01:00",
                              "2026-11-02T13:15:38.792+01:00"
                            ]
                          },
                          "created_at": "2026-11-02T12:15:38.793Z",
                          "updated_at": "2026-11-02T12:15:38.793Z"
                        }
                      ],
                      "notes": []
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Not found",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/symbolic_error"
                },
                "examples": {
                  "Returns404WhenTimeEntryDoesNotExist": {
                    "summary": "Returns 404 when time entry does not exist",
                    "value": {
                      "error": "record not found",
                      "symbolic": {
                        "id": "not_found"
                      }
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "Unprocessable entity",
            "content": {
              "application/json": {
                "schema": {
                  "anyOf": [
                    {
                      "$ref": "#/components/schemas/symbolic_error"
                    },
                    {
                      "$ref": "#/components/schemas/non_symbolic_error"
                    }
                  ]
                },
                "examples": {
                  "Returns422ForASalesInvoiceOfAnotherAdministration": {
                    "summary": "Returns 422 for a sales invoice of another administration",
                    "value": {
                      "error": {
                        "sales_invoice_id": [
                          "is not found"
                        ]
                      },
                      "details": {
                        "sales_invoice_id": [
                          {
                            "error": "invalid"
                          }
                        ]
                      }
                    }
                  },
                  "Returns422WhenInvalidDataIsProvided": {
                    "summary": "Returns 422 when invalid data is provided",
                    "value": {
                      "error": {
                        "description": [
                          "can't be blank"
                        ]
                      },
                      "details": {
                        "description": [
                          {
                            "error": "blank"
                          }
                        ]
                      }
                    }
                  }
                }
              }
            }
          }
        },
        "operationId": "patch_administration_id_time_entries_id"
      },
      "delete": {
        "summary": "Delete a time entry",
        "description": "Delete a time entry by id. When the time entry belongs to another user than the user of the token, the token\nalso needs the `sales_invoices` scope. A time entry that is on a sales invoice cannot be deleted.\n\n### Required scope(s)\n `time_entries`",
        "tags": [
          "Time entries"
        ],
        "security": [
          {
            "bearerAuth": [
              "time_entries"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/administration_id"
          },
          {
            "name": "id",
            "in": "path",
            "required": true,
            "schema": {
              "$ref": "#/components/schemas/identifier"
            }
          },
          {
            "$ref": "#/components/parameters/format"
          }
        ],
        "responses": {
          "204": {
            "description": "Time entry deleted"
          },
          "404": {
            "description": "Not found",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/symbolic_error"
                },
                "examples": {
                  "Returns404WhenTimeEntryDoesNotExist": {
                    "summary": "Returns 404 when time entry does not exist",
                    "value": {
                      "error": "record not found",
                      "symbolic": {
                        "id": "not_found"
                      }
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "Unprocessable entity",
            "content": {
              "application/json": {
                "schema": {
                  "anyOf": [
                    {
                      "$ref": "#/components/schemas/symbolic_error"
                    },
                    {
                      "$ref": "#/components/schemas/non_symbolic_error"
                    }
                  ]
                },
                "examples": {
                  "Returns422WhenTheTimeEntryIsOnASalesInvoice": {
                    "summary": "Returns 422 when the time entry is on a sales invoice",
                    "value": {
                      "error": "ID is invalid",
                      "symbolic": {
                        "id": "cannot_destroy"
                      }
                    }
                  }
                }
              }
            }
          }
        },
        "operationId": "delete_administration_id_time_entries_id"
      }
    },
    "/{administration_id}/time_entries/{time_entry_id}/notes/{id}{format}": {
      "delete": {
        "summary": "Destroys note from entity",
        "description": "Deletes a note from a time entry.\n\n### Required scope(s)\n `time_entries`",
        "tags": [
          "Time entries"
        ],
        "security": [
          {
            "bearerAuth": [
              "time_entries"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/administration_id"
          },
          {
            "name": "time_entry_id",
            "in": "path",
            "required": true,
            "schema": {
              "$ref": "#/components/schemas/identifier"
            }
          },
          {
            "name": "id",
            "in": "path",
            "required": true,
            "schema": {
              "$ref": "#/components/schemas/identifier"
            }
          },
          {
            "$ref": "#/components/parameters/format"
          }
        ],
        "responses": {
          "204": {
            "description": "Note deleted"
          }
        },
        "operationId": "delete_administration_id_time_entries_time_entry_id_notes_id"
      }
    },
    "/{administration_id}/time_entries/{time_entry_id}/notes{format}": {
      "post": {
        "summary": "Adds note to entity",
        "description": "Adds a note to the time entry.\n\n### Required scope(s)\n `time_entries`",
        "tags": [
          "Time entries"
        ],
        "security": [
          {
            "bearerAuth": [
              "time_entries"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/administration_id"
          },
          {
            "name": "time_entry_id",
            "in": "path",
            "required": true,
            "schema": {
              "$ref": "#/components/schemas/identifier"
            }
          },
          {
            "$ref": "#/components/parameters/format"
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/*": {
              "schema": {
                "unevaluatedProperties": false,
                "type": "object",
                "properties": {
                  "note": {
                    "type": "object",
                    "unevaluatedProperties": false,
                    "properties": {
                      "note": {
                        "type": "string",
                        "description": "**Required**. Text for the note or to-do."
                      },
                      "todo": {
                        "type": [
                          "boolean",
                          "string"
                        ],
                        "description": "If `true` the note is a to-do."
                      },
                      "assignee_id": {
                        "$ref": "#/components/schemas/identifier",
                        "description": "Assign to-do to user. Should be a valid user id. If assignee_id is provided the note will be a to-do."
                      }
                    },
                    "required": []
                  }
                },
                "required": []
              },
              "examples": {
                "CreateANote": {
                  "summary": "Create a note",
                  "value": {
                    "note": {
                      "note": "Text of the note",
                      "assignee_id": 502689134528169200,
                      "todo": true
                    }
                  }
                }
              }
            }
          }
        },
        "responses": {
          "201": {
            "description": "Note created",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/note_response"
                },
                "examples": {
                  "CreateANote": {
                    "summary": "Create a note",
                    "value": {
                      "id": "502689134566966566",
                      "administration_id": 123,
                      "entity_id": "502689134550189348",
                      "entity_type": "TimeEntry",
                      "user_id": "502689108256097381",
                      "assignee_id": "502689134528169246",
                      "todo": true,
                      "note": "Text of the note",
                      "completed_at": null,
                      "completed_by_id": null,
                      "todo_type": null,
                      "data": {},
                      "created_at": "2026-11-02T12:15:38.493Z",
                      "updated_at": "2026-11-02T12:15:38.493Z"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "Unprocessable entity",
            "content": {
              "application/json": {
                "schema": {
                  "anyOf": [
                    {
                      "$ref": "#/components/schemas/symbolic_error"
                    },
                    {
                      "$ref": "#/components/schemas/non_symbolic_error"
                    }
                  ]
                },
                "examples": {
                  "Returns422WhenInvalidNoteDataIsProvided": {
                    "summary": "Returns 422 when invalid note data is provided",
                    "value": {
                      "error": {
                        "note": [
                          "can't be blank"
                        ],
                        "todo_type": [
                          "can't be blank"
                        ]
                      },
                      "details": {
                        "note": [
                          {
                            "error": "blank"
                          }
                        ],
                        "todo_type": [
                          {
                            "error": "blank"
                          }
                        ]
                      }
                    }
                  }
                }
              }
            }
          }
        },
        "operationId": "post_administration_id_time_entries_time_entry_id_notes"
      }
    },
    "/{administration_id}/time_entries{format}": {
      "get": {
        "summary": "List all time entries",
        "description": "Returns a paginated list of time entries in the administration.\n\n### Required scope(s)\n `time_entries`",
        "tags": [
          "Time entries"
        ],
        "security": [
          {
            "bearerAuth": [
              "time_entries"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/administration_id"
          },
          {
            "$ref": "#/components/parameters/format"
          },
          {
            "name": "filter",
            "in": "query",
            "required": false,
            "description": "Filters are `key:value` terms separated by commas (e.g. `period:this_year,state:all`). Any filter you pass replaces the defaults below entirely, so include every key you need. Available filters:\n\n| **Filter** | **Type** | **Default** | **Description** |\n| --- | --- | --- | --- |\n| state | `String` | `all` | `all`, `open` or `non_billable` |\n| period | `String` | `this_year` | This can either be the description of a period (`this_week`, `prev_week`, `next_week`, `this_month`, `prev_month`, `next_month`, `this_quarter`, `prev_quarter`, `next_quarter`, `this_year`, `prev_year`, `next_year`) or a custom period (`201301..201302`, `20130101..20130131`). A custom period must have a start and an end date. It must not be longer than 10 years and must be between `20000101` and `21000101`. For one month, use `202401..202401`, not `202401`. Without `period`, the filter does not limit the dates. The default `this_year` applies only when you send no `filter`. |\n| contact_id | `Integer` | | Select time entries belonging to a certain contact |\n| include_nil_contacts | `Boolean` | false | Whether to include time entries that have no assigned contact |\n| include_active | `Boolean` | false | Whether to include active time entries i.e. time entries without ended_at |\n| project_id | `Integer` | | Select time entries belonging to a certain project |\n| user_id | `Integer` | | Select time entries belonging to a certain user |\n| day | `Date` | | Select time entries on a specific date |\n\nYou can filter by multiple states at the same time as well. To do this, separate the state values by a pipe: `state:open|non_billable`.",
            "schema": {
              "type": "string",
              "default": "period:this_year"
            },
            "examples": {
              "ReturnsAllTimeEntriesFilteredOnState": {
                "summary": "Returns all time entries filtered on state",
                "value": "state:non_billable"
              },
              "ReturnsAllTimeEntriesFilteredOnPeriod": {
                "summary": "Returns all time entries filtered on period",
                "value": "period:this_month"
              }
            }
          },
          {
            "$ref": "#/components/parameters/page"
          },
          {
            "$ref": "#/components/parameters/per_page"
          },
          {
            "name": "query",
            "in": "query",
            "required": false,
            "description": "Free-text search across the time entry description.",
            "schema": {
              "type": "string"
            },
            "examples": {
              "ReturnsAllTimeEntriesFilteredOnSearchQuery": {
                "summary": "Returns all time entries filtered on search query",
                "value": "Custom"
              }
            }
          }
        ],
        "responses": {
          "200": {
            "description": "A list of time entries",
            "content": {
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "$ref": "#/components/schemas/time_entry_response"
                  }
                },
                "examples": {
                  "ReturnsAllTimeEntriesFilteredOnSearchQuery": {
                    "summary": "Returns all time entries filtered on search query",
                    "value": [
                      {
                        "id": "502689135426798983",
                        "administration_id": 123,
                        "contact_id": null,
                        "project_id": null,
                        "sales_invoice_id": null,
                        "user_id": 3,
                        "started_at": "2026-11-02T12:15:00.000Z",
                        "ended_at": "2026-11-02T13:15:00.000Z",
                        "description": "Custom description",
                        "paused_duration": 0,
                        "billable": true,
                        "created_at": "2026-11-02T12:15:39.314Z",
                        "updated_at": "2026-11-02T12:15:39.314Z",
                        "contact": null,
                        "user": {
                          "id": 3,
                          "name": "Edwin Vlieg",
                          "created_at": "2026-11-02T12:15:39.307Z",
                          "updated_at": "2026-11-02T12:15:39.311Z"
                        },
                        "project": null,
                        "sales_invoice": null,
                        "events": [
                          {
                            "administration_id": 123,
                            "user_id": 3,
                            "action": "time_entry_created",
                            "link_entity_id": null,
                            "link_entity_type": null,
                            "data": {},
                            "created_at": "2026-11-02T12:15:39.315Z",
                            "updated_at": "2026-11-02T12:15:39.315Z"
                          }
                        ],
                        "notes": []
                      }
                    ]
                  },
                  "ReturnsPaginatedTimeEntriesOnPage1": {
                    "summary": "Returns paginated time entries on page 1",
                    "value": [
                      {
                        "id": "502689135615542681",
                        "administration_id": 123,
                        "contact_id": "502689135600862614",
                        "project_id": "502689135607154071",
                        "sales_invoice_id": null,
                        "user_id": "502689108256097381",
                        "started_at": "2026-11-02T12:15:00.000Z",
                        "ended_at": "2026-11-02T13:15:00.000Z",
                        "description": "Designing the website",
                        "paused_duration": 0,
                        "billable": true,
                        "created_at": "2026-11-02T12:15:39.493Z",
                        "updated_at": "2026-11-02T12:15:39.493Z",
                        "contact": {
                          "id": "502689135600862614",
                          "firstname": null,
                          "lastname": null,
                          "company_name": "Foobar Holding B.V."
                        },
                        "user": {
                          "id": "502689108256097381",
                          "name": "Moneybird",
                          "created_at": "2026-11-02T12:15:13.391Z",
                          "updated_at": "2026-11-02T12:15:13.683Z"
                        },
                        "project": {
                          "id": "502689135607154071",
                          "name": "Project 1",
                          "state": "active",
                          "budget": 10
                        },
                        "sales_invoice": null,
                        "events": [
                          {
                            "administration_id": 123,
                            "user_id": "502689108256097381",
                            "action": "time_entry_created",
                            "link_entity_id": null,
                            "link_entity_type": null,
                            "data": {},
                            "created_at": "2026-11-02T12:15:39.495Z",
                            "updated_at": "2026-11-02T12:15:39.495Z"
                          }
                        ],
                        "notes": []
                      }
                    ]
                  },
                  "ReturnsAllTimeEntriesOfAnAdministration": {
                    "summary": "Returns all time entries of an administration",
                    "value": [
                      {
                        "id": "502689135745566117",
                        "administration_id": 123,
                        "contact_id": "502689135728788898",
                        "project_id": "502689135736128931",
                        "sales_invoice_id": null,
                        "user_id": "502689108256097381",
                        "started_at": "2026-11-02T12:15:00.000Z",
                        "ended_at": "2026-11-02T13:15:00.000Z",
                        "description": "Designing the website",
                        "paused_duration": 0,
                        "billable": true,
                        "created_at": "2026-11-02T12:15:39.617Z",
                        "updated_at": "2026-11-02T12:15:39.617Z",
                        "contact": {
                          "id": "502689135728788898",
                          "firstname": null,
                          "lastname": null,
                          "company_name": "Foobar Holding B.V."
                        },
                        "user": {
                          "id": "502689108256097381",
                          "name": "Moneybird",
                          "created_at": "2026-11-02T12:15:13.391Z",
                          "updated_at": "2026-11-02T12:15:13.683Z"
                        },
                        "project": {
                          "id": "502689135736128931",
                          "name": "Project 1",
                          "state": "active",
                          "budget": 10
                        },
                        "sales_invoice": null,
                        "events": [
                          {
                            "administration_id": 123,
                            "user_id": "502689108256097381",
                            "action": "time_entry_created",
                            "link_entity_id": null,
                            "link_entity_type": null,
                            "data": {},
                            "created_at": "2026-11-02T12:15:39.619Z",
                            "updated_at": "2026-11-02T12:15:39.619Z"
                          }
                        ],
                        "notes": []
                      },
                      {
                        "id": "502689135762343336",
                        "administration_id": 123,
                        "contact_id": null,
                        "project_id": null,
                        "sales_invoice_id": null,
                        "user_id": 1,
                        "started_at": "2026-11-02T12:15:00.000Z",
                        "ended_at": "2026-11-02T13:15:00.000Z",
                        "description": "Designing the website",
                        "paused_duration": 0,
                        "billable": false,
                        "created_at": "2026-11-02T12:15:39.633Z",
                        "updated_at": "2026-11-02T12:15:39.633Z",
                        "contact": null,
                        "user": {
                          "id": 1,
                          "name": "Edwin Vlieg",
                          "created_at": "2026-11-02T12:15:39.626Z",
                          "updated_at": "2026-11-02T12:15:39.630Z"
                        },
                        "project": null,
                        "sales_invoice": null,
                        "events": [
                          {
                            "administration_id": 123,
                            "user_id": 1,
                            "action": "time_entry_created",
                            "link_entity_id": null,
                            "link_entity_type": null,
                            "data": {},
                            "created_at": "2026-11-02T12:15:39.635Z",
                            "updated_at": "2026-11-02T12:15:39.635Z"
                          }
                        ],
                        "notes": []
                      },
                      {
                        "id": "502689135774926251",
                        "administration_id": 123,
                        "contact_id": null,
                        "project_id": null,
                        "sales_invoice_id": null,
                        "user_id": 2,
                        "started_at": "2026-11-02T12:15:00.000Z",
                        "ended_at": "2026-11-02T13:15:00.000Z",
                        "description": "Designing the website",
                        "paused_duration": 0,
                        "billable": true,
                        "created_at": "2026-11-02T12:15:39.646Z",
                        "updated_at": "2026-11-02T12:15:39.646Z",
                        "contact": null,
                        "user": {
                          "id": 2,
                          "name": "Edwin Vlieg",
                          "created_at": "2026-11-02T12:15:39.641Z",
                          "updated_at": "2026-11-02T12:15:39.644Z"
                        },
                        "project": null,
                        "sales_invoice": null,
                        "events": [
                          {
                            "administration_id": 123,
                            "user_id": 2,
                            "action": "time_entry_created",
                            "link_entity_id": null,
                            "link_entity_type": null,
                            "data": {},
                            "created_at": "2026-11-02T12:15:39.647Z",
                            "updated_at": "2026-11-02T12:15:39.647Z"
                          }
                        ],
                        "notes": []
                      }
                    ]
                  },
                  "ReturnsPaginatedTimeEntriesOnPage2": {
                    "summary": "Returns paginated time entries on page 2",
                    "value": [
                      {
                        "id": "502689135860909492",
                        "administration_id": 123,
                        "contact_id": null,
                        "project_id": null,
                        "sales_invoice_id": null,
                        "user_id": 1,
                        "started_at": "2026-11-02T12:15:00.000Z",
                        "ended_at": "2026-11-02T13:15:00.000Z",
                        "description": "Designing the website",
                        "paused_duration": 0,
                        "billable": false,
                        "created_at": "2026-11-02T12:15:39.728Z",
                        "updated_at": "2026-11-02T12:15:39.728Z",
                        "contact": null,
                        "user": {
                          "id": 1,
                          "name": "Edwin Vlieg",
                          "created_at": "2026-11-02T12:15:39.720Z",
                          "updated_at": "2026-11-02T12:15:39.724Z"
                        },
                        "project": null,
                        "sales_invoice": null,
                        "events": [
                          {
                            "administration_id": 123,
                            "user_id": 1,
                            "action": "time_entry_created",
                            "link_entity_id": null,
                            "link_entity_type": null,
                            "data": {},
                            "created_at": "2026-11-02T12:15:39.729Z",
                            "updated_at": "2026-11-02T12:15:39.729Z"
                          }
                        ],
                        "notes": []
                      }
                    ]
                  },
                  "ReturnsAllTimeEntriesFilteredOnState": {
                    "summary": "Returns all time entries filtered on state",
                    "value": [
                      {
                        "id": "502689135969961408",
                        "administration_id": 123,
                        "contact_id": null,
                        "project_id": null,
                        "sales_invoice_id": null,
                        "user_id": 1,
                        "started_at": "2026-11-02T12:15:00.000Z",
                        "ended_at": "2026-11-02T13:15:00.000Z",
                        "description": "Designing the website",
                        "paused_duration": 0,
                        "billable": false,
                        "created_at": "2026-11-02T12:15:39.831Z",
                        "updated_at": "2026-11-02T12:15:39.831Z",
                        "contact": null,
                        "user": {
                          "id": 1,
                          "name": "Edwin Vlieg",
                          "created_at": "2026-11-02T12:15:39.824Z",
                          "updated_at": "2026-11-02T12:15:39.828Z"
                        },
                        "project": null,
                        "sales_invoice": null,
                        "events": [
                          {
                            "administration_id": 123,
                            "user_id": 1,
                            "action": "time_entry_created",
                            "link_entity_id": null,
                            "link_entity_type": null,
                            "data": {},
                            "created_at": "2026-11-02T12:15:39.833Z",
                            "updated_at": "2026-11-02T12:15:39.833Z"
                          }
                        ],
                        "notes": []
                      }
                    ]
                  },
                  "ReturnsAllTimeEntriesFilteredOnPeriod": {
                    "summary": "Returns all time entries filtered on period",
                    "value": [
                      {
                        "id": "502689136235251169",
                        "administration_id": 123,
                        "contact_id": "502689136221619678",
                        "project_id": "502689136226862559",
                        "sales_invoice_id": null,
                        "user_id": "502689108256097381",
                        "started_at": "2026-11-02T12:15:00.000Z",
                        "ended_at": "2026-11-02T13:15:00.000Z",
                        "description": "Designing the website",
                        "paused_duration": 0,
                        "billable": true,
                        "created_at": "2026-11-02T12:15:40.085Z",
                        "updated_at": "2026-11-02T12:15:40.085Z",
                        "contact": {
                          "id": "502689136221619678",
                          "firstname": null,
                          "lastname": null,
                          "company_name": "Foobar Holding B.V."
                        },
                        "user": {
                          "id": "502689108256097381",
                          "name": "Moneybird",
                          "created_at": "2026-11-02T12:15:13.391Z",
                          "updated_at": "2026-11-02T12:15:13.683Z"
                        },
                        "project": {
                          "id": "502689136226862559",
                          "name": "Project 1",
                          "state": "active",
                          "budget": 10
                        },
                        "sales_invoice": null,
                        "events": [
                          {
                            "administration_id": 123,
                            "user_id": "502689108256097381",
                            "action": "time_entry_created",
                            "link_entity_id": null,
                            "link_entity_type": null,
                            "data": {},
                            "created_at": "2026-11-02T12:15:40.086Z",
                            "updated_at": "2026-11-02T12:15:40.086Z"
                          }
                        ],
                        "notes": []
                      },
                      {
                        "id": "502689136249931236",
                        "administration_id": 123,
                        "contact_id": null,
                        "project_id": null,
                        "sales_invoice_id": null,
                        "user_id": 1,
                        "started_at": "2026-11-02T12:15:00.000Z",
                        "ended_at": "2026-11-02T13:15:00.000Z",
                        "description": "Designing the website",
                        "paused_duration": 0,
                        "billable": false,
                        "created_at": "2026-11-02T12:15:40.098Z",
                        "updated_at": "2026-11-02T12:15:40.098Z",
                        "contact": null,
                        "user": {
                          "id": 1,
                          "name": "Edwin Vlieg",
                          "created_at": "2026-11-02T12:15:40.092Z",
                          "updated_at": "2026-11-02T12:15:40.096Z"
                        },
                        "project": null,
                        "sales_invoice": null,
                        "events": [
                          {
                            "administration_id": 123,
                            "user_id": 1,
                            "action": "time_entry_created",
                            "link_entity_id": null,
                            "link_entity_type": null,
                            "data": {},
                            "created_at": "2026-11-02T12:15:40.100Z",
                            "updated_at": "2026-11-02T12:15:40.100Z"
                          }
                        ],
                        "notes": []
                      },
                      {
                        "id": "502689136260416999",
                        "administration_id": 123,
                        "contact_id": null,
                        "project_id": null,
                        "sales_invoice_id": null,
                        "user_id": 2,
                        "started_at": "2026-11-02T12:15:00.000Z",
                        "ended_at": "2026-11-02T13:15:00.000Z",
                        "description": "Designing the website",
                        "paused_duration": 0,
                        "billable": true,
                        "created_at": "2026-11-02T12:15:40.109Z",
                        "updated_at": "2026-11-02T12:15:40.109Z",
                        "contact": null,
                        "user": {
                          "id": 2,
                          "name": "Edwin Vlieg",
                          "created_at": "2026-11-02T12:15:40.105Z",
                          "updated_at": "2026-11-02T12:15:40.107Z"
                        },
                        "project": null,
                        "sales_invoice": null,
                        "events": [
                          {
                            "administration_id": 123,
                            "user_id": 2,
                            "action": "time_entry_created",
                            "link_entity_id": null,
                            "link_entity_type": null,
                            "data": {},
                            "created_at": "2026-11-02T12:15:40.110Z",
                            "updated_at": "2026-11-02T12:15:40.110Z"
                          }
                        ],
                        "notes": []
                      }
                    ]
                  }
                }
              }
            }
          },
          "400": {
            "description": "Bad request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/symbolic_error"
                },
                "examples": {
                  "ReturnsAnErrorWhenTooManyTimeEntriesAreRequested": {
                    "summary": "Returns an error when too many time entries are requested",
                    "value": {
                      "error": "per_page does not have a valid value"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Not found",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/symbolic_error"
                },
                "examples": {
                  "ReturnsAnErrorMessageIfFilterContactIdIsNotFound": {
                    "summary": "Returns an error message if filter contact id is not found",
                    "value": {
                      "error": "record not found",
                      "symbolic": {
                        "contact_id": "not_found"
                      }
                    }
                  },
                  "ReturnsAnErrorMessageIfFilterUserIdIsNotFound": {
                    "summary": "Returns an error message if filter user id is not found",
                    "value": {
                      "error": "record not found",
                      "symbolic": {
                        "user_id": "not_found"
                      }
                    }
                  }
                }
              }
            }
          }
        },
        "operationId": "get_administration_id_time_entries"
      },
      "post": {
        "summary": "Create a time entry",
        "description": "API to post a time entry. Used to create time entries to record time spent by an employee.\nApi user needs access to both sales invoices and time entries for this action.\n`started_at` and `ended_at` are rounded down to full minutes when creating a time entry, with a minimum of 1 minute between them.\n\n### Required scope(s)\n `time_entries`",
        "tags": [
          "Time entries"
        ],
        "security": [
          {
            "bearerAuth": [
              "time_entries"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/administration_id"
          },
          {
            "$ref": "#/components/parameters/format"
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/*": {
              "schema": {
                "unevaluatedProperties": false,
                "type": "object",
                "properties": {
                  "time_entry": {
                    "type": "object",
                    "unevaluatedProperties": false,
                    "properties": {
                      "user_id": {
                        "$ref": "#/components/schemas/identifier",
                        "description": "The employee for which the time should be entered. Should be a valid user id."
                      },
                      "started_at": {
                        "$ref": "#/components/schemas/timestamp",
                        "description": "The start time of the time entry. Rounded down to full minutes."
                      },
                      "ended_at": {
                        "$ref": "#/components/schemas/timestamp",
                        "description": "The end time of the time entry. Rounded down to full minutes. Omit to create a running (active) time entry."
                      },
                      "description": {
                        "type": "string",
                        "description": "A description on how the time was spent. May be shown on the invoice."
                      },
                      "contact_id": {
                        "$ref": "#/components/schemas/identifier",
                        "description": "Should be a valid contact id."
                      },
                      "project_id": {
                        "$ref": "#/components/schemas/identifier",
                        "description": "Should be a valid project id."
                      },
                      "sales_invoice_id": {
                        "$ref": "#/components/schemas/identifier",
                        "description": "Should be a valid sales invoice id."
                      },
                      "billable": {
                        "type": [
                          "boolean",
                          "string"
                        ],
                        "default": true,
                        "description": "Whether this time entry is billable to the client."
                      },
                      "paused_duration": {
                        "type": "integer",
                        "description": "Total paused duration in seconds, is rounded down to full minutes."
                      }
                    },
                    "required": [
                      "user_id",
                      "started_at",
                      "description"
                    ]
                  }
                },
                "required": []
              },
              "examples": {
                "CreateABasicTimeEntry": {
                  "summary": "Create a basic time entry",
                  "value": {
                    "time_entry": {
                      "started_at": "2026-11-02T12:15:00.000Z",
                      "ended_at": "2026-11-02T13:15:00.000Z",
                      "description": "Test",
                      "contact_id": 502689134083573000,
                      "project_id": 502689134095107300,
                      "user_id": 502689108256097400,
                      "billable": false
                    }
                  }
                }
              }
            }
          }
        },
        "responses": {
          "201": {
            "description": "Time entry created",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/time_entry_response"
                },
                "examples": {
                  "CreateABasicTimeEntry": {
                    "summary": "Create a basic time entry",
                    "value": {
                      "id": "502689134117127419",
                      "administration_id": 123,
                      "contact_id": "502689134083572984",
                      "project_id": "502689134095107321",
                      "sales_invoice_id": null,
                      "user_id": "502689108256097381",
                      "started_at": "2026-11-02T12:15:00.000Z",
                      "ended_at": "2026-11-02T13:15:00.000Z",
                      "description": "Test",
                      "paused_duration": 0,
                      "billable": false,
                      "created_at": "2026-11-02T12:15:38.065Z",
                      "updated_at": "2026-11-02T12:15:38.065Z",
                      "contact": {
                        "id": "502689134083572984",
                        "firstname": null,
                        "lastname": null,
                        "company_name": "Foobar Holding B.V."
                      },
                      "user": {
                        "id": "502689108256097381",
                        "name": "Moneybird",
                        "created_at": "2026-11-02T12:15:13.391Z",
                        "updated_at": "2026-11-02T12:15:13.683Z"
                      },
                      "project": {
                        "id": "502689134095107321",
                        "name": "Project 1",
                        "state": "active",
                        "budget": 10
                      },
                      "sales_invoice": null,
                      "events": [
                        {
                          "administration_id": 123,
                          "user_id": "502689108256097381",
                          "action": "time_entry_created",
                          "link_entity_id": null,
                          "link_entity_type": null,
                          "data": {},
                          "created_at": "2026-11-02T12:15:38.067Z",
                          "updated_at": "2026-11-02T12:15:38.067Z"
                        }
                      ],
                      "notes": []
                    }
                  }
                }
              }
            }
          },
          "402": {
            "description": "Payment required",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/symbolic_error"
                },
                "examples": {
                  "Returns402WhenLimitIsReached": {
                    "summary": "Returns 402 when limit is reached",
                    "value": {
                      "error": "creating time entries is limited",
                      "symbolic": {
                        "administration": "limit_reached"
                      }
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Not found",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/symbolic_error"
                },
                "examples": {
                  "Returns404WhenSalesInvoiceIdDoesNotExist": {
                    "summary": "Returns 404 when sales invoice id does not exist",
                    "value": {
                      "error": "no sales invoice with given ID found",
                      "symbolic": {
                        "sales_invoice_id": "not_found"
                      }
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "Unprocessable entity",
            "content": {
              "application/json": {
                "schema": {
                  "anyOf": [
                    {
                      "$ref": "#/components/schemas/symbolic_error"
                    },
                    {
                      "$ref": "#/components/schemas/non_symbolic_error"
                    }
                  ]
                },
                "examples": {
                  "ReturnsAnErrorWhenInvalidDetailsAreProvided": {
                    "summary": "Returns an error when invalid details are provided",
                    "value": {
                      "error": {
                        "ended_at": [
                          "cannot be before the start time"
                        ],
                        "description": [
                          "can't be blank"
                        ]
                      },
                      "details": {
                        "ended_at": [
                          {
                            "error": "ended_at_before_started_at"
                          }
                        ],
                        "description": [
                          {
                            "error": "blank"
                          }
                        ]
                      }
                    }
                  }
                }
              }
            }
          }
        },
        "operationId": "post_administration_id_time_entries"
      }
    },
    "/{administration_id}/users{format}": {
      "get": {
        "summary": "List all users",
        "description": "Returns a list of users within the administration.\n\n### Required scope(s)\n `settings`",
        "tags": [
          "Users"
        ],
        "security": [
          {
            "bearerAuth": [
              "settings"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/administration_id"
          },
          {
            "$ref": "#/components/parameters/format"
          },
          {
            "name": "include_inactive",
            "in": "query",
            "required": false,
            "schema": {
              "type": [
                "boolean",
                "string"
              ],
              "default": false
            },
            "examples": {
              "IncludesInactiveUsersWhenIncludeInactiveIsTrue": {
                "summary": "Includes inactive users when include inactive is true",
                "value": "true"
              },
              "ExcludesInactiveUsersAccountantsAndApiUsersWhenTheIncludeFlagsAreFalse": {
                "summary": "Excludes inactive users, accountants and api users when the include flags are false",
                "value": "false"
              }
            }
          },
          {
            "name": "include_accountants",
            "in": "query",
            "required": false,
            "schema": {
              "type": [
                "boolean",
                "string"
              ],
              "default": false
            },
            "examples": {
              "IncludesAccountsWhenIncludeAccountantsIsTrue": {
                "summary": "Includes accounts when include accountants is true",
                "value": "true"
              },
              "ExcludesInactiveUsersAccountantsAndApiUsersWhenTheIncludeFlagsAreFalse": {
                "summary": "Excludes inactive users, accountants and api users when the include flags are false",
                "value": "false"
              }
            }
          },
          {
            "name": "include_api_users",
            "in": "query",
            "required": false,
            "schema": {
              "type": [
                "boolean",
                "string"
              ],
              "default": false
            },
            "examples": {
              "IncludesApiUsersWhenIncludeApiUsersIsTrue": {
                "summary": "Includes api users when include api users is true",
                "value": "true"
              },
              "ExcludesInactiveUsersAccountantsAndApiUsersWhenTheIncludeFlagsAreFalse": {
                "summary": "Excludes inactive users, accountants and api users when the include flags are false",
                "value": "false"
              }
            }
          }
        ],
        "responses": {
          "200": {
            "description": "A list of users",
            "content": {
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "$ref": "#/components/schemas/extended_user_response"
                  }
                },
                "examples": {
                  "IncludesAccountsWhenIncludeAccountantsIsTrue": {
                    "summary": "Includes accounts when include accountants is true",
                    "value": [
                      {
                        "id": "502689108270777446",
                        "name": "Mo Neybird",
                        "created_at": "2026-11-02T12:15:13.414Z",
                        "updated_at": "2026-11-02T12:15:13.708Z",
                        "email": "info@moneybird.nl",
                        "email_validated": true,
                        "language": "nl",
                        "time_zone": "Europe/Amsterdam",
                        "user_type": "owner",
                        "permissions": [
                          "sales_invoices",
                          "documents",
                          "estimates",
                          "bank",
                          "settings",
                          "ownership",
                          "time_entries"
                        ]
                      },
                      {
                        "id": "502689313459275112",
                        "name": "A. Accountant.",
                        "created_at": "2026-11-02T12:18:29.098Z",
                        "updated_at": "2026-11-02T12:18:29.102Z",
                        "email": "john+6@example.com",
                        "email_validated": true,
                        "language": "nl",
                        "time_zone": "Europe/Amsterdam",
                        "user_type": "accountant",
                        "permissions": [
                          "sales_invoices",
                          "documents",
                          "estimates",
                          "bank",
                          "settings",
                          "time_entries"
                        ]
                      }
                    ]
                  },
                  "IncludesInactiveUsersWhenIncludeInactiveIsTrue": {
                    "summary": "Includes inactive users when include inactive is true",
                    "value": [
                      {
                        "id": "502689108270777446",
                        "name": "Mo Neybird",
                        "created_at": "2026-11-02T12:15:13.414Z",
                        "updated_at": "2026-11-02T12:15:13.708Z",
                        "email": "info@moneybird.nl",
                        "email_validated": true,
                        "language": "nl",
                        "time_zone": "Europe/Amsterdam",
                        "user_type": "owner",
                        "permissions": [
                          "sales_invoices",
                          "documents",
                          "estimates",
                          "bank",
                          "settings",
                          "ownership",
                          "time_entries"
                        ]
                      },
                      {
                        "id": "502689313499121002",
                        "name": "A. User.",
                        "created_at": "2026-11-02T12:18:29.136Z",
                        "updated_at": "2026-11-02T12:18:29.144Z"
                      }
                    ]
                  },
                  "IncludesApiUsersWhenIncludeApiUsersIsTrue": {
                    "summary": "Includes api users when include api users is true",
                    "value": [
                      {
                        "id": "502689108270777446",
                        "name": "Mo Neybird",
                        "created_at": "2026-11-02T12:15:13.414Z",
                        "updated_at": "2026-11-02T12:15:13.708Z",
                        "email": "info@moneybird.nl",
                        "email_validated": true,
                        "language": "nl",
                        "time_zone": "Europe/Amsterdam",
                        "user_type": "owner",
                        "permissions": [
                          "sales_invoices",
                          "documents",
                          "estimates",
                          "bank",
                          "settings",
                          "ownership",
                          "time_entries"
                        ]
                      },
                      {
                        "id": 1,
                        "name": "Edwin Vlieg",
                        "created_at": "2026-11-02T12:18:29.178Z",
                        "updated_at": "2026-11-02T12:18:29.181Z",
                        "email": "example+1@dev.null.moneybird.net",
                        "email_validated": true,
                        "language": "nl",
                        "time_zone": "Europe/Amsterdam",
                        "user_type": "api_user",
                        "permissions": [
                          "time_entries"
                        ]
                      }
                    ]
                  },
                  "ReturnsAllActiveUsersOfAnAdministration": {
                    "summary": "Returns all active users of an administration",
                    "value": [
                      {
                        "id": "502689108270777446",
                        "name": "Mo Neybird",
                        "created_at": "2026-11-02T12:15:13.414Z",
                        "updated_at": "2026-11-02T12:15:13.708Z",
                        "email": "info@moneybird.nl",
                        "email_validated": true,
                        "language": "nl",
                        "time_zone": "Europe/Amsterdam",
                        "user_type": "owner",
                        "permissions": [
                          "sales_invoices",
                          "documents",
                          "estimates",
                          "bank",
                          "settings",
                          "ownership",
                          "time_entries"
                        ]
                      },
                      {
                        "id": "502689313574618477",
                        "name": "John Doe",
                        "created_at": "2026-11-02T12:18:29.209Z",
                        "updated_at": "2026-11-02T12:18:29.212Z",
                        "email": "john+6@example.com",
                        "email_validated": true,
                        "language": "nl",
                        "time_zone": "Europe/Amsterdam",
                        "user_type": "employee",
                        "permissions": [
                          "time_entries"
                        ]
                      }
                    ]
                  },
                  "ExcludesInactiveUsersAccountantsAndApiUsersWhenTheIncludeFlagsAreFalse": {
                    "summary": "Excludes inactive users, accountants and api users when the include flags are false",
                    "value": [
                      {
                        "id": "502689108270777446",
                        "name": "Mo Neybird",
                        "created_at": "2026-11-02T12:15:13.414Z",
                        "updated_at": "2026-11-02T12:15:13.708Z",
                        "email": "info@moneybird.nl",
                        "email_validated": true,
                        "language": "nl",
                        "time_zone": "Europe/Amsterdam",
                        "user_type": "owner",
                        "permissions": [
                          "sales_invoices",
                          "documents",
                          "estimates",
                          "bank",
                          "settings",
                          "ownership",
                          "time_entries"
                        ]
                      }
                    ]
                  },
                  "DoesNotIncludeApiUsersWhenIncludeApiUsersIsFalse": {
                    "summary": "Does not include api users when include api users is false",
                    "value": [
                      {
                        "id": "502689108270777446",
                        "name": "Mo Neybird",
                        "created_at": "2026-11-02T12:15:13.414Z",
                        "updated_at": "2026-11-02T12:15:13.708Z",
                        "email": "info@moneybird.nl",
                        "email_validated": true,
                        "language": "nl",
                        "time_zone": "Europe/Amsterdam",
                        "user_type": "owner",
                        "permissions": [
                          "sales_invoices",
                          "documents",
                          "estimates",
                          "bank",
                          "settings",
                          "ownership",
                          "time_entries"
                        ]
                      }
                    ]
                  }
                }
              }
            }
          },
          "429": {
            "description": "Too many requests - rate limit exceeded",
            "content": {
              "application/json": {
                "schema": {
                  "type": "string",
                  "example": "Retry later"
                },
                "examples": {
                  "Returns429WhenExceedingTheRateLimit": {
                    "summary": "Returns 429 when exceeding the rate limit",
                    "value": "Retry later"
                  }
                }
              }
            },
            "headers": {
              "RateLimit-Limit": {
                "description": "The rate limit ceiling for that given request",
                "schema": {
                  "type": "integer",
                  "example": 150
                }
              },
              "RateLimit-Remaining": {
                "description": "The number of requests left for the time window",
                "schema": {
                  "type": "integer",
                  "example": 149
                }
              },
              "RateLimit-Reset": {
                "description": "The time at which the current rate limit window resets in UTC epoch seconds",
                "schema": {
                  "type": "integer",
                  "example": 1609459200
                }
              },
              "Retry-After": {
                "description": "The time at which the current rate limit window resets in UTC epoch seconds",
                "schema": {
                  "type": "integer",
                  "example": 1609459200
                }
              }
            }
          }
        },
        "operationId": "get_administration_id_users"
      }
    },
    "/{administration_id}/verifications{format}": {
      "get": {
        "summary": "Retrieve verifications",
        "description": "Retrieve all the verifications within an administration. Returns all\nverified e-mail addresses and bank account numbers, as well as the\nverified chamber of commerce number and tax number.\n\n### Required scope(s)\n `settings`",
        "tags": [
          "Verifications"
        ],
        "security": [
          {
            "bearerAuth": [
              "settings"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/administration_id"
          },
          {
            "$ref": "#/components/parameters/format"
          }
        ],
        "responses": {
          "200": {
            "description": "A list of verifications",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/verification_response"
                },
                "examples": {
                  "IfBankAccountNumberVerificationsAreStillPending": {
                    "summary": "If bank account number verifications are still pending",
                    "value": {
                      "emails": [
                        "validated1@dev.null.moneybird.net",
                        "validated2@dev.null.moneybird.net"
                      ],
                      "chamber_of_commerce_number": "12345678",
                      "tax_number": "NL852924574B01"
                    }
                  },
                  "IfTaxNumberVerificationIsStillPending": {
                    "summary": "If tax number verification is still pending",
                    "value": {
                      "emails": [
                        "validated1@dev.null.moneybird.net",
                        "validated2@dev.null.moneybird.net"
                      ],
                      "bank_account_numbers": [
                        "NL42TEST0000000002"
                      ],
                      "chamber_of_commerce_number": "12345678"
                    }
                  },
                  "ReturnsAllVerificationsOfAnAdministration": {
                    "summary": "Returns all verifications of an administration",
                    "value": {
                      "emails": [
                        "validated1@dev.null.moneybird.net",
                        "validated2@dev.null.moneybird.net"
                      ],
                      "bank_account_numbers": [
                        "NL42TEST0000000002"
                      ],
                      "chamber_of_commerce_number": "12345678",
                      "tax_number": "NL852924574B01"
                    }
                  },
                  "IfEmailVerificationsAreStillPending": {
                    "summary": "If email verifications are still pending",
                    "value": {
                      "bank_account_numbers": [
                        "NL42TEST0000000002"
                      ],
                      "chamber_of_commerce_number": "12345678",
                      "tax_number": "NL852924574B01"
                    }
                  },
                  "IfNoVerificationsArePresent": {
                    "summary": "If no verifications are present",
                    "value": {}
                  },
                  "IfChamberOfCommerceNumberVerificationIsStillPending": {
                    "summary": "If chamber of commerce number verification is still pending",
                    "value": {
                      "emails": [
                        "validated1@dev.null.moneybird.net",
                        "validated2@dev.null.moneybird.net"
                      ],
                      "bank_account_numbers": [
                        "NL42TEST0000000002"
                      ]
                    }
                  }
                }
              }
            }
          }
        },
        "operationId": "get_administration_id_verifications"
      }
    },
    "/{administration_id}/webhooks/{id}/activate{format}": {
      "patch": {
        "summary": "Activate a webhook",
        "description": "Activates a previously deactivated webhook. After activation, the webhook will resume receiving event notifications.\n\n### Required scope(s)\n `settings`",
        "tags": [
          "Webhooks"
        ],
        "security": [
          {
            "bearerAuth": [
              "settings"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/administration_id"
          },
          {
            "name": "id",
            "in": "path",
            "required": true,
            "schema": {
              "$ref": "#/components/schemas/identifier"
            }
          },
          {
            "$ref": "#/components/parameters/format"
          }
        ],
        "responses": {
          "200": {
            "description": "Webhook activated",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/webhook_response"
                },
                "examples": {
                  "ActivatesAWebhook": {
                    "summary": "Activates a webhook",
                    "value": {
                      "id": "502689286107169907",
                      "administration_id": 123,
                      "url": "http://example.com/create_webhook",
                      "enabled_events": [],
                      "last_http_status": null,
                      "last_http_body": null,
                      "token": "Z3LWpBDhXYsSgLCtL1JytbLJ",
                      "deactivated_at": null
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Not found",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/symbolic_error"
                },
                "examples": {
                  "ReturnsA404WhenTheWebhookCannotBeFound": {
                    "summary": "Returns a 404 when the webhook cannot be found",
                    "value": {
                      "error": "Record not found for model name: Webhook"
                    }
                  }
                }
              }
            }
          }
        },
        "operationId": "patch_administration_id_webhooks_id_activate"
      }
    },
    "/{administration_id}/webhooks/{id}/deactivate{format}": {
      "patch": {
        "summary": "Deactivate a webhook",
        "description": "Deactivates a webhook. A deactivated webhook will not receive new event notifications, but existing retries will still be processed. The webhook can be reactivated at any time.\n\n### Required scope(s)\n `settings`",
        "tags": [
          "Webhooks"
        ],
        "security": [
          {
            "bearerAuth": [
              "settings"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/administration_id"
          },
          {
            "name": "id",
            "in": "path",
            "required": true,
            "schema": {
              "$ref": "#/components/schemas/identifier"
            }
          },
          {
            "$ref": "#/components/parameters/format"
          }
        ],
        "responses": {
          "200": {
            "description": "Webhook deactivated",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/webhook_response"
                },
                "examples": {
                  "DeactivatesAWebhook": {
                    "summary": "Deactivates a webhook",
                    "value": {
                      "id": "502689286287525007",
                      "administration_id": 123,
                      "url": "http://example.com/create_webhook",
                      "enabled_events": [],
                      "last_http_status": null,
                      "last_http_body": null,
                      "token": "X8LeNxrgmQKrmxWmmFvbqVN6",
                      "deactivated_at": "2026-11-02T12:18:03.195Z"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Not found",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/symbolic_error"
                },
                "examples": {
                  "ReturnsA404WhenTheWebhookCannotBeFound": {
                    "summary": "Returns a 404 when the webhook cannot be found",
                    "value": {
                      "error": "Record not found for model name: Webhook"
                    }
                  }
                }
              }
            }
          }
        },
        "operationId": "patch_administration_id_webhooks_id_deactivate"
      }
    },
    "/{administration_id}/webhooks/{id}{format}": {
      "delete": {
        "summary": "Delete a webhook",
        "description": "Remove a registered webhook.\n\n### Required scope(s)\n `settings`",
        "tags": [
          "Webhooks"
        ],
        "security": [
          {
            "bearerAuth": [
              "settings"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/administration_id"
          },
          {
            "name": "id",
            "in": "path",
            "required": true,
            "schema": {
              "$ref": "#/components/schemas/identifier"
            }
          },
          {
            "$ref": "#/components/parameters/format"
          }
        ],
        "responses": {
          "204": {
            "description": "Webhook deleted"
          },
          "404": {
            "$ref": "#/components/responses/404_not_found"
          }
        },
        "operationId": "delete_administration_id_webhooks_id"
      }
    },
    "/{administration_id}/webhooks{format}": {
      "get": {
        "summary": "List all webhooks",
        "description": "List all registered webhooks for the administration.\n\n### Required scope(s)\n `settings`",
        "tags": [
          "Webhooks"
        ],
        "security": [
          {
            "bearerAuth": [
              "settings"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/administration_id"
          },
          {
            "$ref": "#/components/parameters/format"
          }
        ],
        "responses": {
          "200": {
            "description": "A list of webhooks",
            "content": {
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "$ref": "#/components/schemas/webhook_response"
                  }
                },
                "examples": {
                  "ReturnsAllWebhooksOfAnAdministration": {
                    "summary": "Returns all webhooks of an administration",
                    "value": [
                      {
                        "id": "502689286335759510",
                        "administration_id": 123,
                        "url": "http://example.com/create_webhook",
                        "enabled_events": [],
                        "last_http_status": null,
                        "last_http_body": null,
                        "token": "Ayo89tgerVZyCiKynvoLVQvk",
                        "deactivated_at": null
                      }
                    ]
                  }
                }
              }
            }
          }
        },
        "operationId": "get_administration_id_webhooks"
      },
      "post": {
        "summary": "Create a webhook",
        "description": "Creates a new webhook. The provided URL should respond with a 200 HTTP status. After\ncreation, the URL will receive notifications when events on documents in the\nadministration occur. It is also possible to subscribe to certain events by adding an array\nwith events you would like to receive notifications from. For a full list of available events\nand event groups, see the [webhook events documentation](https://developer.moneybird.com/webhooks/events).\n\n<p class=\"notice\">\n  <i class=\"fa fa-exclamation-triangle\"></i>\n  We strongly recommend that you use a secure HTTPS endpoint for receiving payload from Moneybird.<br/>\n  If you use unencrypted HTTP, anyone on the network may be able to listen in on sensitive information like contacts and invoices.\n</p>\n\n### Required scope(s)\n `settings`",
        "tags": [
          "Webhooks"
        ],
        "security": [
          {
            "bearerAuth": [
              "settings"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/administration_id"
          },
          {
            "$ref": "#/components/parameters/format"
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/*": {
              "schema": {
                "unevaluatedProperties": false,
                "type": "object",
                "properties": {
                  "url": {
                    "type": "string",
                    "description": "The HTTPS endpoint URL that will receive webhook notifications. Must respond with HTTP 200 on creation."
                  },
                  "enabled_events": {
                    "type": "array",
                    "description": "List of events to subscribe to. See [webhook events](https://developer.moneybird.com/webhooks/events) for all available events and event groups.",
                    "items": {
                      "type": [
                        "string"
                      ]
                    }
                  }
                },
                "required": [
                  "url"
                ]
              },
              "examples": {
                "CreatesAWebhook": {
                  "summary": "Creates a webhook",
                  "value": {
                    "url": "http://www.mocky.io/v2/5185415ba171ea3a00704eed"
                  }
                },
                "CreatesAWebhookThatIsSubscribedToEnabledEvents": {
                  "summary": "Creates a webhook that is subscribed to enabled events",
                  "value": {
                    "url": "http://www.mocky.io/v2/5185415ba171ea3a00704eed",
                    "enabled_events": [
                      "contact_created"
                    ]
                  }
                }
              }
            }
          }
        },
        "responses": {
          "201": {
            "description": "Webhook created",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/webhook_response"
                },
                "examples": {
                  "CreatesAWebhook": {
                    "summary": "Creates a webhook",
                    "value": {
                      "id": "502689286204687491",
                      "administration_id": 123,
                      "url": "http://www.mocky.io/v2/5185415ba171ea3a00704eed",
                      "enabled_events": [],
                      "last_http_status": null,
                      "last_http_body": null,
                      "token": "1aqC8cjMQ4VjLLkw7dTiGn4V",
                      "secret": "b6acd7c7683ff4314acd6fec43b046a467fd7722b6773cf58954d20f8dce1341",
                      "deactivated_at": null
                    }
                  },
                  "CreatesAWebhookThatIsSubscribedToEnabledEvents": {
                    "summary": "Creates a webhook that is subscribed to enabled events",
                    "value": {
                      "id": "502689286242436233",
                      "administration_id": 123,
                      "url": "http://www.mocky.io/v2/5185415ba171ea3a00704eed",
                      "enabled_events": [
                        "contact_created"
                      ],
                      "last_http_status": null,
                      "last_http_body": null,
                      "token": "s1CF64vwp2jmRPsbnhi5mfWU",
                      "secret": "086832f7c566d1dc514fe848c1f1650200d925329920e56292cd33e7161d2c6c",
                      "deactivated_at": null
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "Bad request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/symbolic_error"
                },
                "examples": {
                  "ReturnsAnErrorWhenFieldsAreNotProvided": {
                    "summary": "Returns an error when fields are not provided",
                    "value": {
                      "error": "Url is required",
                      "symbolic": {
                        "url": "required"
                      }
                    }
                  },
                  "ReturnsAnErrorWhenEventsIsProvided": {
                    "summary": "Returns an error when events is provided",
                    "value": {
                      "error": "'events' has been removed from webhooks, use 'enabled_events'",
                      "symbolic": {
                        "events": "removed"
                      }
                    }
                  }
                }
              }
            }
          }
        },
        "operationId": "post_administration_id_webhooks"
      }
    },
    "/{administration_id}/workflows/{id}{format}": {
      "get": {
        "summary": "Get a workflow by id",
        "description": "Returns all information about a workflow.\n\n### Required scope(s)\n Any of: `settings`, `sales_invoices`, `documents`, `estimates` or `bank`",
        "tags": [
          "Workflows"
        ],
        "security": [
          {
            "bearerAuth": [
              "settings"
            ]
          },
          {
            "bearerAuth": [
              "sales_invoices"
            ]
          },
          {
            "bearerAuth": [
              "documents"
            ]
          },
          {
            "bearerAuth": [
              "estimates"
            ]
          },
          {
            "bearerAuth": [
              "bank"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/administration_id"
          },
          {
            "name": "id",
            "in": "path",
            "required": true,
            "schema": {
              "$ref": "#/components/schemas/identifier"
            }
          },
          {
            "$ref": "#/components/parameters/format"
          }
        ],
        "responses": {
          "200": {
            "description": "A workflow",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/workflow_response"
                },
                "examples": {
                  "ReturnsAWorkflowWithSteps": {
                    "summary": "Returns a workflow with steps",
                    "value": {
                      "id": "502689109097055375",
                      "administration_id": 123,
                      "type": "InvoiceWorkflow",
                      "name": "Standaard",
                      "default": true,
                      "currency": "EUR",
                      "language": "nl",
                      "active": true,
                      "prices_are_incl_tax": false,
                      "payment_methods": [],
                      "collection_method": null,
                      "number_of_collections": 0,
                      "show_qr_code": true,
                      "created_at": "2026-11-02T12:15:14.201Z",
                      "updated_at": "2026-11-02T12:15:14.201Z",
                      "steps": [
                        {
                          "id": "502689109102298256",
                          "administration_id": 123,
                          "step_order": 0,
                          "due_interval": 14,
                          "reminder_delay": 0,
                          "reminder_text": null,
                          "reminder_auto_send": false,
                          "action": null,
                          "created_at": "2026-11-02T12:15:14.208Z",
                          "updated_at": "2026-11-02T12:15:14.208Z"
                        },
                        {
                          "id": "502689109104395409",
                          "administration_id": 123,
                          "step_order": 1,
                          "due_interval": 10,
                          "reminder_delay": 0,
                          "reminder_text": "Geachte {recipient.name},\n\nUit onze administratie blijkt dat u de onderstaande facturen nog niet voldaan heeft. We willen u erop wijzen dat de betaaltermijn van deze facturen verstreken is en verzoeken u vriendelijk doch dringend om de betaling zo spoedig mogelijk te voldoen.\n\n{reminders_table}\n\nMochten de betalingen en deze herinnering elkaar kruisen, dan kunt u deze herinnering als niet verzonden beschouwen.\nVia deze link kunt u naar het overzicht van uw {recipient.show_open_invoices_online_url}.\n\nMet vriendelijke groet,\n\n{company.company_name}",
                          "reminder_auto_send": false,
                          "action": null,
                          "created_at": "2026-11-02T12:15:14.210Z",
                          "updated_at": "2026-11-02T12:15:14.210Z"
                        },
                        {
                          "id": "502689109108589714",
                          "administration_id": 123,
                          "step_order": 2,
                          "due_interval": 5,
                          "reminder_delay": 0,
                          "reminder_text": "Geachte {recipient.name},\n\nOndanks een eerdere herinnering blijkt uit onze administratie dat u de onderstaande facturen nog niet voldaan heeft. We willen u er op wijzen dat de betaaltermijn van deze facturen verstreken is en verzoeken u vriendelijk doch dringend om de betaling zo spoedig mogelijk te voldoen.\n\n{reminders_table}\n\nMochten de betalingen en deze herinnering elkaar kruisen, dan kunt u deze herinnering als niet verzonden beschouwen. Wanneer betaling uitblijft, zullen wij de vordering uit handen moeten geven aan een incassobureau en de wettelijke incassokosten in rekening brengen.\nVia deze link kunt u naar het overzicht van uw {recipient.show_open_invoices_online_url}.\n\nMet vriendelijke groet,\n\n{company.company_name}",
                          "reminder_auto_send": false,
                          "action": null,
                          "created_at": "2026-11-02T12:15:14.211Z",
                          "updated_at": "2026-11-02T12:15:14.211Z"
                        },
                        {
                          "id": "502689109110686867",
                          "administration_id": 123,
                          "step_order": 3,
                          "due_interval": 5,
                          "reminder_delay": 0,
                          "reminder_text": "Geachte {recipient.name},\n\nOndanks eerdere herinneringen blijkt uit onze administratie dat u de onderstaande facturen nog niet voldaan heeft. Dit is de derde herinnering voor het voldoen van de vordering, voordat de vordering uit handen gegeven zal worden aan een incassobureau.\n\n{reminders_table}\n\nWij verzoeken u om de betalingen binnen 5 dagen te voldoen. Wanneer betaling uitblijft, zullen wij de vordering uit handen geven aan een incassobureau en brengen we de wettelijke incassokosten in rekening.\nVia deze link kunt u naar het overzicht van uw {recipient.show_open_invoices_online_url}.\n\nMet vriendelijke groet,\n\n{company.company_name}",
                          "reminder_auto_send": false,
                          "action": null,
                          "created_at": "2026-11-02T12:15:14.217Z",
                          "updated_at": "2026-11-02T12:15:14.217Z"
                        }
                      ]
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Not found",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/symbolic_error"
                },
                "examples": {
                  "Returns404WhenWorkflowDoesNotExist": {
                    "summary": "Returns 404 when workflow does not exist",
                    "value": {
                      "error": "Record not found for model name: Workflow"
                    }
                  }
                }
              }
            }
          }
        },
        "operationId": "get_administration_id_workflows_id"
      }
    },
    "/{administration_id}/workflows{format}": {
      "get": {
        "summary": "Retrieve available workflows",
        "description": "Returns a list of all the workflows of an administration.\n\n### Required scope(s)\n Any of: `settings`, `sales_invoices`, `documents`, `estimates` or `bank`",
        "tags": [
          "Workflows"
        ],
        "security": [
          {
            "bearerAuth": [
              "settings"
            ]
          },
          {
            "bearerAuth": [
              "sales_invoices"
            ]
          },
          {
            "bearerAuth": [
              "documents"
            ]
          },
          {
            "bearerAuth": [
              "estimates"
            ]
          },
          {
            "bearerAuth": [
              "bank"
            ]
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/administration_id"
          },
          {
            "$ref": "#/components/parameters/format"
          }
        ],
        "responses": {
          "200": {
            "description": "A list of workflows",
            "content": {
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "$ref": "#/components/schemas/workflow_response"
                  }
                },
                "examples": {
                  "ReturnsAllWorkflowsOfAnAdministration": {
                    "summary": "Returns all workflows of an administration",
                    "value": [
                      {
                        "id": "502689109222884501",
                        "administration_id": 123,
                        "type": "EstimateWorkflow",
                        "name": "Standaard",
                        "default": true,
                        "currency": "EUR",
                        "language": "nl",
                        "active": true,
                        "prices_are_incl_tax": false,
                        "payment_methods": [],
                        "collection_method": null,
                        "number_of_collections": 0,
                        "show_qr_code": true,
                        "created_at": "2026-11-02T12:15:14.322Z",
                        "updated_at": "2026-11-02T12:15:14.322Z",
                        "steps": [
                          {
                            "id": "502689109224981654",
                            "administration_id": 123,
                            "step_order": 0,
                            "due_interval": 14,
                            "reminder_delay": 0,
                            "reminder_text": null,
                            "reminder_auto_send": false,
                            "action": null,
                            "created_at": "2026-11-02T12:15:14.325Z",
                            "updated_at": "2026-11-02T12:15:14.325Z"
                          }
                        ]
                      },
                      {
                        "id": "502689109097055375",
                        "administration_id": 123,
                        "type": "InvoiceWorkflow",
                        "name": "Standaard",
                        "default": true,
                        "currency": "EUR",
                        "language": "nl",
                        "active": true,
                        "prices_are_incl_tax": false,
                        "payment_methods": [],
                        "collection_method": null,
                        "number_of_collections": 0,
                        "show_qr_code": true,
                        "created_at": "2026-11-02T12:15:14.201Z",
                        "updated_at": "2026-11-02T12:15:14.201Z",
                        "steps": [
                          {
                            "id": "502689109102298256",
                            "administration_id": 123,
                            "step_order": 0,
                            "due_interval": 14,
                            "reminder_delay": 0,
                            "reminder_text": null,
                            "reminder_auto_send": false,
                            "action": null,
                            "created_at": "2026-11-02T12:15:14.208Z",
                            "updated_at": "2026-11-02T12:15:14.208Z"
                          },
                          {
                            "id": "502689109104395409",
                            "administration_id": 123,
                            "step_order": 1,
                            "due_interval": 10,
                            "reminder_delay": 0,
                            "reminder_text": "Geachte {recipient.name},\n\nUit onze administratie blijkt dat u de onderstaande facturen nog niet voldaan heeft. We willen u erop wijzen dat de betaaltermijn van deze facturen verstreken is en verzoeken u vriendelijk doch dringend om de betaling zo spoedig mogelijk te voldoen.\n\n{reminders_table}\n\nMochten de betalingen en deze herinnering elkaar kruisen, dan kunt u deze herinnering als niet verzonden beschouwen.\nVia deze link kunt u naar het overzicht van uw {recipient.show_open_invoices_online_url}.\n\nMet vriendelijke groet,\n\n{company.company_name}",
                            "reminder_auto_send": false,
                            "action": null,
                            "created_at": "2026-11-02T12:15:14.210Z",
                            "updated_at": "2026-11-02T12:15:14.210Z"
                          },
                          {
                            "id": "502689109108589714",
                            "administration_id": 123,
                            "step_order": 2,
                            "due_interval": 5,
                            "reminder_delay": 0,
                            "reminder_text": "Geachte {recipient.name},\n\nOndanks een eerdere herinnering blijkt uit onze administratie dat u de onderstaande facturen nog niet voldaan heeft. We willen u er op wijzen dat de betaaltermijn van deze facturen verstreken is en verzoeken u vriendelijk doch dringend om de betaling zo spoedig mogelijk te voldoen.\n\n{reminders_table}\n\nMochten de betalingen en deze herinnering elkaar kruisen, dan kunt u deze herinnering als niet verzonden beschouwen. Wanneer betaling uitblijft, zullen wij de vordering uit handen moeten geven aan een incassobureau en de wettelijke incassokosten in rekening brengen.\nVia deze link kunt u naar het overzicht van uw {recipient.show_open_invoices_online_url}.\n\nMet vriendelijke groet,\n\n{company.company_name}",
                            "reminder_auto_send": false,
                            "action": null,
                            "created_at": "2026-11-02T12:15:14.211Z",
                            "updated_at": "2026-11-02T12:15:14.211Z"
                          },
                          {
                            "id": "502689109110686867",
                            "administration_id": 123,
                            "step_order": 3,
                            "due_interval": 5,
                            "reminder_delay": 0,
                            "reminder_text": "Geachte {recipient.name},\n\nOndanks eerdere herinneringen blijkt uit onze administratie dat u de onderstaande facturen nog niet voldaan heeft. Dit is de derde herinnering voor het voldoen van de vordering, voordat de vordering uit handen gegeven zal worden aan een incassobureau.\n\n{reminders_table}\n\nWij verzoeken u om de betalingen binnen 5 dagen te voldoen. Wanneer betaling uitblijft, zullen wij de vordering uit handen geven aan een incassobureau en brengen we de wettelijke incassokosten in rekening.\nVia deze link kunt u naar het overzicht van uw {recipient.show_open_invoices_online_url}.\n\nMet vriendelijke groet,\n\n{company.company_name}",
                            "reminder_auto_send": false,
                            "action": null,
                            "created_at": "2026-11-02T12:15:14.217Z",
                            "updated_at": "2026-11-02T12:15:14.217Z"
                          }
                        ]
                      }
                    ]
                  }
                }
              }
            }
          }
        },
        "operationId": "get_administration_id_workflows"
      }
    }
  },
  "components": {
    "headers": {
      "link": {
        "description": "Pagination links (next, prev)",
        "schema": {
          "type": "string"
        }
      },
      "x-total-count": {
        "description": "Total number of entries in the collection",
        "schema": {
          "type": "integer"
        }
      }
    },
    "parameters": {
      "administration_id": {
        "in": "path",
        "name": "administration_id",
        "required": true,
        "schema": {
          "$ref": "#/components/schemas/administration_id"
        },
        "description": "The unique identifier of the administration"
      },
      "format": {
        "in": "path",
        "name": "format",
        "required": true,
        "schema": {
          "type": "string",
          "pattern": "^(.(json|xml))?$",
          "default": ".json"
        },
        "description": "The format in which the response is given, can be empty to use the default format"
      },
      "granularity": {
        "name": "granularity",
        "in": "query",
        "required": false,
        "description": "Splits the report into periods of a month, a quarter or a year. The response then also contains `periods`, with the same fields for each period. The first and the last period are cut off at the start and the end of `period`.\n",
        "schema": {
          "type": "string",
          "enum": [
            "month",
            "quarter",
            "year"
          ]
        }
      },
      "page": {
        "name": "page",
        "in": "query",
        "required": false,
        "schema": {
          "type": [
            "integer",
            "string"
          ]
        }
      },
      "per_page": {
        "name": "per_page",
        "in": "query",
        "required": false,
        "schema": {
          "type": [
            "integer",
            "string"
          ],
          "pattern": "^\\d+$",
          "minimum": 1,
          "maximum": 100
        }
      },
      "period": {
        "name": "period",
        "in": "query",
        "required": false,
        "description": "The period can be a date range or one of the presets. Date ranges must consist of whole months (start on 1st, end on last day of month).\n\n**Date range formats:**\n  - `YYYYMMDD..YYYYMMDD` (e.g., `20250101..20250131`)\n  - `YYYYMM..YYYYMM` (e.g., `202501..202501`)\n  - `YYYYMM` (e.g., `202501`)\n\n**Preset options:**\n  - `this_month` - Current month (default if not specified)\n  - `prev_month` - Previous month\n  - `next_month` - Next month\n  - `this_quarter` - Current quarter\n  - `prev_quarter` - Previous quarter\n  - `next_quarter` - Next quarter\n  - `this_year` - Current year\n  - `prev_year` - Previous year\n  - `next_year` - Next year\n\n**Maximum period: 12 months.**\n",
        "schema": {
          "type": "string",
          "pattern": "^\\d{6,8}(..\\d{6,8})?|this_month|prev_month|next_month|this_quarter|prev_quarter|next_quarter|this_year|prev_year|next_year$",
          "example": "20250101..20250131",
          "default": "this_month"
        }
      },
      "period_until": {
        "name": "period_until",
        "in": "query",
        "required": false,
        "description": "A period until which a report should be generated.\n\n**Date range formats:**\n  - `YYYYMM` (e.g., `202501`)\n\n**Preset options:**\n  - `this_month` - Current month (default if not specified)\n  - `prev_month` - Previous month\n  - `this_quarter` - Current quarter\n  - `prev_quarter` - Previous quarter\n  - `this_year` - Current year\n  - `prev_year` - Previous year\n",
        "schema": {
          "type": "string",
          "pattern": "^\\d{6,8}|this_month|prev_month|this_quarter|prev_quarter|this_year|prev_year$",
          "example": "202501",
          "default": "this_month"
        }
      },
      "sort": {
        "name": "sort",
        "in": "query",
        "required": false,
        "description": "Sorts the list on date, so the newest (`date_desc`) or the oldest (`date_asc`) items come first.\n",
        "schema": {
          "type": "string",
          "default": "date_desc",
          "enum": [
            "date_desc",
            "date_asc"
          ]
        }
      }
    },
    "requestBodies": {
      "payment_request": {
        "required": true,
        "content": {
          "application/*": {
            "schema": {
              "unevaluatedProperties": false,
              "type": "object",
              "properties": {
                "payment": {
                  "type": "object",
                  "unevaluatedProperties": false,
                  "properties": {
                    "payment_date": {
                      "type": "string",
                      "description": "The date on which the payment was made."
                    },
                    "price": {
                      "$ref": "#/components/schemas/money",
                      "description": "The amount paid in the document's currency."
                    },
                    "price_base": {
                      "$ref": "#/components/schemas/money",
                      "description": "Amount paid expressed in the base currency of the administration. Required when the document uses a different currency than the administration's base currency."
                    },
                    "financial_account_id": {
                      "$ref": "#/components/schemas/identifier",
                      "description": "The ID of the financial account (bank account or cash register) associated with this payment. Required for `private_payment` and `cash_payment` actions. Should be a valid financial account id."
                    },
                    "financial_mutation_id": {
                      "$ref": "#/components/schemas/identifier",
                      "description": "The ID of the bank transaction to link this payment to. Required for `bank_transfer` actions. Should be a valid financial mutation id."
                    },
                    "transaction_identifier": {
                      "type": "string",
                      "description": "An external transaction reference, e.g. a bank transaction ID or PSP reference. Used to match the payment with financial mutations."
                    },
                    "manual_payment_action": {
                      "type": "string",
                      "description": "Can be `private_payment` (needs financial_account_id), `payment_without_proof`, `cash_payment` (needs financial_account_id), `rounding_error`, `bank_transfer` (needs financial_mutation_id), `balance_settlement` (needs ledger_account_id) or `invoices_settlement` (needs invoice_id). `payment_without_proof` is only accepted when the administration allows payments without proof."
                    },
                    "ledger_account_id": {
                      "$ref": "#/components/schemas/identifier",
                      "description": "The ID of the ledger account to book this payment to. Required for `balance_settlement` actions. Should be a valid ledger account id."
                    },
                    "invoice_id": {
                      "$ref": "#/components/schemas/identifier",
                      "description": "The ID of the document to settle this payment against. Required for `invoices_settlement` actions. Should be a valid document id (sales invoice, purchase invoice, receipt, etc.)."
                    }
                  },
                  "required": [
                    "payment_date",
                    "price"
                  ]
                }
              },
              "required": []
            }
          }
        }
      },
      "subscription_additional_charge_request": {
        "required": true,
        "content": {
          "application/*": {
            "schema": {
              "type": "object",
              "unevaluatedProperties": false,
              "properties": {
                "product_id": {
                  "$ref": "#/components/schemas/identifier"
                },
                "amount": {
                  "type": [
                    "string",
                    "integer"
                  ],
                  "description": "The quantity on the invoice line, e.g. `1` or `5 x`."
                },
                "price": {
                  "$ref": "#/components/schemas/money",
                  "description": "The price per unit. Defaults to the price of the product for this contact at the start of the period."
                },
                "period": {
                  "type": "string",
                  "description": "The period the charge applies to, e.g. `20250101..20250131`, `202501..202503` or `this_month`."
                },
                "description": {
                  "type": "string"
                },
                "identifier": {
                  "type": "string",
                  "description": "Your own reference for this charge."
                }
              },
              "required": [
                "product_id",
                "amount",
                "period",
                "description"
              ]
            }
          }
        }
      }
    },
    "responses": {
      "200_synchronization_response": {
        "description": "IDs and versions of records",
        "content": {
          "application/json": {
            "schema": {
              "type": "array",
              "items": {
                "type": "object",
                "unevaluatedProperties": false,
                "properties": {
                  "id": {
                    "type": [
                      "integer",
                      "string"
                    ]
                  },
                  "version": {
                    "type": [
                      "integer",
                      "string"
                    ]
                  }
                }
              }
            }
          }
        }
      },
      "204_no_content": {
        "description": "No content"
      },
      "302_found": {
        "description": "Found",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string"
            }
          }
        }
      },
      "400_bad_request": {
        "description": "Bad request",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/symbolic_error"
            }
          }
        }
      },
      "401_unauthorized": {
        "description": "Unauthorized",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/symbolic_error"
            }
          }
        }
      },
      "402_payment_required": {
        "description": "Payment required",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/symbolic_error"
            }
          }
        }
      },
      "403_forbidden": {
        "description": "Forbidden",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/symbolic_error"
            }
          }
        }
      },
      "404_not_found": {
        "description": "Not found",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/symbolic_error"
            }
          }
        }
      },
      "422_unprocessable_entity": {
        "description": "Unprocessable entity",
        "content": {
          "application/json": {
            "schema": {
              "anyOf": [
                {
                  "$ref": "#/components/schemas/symbolic_error"
                },
                {
                  "$ref": "#/components/schemas/non_symbolic_error"
                }
              ]
            }
          }
        }
      },
      "429_too_many_requests": {
        "description": "Too many requests - rate limit exceeded",
        "content": {
          "application/json": {
            "schema": {
              "type": "string",
              "example": "Retry later"
            }
          }
        },
        "headers": {
          "RateLimit-Limit": {
            "description": "The rate limit ceiling for that given request",
            "schema": {
              "type": "integer",
              "example": 150
            }
          },
          "RateLimit-Remaining": {
            "description": "The number of requests left for the time window",
            "schema": {
              "type": "integer",
              "example": 149
            }
          },
          "RateLimit-Reset": {
            "description": "The time at which the current rate limit window resets in UTC epoch seconds",
            "schema": {
              "type": "integer",
              "example": 1609459200
            }
          },
          "Retry-After": {
            "description": "The time at which the current rate limit window resets in UTC epoch seconds",
            "schema": {
              "type": "integer",
              "example": 1609459200
            }
          }
        }
      },
      "4XX_open_error": {
        "description": "Error code",
        "content": {
          "application/json": {
            "schema": {
              "type": "integer"
            }
          }
        }
      },
      "503_service_unavailable": {
        "description": "Service Unavailable",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/symbolic_error"
            }
          }
        }
      },
      "status_code": {
        "description": "Status code",
        "content": {
          "application/json": {
            "schema": {
              "type": "integer"
            }
          }
        }
      }
    },
    "schemas": {
      "administration_id": {
        "allOf": [
          {
            "$ref": "#/components/schemas/identifier",
            "description": "A unique record identifier of an administration",
            "example": "123"
          }
        ]
      },
      "administration_response": {
        "type": "object",
        "unevaluatedProperties": false,
        "properties": {
          "id": {
            "$ref": "#/components/schemas/administration_id"
          },
          "name": {
            "type": "string",
            "example": "Moneybird"
          },
          "language": {
            "type": "string",
            "enum": [
              "nl",
              "nl-be",
              "en"
            ],
            "example": "nl",
            "description": "The ISO 639-1 language code used in the administration"
          },
          "currency": {
            "type": "string",
            "description": "The ISO 4217 currency code",
            "example": "EUR"
          },
          "country": {
            "type": "string",
            "description": "The ISO 3166-1 alpha-2 code the administration country",
            "example": "NL"
          },
          "time_zone": {
            "type": "string",
            "description": "The time zone of the administration",
            "example": "Europe/Amsterdam"
          },
          "access": {
            "type": "string",
            "enum": [
              "accountant_company",
              "user"
            ],
            "description": "The type of acess the user has to this administration",
            "example": "user"
          },
          "suspended": {
            "type": "boolean"
          },
          "period_locked_until": {
            "type": [
              "string",
              "null"
            ],
            "format": "date"
          },
          "period_start_date": {
            "type": "string",
            "format": "date",
            "description": "Start of the year in which the administration recorded its first bookkeeping data, based on journal entries.",
            "example": "2024-01-01"
          }
        }
      },
      "aging_report_item": {
        "type": "object",
        "description": "Aging report data item",
        "properties": {
          "contact_id": {
            "$ref": "#/components/schemas/identifier_nullable"
          },
          "amount": {
            "type": "string"
          },
          "aging_buckets": {
            "type": "array",
            "minItems": 4,
            "maxItems": 4,
            "description": "In this order: 0 to 30 days, 30 to 60 days, older, and the total of the contact, which\nequals `amount`.",
            "items": {
              "type": "object",
              "properties": {
                "name": {
                  "type": "string",
                  "description": "In the language of the user."
                },
                "amount": {
                  "type": "string"
                }
              }
            }
          }
        }
      },
      "asset_response": {
        "type": "object",
        "unevaluatedProperties": false,
        "properties": {
          "id": {
            "$ref": "#/components/schemas/identifier_nullable"
          },
          "ledger_account_id": {
            "$ref": "#/components/schemas/identifier_nullable"
          },
          "name": {
            "type": "string"
          },
          "purchase_date": {
            "type": "string",
            "format": "date"
          },
          "purchase_value": {
            "$ref": "#/components/schemas/number"
          },
          "calculated_purchase_value": {
            "$ref": "#/components/schemas/number",
            "description": "Purchase value reduced by any reinvestment reserve purchase applied to the asset."
          },
          "current_value": {
            "$ref": "#/components/schemas/number"
          },
          "value_change_plan": {
            "type": [
              "object",
              "null"
            ],
            "unevaluatedProperties": false,
            "properties": {
              "lifespan_in_years": {
                "type": "number"
              },
              "residual_value": {
                "$ref": "#/components/schemas/number"
              },
              "active": {
                "type": "boolean"
              },
              "monthly_depreciation": {
                "$ref": "#/components/schemas/number"
              }
            }
          },
          "disposal": {
            "oneOf": [
              {
                "type": "null"
              },
              {
                "$ref": "#/components/schemas/disposal_response"
              }
            ]
          },
          "value_changes": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/value_change_response"
            }
          },
          "sources": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/source_response"
            }
          },
          "reinvestment_reserve_purchase": {
            "oneOf": [
              {
                "type": "null"
              },
              {
                "$ref": "#/components/schemas/reinvestment_reserve_purchase_response"
              }
            ]
          }
        }
      },
      "attachment_response": {
        "type": "object",
        "unevaluatedProperties": false,
        "properties": {
          "id": {
            "$ref": "#/components/schemas/identifier"
          },
          "administration_id": {
            "$ref": "#/components/schemas/administration_id"
          },
          "attachable_id": {
            "$ref": "#/components/schemas/identifier"
          },
          "attachable_type": {
            "type": "string",
            "enum": [
              "SalesInvoice",
              "RecurringSalesInvoice",
              "Document",
              "FinancialStatement",
              "Workflow",
              "Estimate",
              "ExternalSalesInvoice"
            ]
          },
          "filename": {
            "type": "string"
          },
          "content_type": {
            "type": "string"
          },
          "size": {
            "type": "integer"
          },
          "rotation": {
            "type": [
              "integer",
              "null"
            ]
          },
          "created_at": {
            "type": [
              "string",
              "null"
            ],
            "format": "date-time"
          },
          "updated_at": {
            "type": [
              "string",
              "null"
            ],
            "format": "date-time"
          }
        }
      },
      "balance_sheet_credit": {
        "type": "object",
        "description": "Credit side of the balance sheet (equity and liabilities)",
        "properties": {
          "total": {
            "type": "string",
            "description": "Total credit amount"
          },
          "equity": {
            "$ref": "#/components/schemas/balance_sheet_ledger_account"
          },
          "provisions": {
            "$ref": "#/components/schemas/balance_sheet_ledger_account"
          },
          "non_current_liabilities": {
            "$ref": "#/components/schemas/balance_sheet_ledger_account"
          },
          "current_liabilities": {
            "$ref": "#/components/schemas/balance_sheet_ledger_account"
          },
          "open_years": {
            "type": "array",
            "description": "Results per open year",
            "items": {
              "type": "object",
              "properties": {
                "year": {
                  "type": "string"
                },
                "value": {
                  "type": "string"
                }
              }
            }
          }
        }
      },
      "balance_sheet_debit": {
        "type": "object",
        "description": "Debit side of the balance sheet (assets)",
        "properties": {
          "total": {
            "type": "string"
          },
          "current_assets": {
            "$ref": "#/components/schemas/balance_sheet_ledger_account"
          },
          "non_current_assets": {
            "$ref": "#/components/schemas/balance_sheet_ledger_account"
          }
        }
      },
      "balance_sheet_ledger_account": {
        "type": "array",
        "description": "A list of ledger accounts with their value and child accounts",
        "items": {
          "type": "object",
          "properties": {
            "ledger_account_id": {
              "type": "string"
            },
            "value": {
              "type": "string"
            },
            "children": {
              "type": "array",
              "items": {
                "type": "object",
                "properties": {
                  "ledger_account_id": {
                    "type": "string"
                  },
                  "value": {
                    "type": "string"
                  }
                }
              }
            }
          }
        }
      },
      "bank_balance_amounts": {
        "type": "object",
        "properties": {
          "total": {
            "type": "string",
            "description": "The total of `financial_accounts`, the same as `closing_balance` of the cash flow report"
          },
          "financial_accounts": {
            "type": "array",
            "description": "The booked balance of every financial account except private withdrawal accounts. Like the balance sheet, an account with a zero balance in every period is left out.",
            "items": {
              "type": "object",
              "unevaluatedProperties": false,
              "required": [
                "financial_account_id",
                "name",
                "type",
                "balance"
              ],
              "properties": {
                "financial_account_id": {
                  "$ref": "#/components/schemas/identifier"
                },
                "name": {
                  "type": "string"
                },
                "type": {
                  "type": "string",
                  "description": "The kind of financial account, such as `BankAccount` or `CreditCardAccount`"
                },
                "balance": {
                  "type": "string"
                }
              }
            }
          }
        }
      },
      "base_contact_response": {
        "type": "object",
        "properties": {
          "id": {
            "$ref": "#/components/schemas/identifier"
          },
          "administration_id": {
            "$ref": "#/components/schemas/administration_id"
          },
          "company_name": {},
          "firstname": {
            "type": [
              "string",
              "null"
            ]
          },
          "lastname": {
            "type": [
              "string",
              "null"
            ]
          },
          "address1": {
            "type": [
              "string",
              "null"
            ]
          },
          "address2": {
            "type": [
              "string",
              "null"
            ]
          },
          "zipcode": {
            "type": [
              "string",
              "null"
            ]
          },
          "city": {
            "type": [
              "string",
              "null"
            ]
          },
          "country": {
            "type": "string"
          },
          "phone": {
            "type": [
              "string",
              "null"
            ]
          },
          "delivery_method": {
            "type": [
              "string",
              "null"
            ],
            "enum": [
              "Email",
              "Post",
              "Manual",
              "Simplerinvoicing",
              "Peppol",
              null
            ]
          },
          "customer_id": {
            "type": "string",
            "description": "Will be assigned automatically if empty"
          },
          "tax_number": {
            "type": [
              "string",
              "null"
            ]
          },
          "chamber_of_commerce": {
            "type": [
              "string",
              "null"
            ]
          },
          "bank_account": {
            "type": [
              "string",
              "null"
            ],
            "description": "The SEPA IBAN of the contact, can be empty if no SEPA IBAN is set"
          },
          "is_trusted": {
            "type": "boolean",
            "default": "default"
          },
          "max_transfer_amount": {
            "type": [
              "string",
              "null"
            ]
          },
          "attention": {
            "type": [
              "string",
              "null"
            ]
          },
          "email": {
            "type": [
              "string",
              "null"
            ]
          },
          "email_ubl": {
            "type": "boolean"
          },
          "send_invoices_to_attention": {
            "type": [
              "string",
              "null"
            ]
          },
          "send_invoices_to_email": {
            "type": [
              "string",
              "null"
            ]
          },
          "send_estimates_to_attention": {
            "type": [
              "string",
              "null"
            ]
          },
          "send_estimates_to_email": {
            "type": [
              "string",
              "null"
            ]
          },
          "direct_debit": {
            "type": "boolean"
          },
          "sepa_active": {
            "type": [
              "boolean",
              "null"
            ]
          },
          "sepa_iban": {
            "type": [
              "string",
              "null"
            ]
          },
          "sepa_iban_account_name": {
            "type": [
              "string",
              "null"
            ]
          },
          "sepa_bic": {
            "type": [
              "string",
              "null"
            ]
          },
          "sepa_mandate_id": {
            "type": [
              "string",
              "null"
            ]
          },
          "sepa_mandate_date": {
            "type": [
              "string",
              "null"
            ],
            "format": "date"
          },
          "sepa_sequence_type": {
            "type": "string",
            "enum": [
              "RCUR",
              "FRST",
              "OOFF",
              "FNAL"
            ]
          },
          "credit_card_number": {
            "type": [
              "string",
              "null"
            ]
          },
          "credit_card_reference": {
            "type": [
              "string",
              "null"
            ]
          },
          "credit_card_type": {
            "type": [
              "string",
              "null"
            ],
            "enum": [
              "mastercard",
              "visa",
              null
            ]
          },
          "tax_number_validated_at": {
            "type": [
              "string",
              "null"
            ],
            "format": "date-time"
          },
          "tax_number_valid": {
            "type": [
              "boolean",
              "null"
            ]
          },
          "invoice_workflow_id": {
            "$ref": "#/components/schemas/identifier_nullable"
          },
          "estimate_workflow_id": {
            "$ref": "#/components/schemas/identifier_nullable"
          },
          "si_identifier": {
            "type": [
              "string",
              "null"
            ]
          },
          "si_identifier_type": {
            "type": [
              "string",
              "null"
            ]
          },
          "moneybird_payments_mandate": {
            "type": "boolean",
            "description": "Whether the contact has a valid Moneybird Payments mandate"
          },
          "created_at": {
            "$ref": "#/components/schemas/timestamp"
          },
          "updated_at": {
            "$ref": "#/components/schemas/timestamp"
          },
          "version": {
            "type": "integer",
            "example": 1716801778
          },
          "sales_invoices_url": {
            "type": "string",
            "format": "uri",
            "pattern": "^https:\\/\\/moneybird\\.\\w{3,9}\\/\\d+\\/sales_invoices\\/[a-f0-9]{64}\\/all$",
            "example": "https://moneybird.com/123/sales_invoices/4f0af91e456aa9c5b11ccfd6572da4f56cc8e45a701690c9279c9e4cec7b68f1/all"
          },
          "notes": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/note_response"
            }
          },
          "custom_fields": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/custom_field_value_response"
            }
          },
          "contact_people": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/contact_person_response"
            }
          },
          "archived": {
            "type": "boolean"
          }
        }
      },
      "base_user_response": {
        "type": "object",
        "properties": {
          "id": {
            "$ref": "#/components/schemas/identifier"
          },
          "name": {
            "type": "string"
          },
          "created_at": {
            "$ref": "#/components/schemas/timestamp"
          },
          "updated_at": {
            "$ref": "#/components/schemas/timestamp"
          }
        }
      },
      "cash_flow_amounts": {
        "type": "object",
        "properties": {
          "cash_received_by_ledger_account": {
            "$ref": "#/components/schemas/ledger_account_data"
          },
          "cash_paid_by_ledger_account": {
            "$ref": "#/components/schemas/ledger_account_data"
          },
          "opening_balance": {
            "type": "string",
            "description": "The balance of the financial accounts at the start of the period"
          },
          "closing_balance": {
            "type": "string",
            "description": "The balance of the financial accounts at the end of the period"
          }
        }
      },
      "contact_person_response": {
        "type": "object",
        "unevaluatedProperties": false,
        "properties": {
          "id": {
            "$ref": "#/components/schemas/identifier_nullable"
          },
          "contact_id": {
            "$ref": "#/components/schemas/identifier_nullable"
          },
          "administration_id": {
            "$ref": "#/components/schemas/administration_id"
          },
          "firstname": {
            "type": [
              "string",
              "null"
            ]
          },
          "lastname": {
            "type": [
              "string",
              "null"
            ]
          },
          "phone": {
            "type": [
              "string",
              "null"
            ]
          },
          "email": {
            "type": [
              "string",
              "null"
            ]
          },
          "department": {
            "type": [
              "string",
              "null"
            ]
          },
          "created_at": {
            "type": [
              "string",
              "null"
            ],
            "format": "date-time"
          },
          "updated_at": {
            "type": [
              "string",
              "null"
            ],
            "format": "date-time"
          },
          "version": {
            "type": "integer"
          }
        }
      },
      "contact_report_item": {
        "type": "object",
        "description": "Contact report data item",
        "properties": {
          "contact_id": {
            "$ref": "#/components/schemas/identifier_nullable"
          },
          "amount": {
            "type": "string"
          }
        },
        "required": [
          "contact_id",
          "amount"
        ]
      },
      "contact_response": {
        "unevaluatedProperties": false,
        "allOf": [
          {
            "$ref": "#/components/schemas/base_contact_response"
          },
          {
            "type": "object",
            "properties": {
              "events": {
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/event_response"
                }
              }
            }
          }
        ]
      },
      "creditors_report_item": {
        "type": "object",
        "description": "Creditors report data item",
        "properties": {
          "contact_id": {
            "$ref": "#/components/schemas/identifier_nullable"
          },
          "amount": {
            "type": "string"
          }
        },
        "required": [
          "contact_id",
          "amount"
        ]
      },
      "currency": {
        "type": "string",
        "description": "ISO 4217 currency code",
        "example": "EUR"
      },
      "custom_field_response": {
        "type": "object",
        "unevaluatedProperties": false,
        "properties": {
          "id": {
            "$ref": "#/components/schemas/identifier_nullable"
          },
          "administration_id": {
            "oneOf": [
              {
                "$ref": "#/components/schemas/administration_id"
              },
              {
                "type": "null"
              }
            ]
          },
          "name": {
            "type": "string"
          },
          "source": {
            "type": [
              "string",
              "null"
            ],
            "enum": [
              "sales_invoice",
              "estimate",
              "contact",
              "identity",
              null
            ]
          }
        }
      },
      "custom_field_value_response": {
        "type": "object",
        "unevaluatedProperties": false,
        "properties": {
          "id": {
            "$ref": "#/components/schemas/identifier"
          },
          "name": {
            "type": "string"
          },
          "value": {
            "type": "string"
          }
        }
      },
      "custom_fields_attributes": {
        "oneOf": [
          {
            "type": "object",
            "additionalProperties": {
              "type": "object",
              "unevaluatedProperties": false,
              "properties": {
                "id": {
                  "$ref": "#/components/schemas/identifier",
                  "description": "The ID of the custom field to set a value for. Retrieve available custom fields via the custom fields endpoint."
                },
                "value": {
                  "type": "string",
                  "description": "The value to assign to the custom field. The expected format depends on the custom field's type (e.g. text or dropdown)."
                }
              },
              "required": [
                "id",
                "value"
              ]
            }
          },
          {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "id": {
                  "$ref": "#/components/schemas/identifier",
                  "description": "The ID of the custom field to set a value for. Retrieve available custom fields via the custom fields endpoint."
                },
                "value": {
                  "type": "string",
                  "description": "The value to assign to the custom field. The expected format depends on the custom field's type (e.g. text or dropdown)."
                }
              }
            }
          }
        ]
      },
      "debtors_report_item": {
        "type": "object",
        "description": "Debtors report data item",
        "properties": {
          "contact_id": {
            "$ref": "#/components/schemas/identifier_nullable"
          },
          "amount": {
            "type": "string"
          }
        },
        "required": [
          "contact_id",
          "amount"
        ]
      },
      "detail_response": {
        "type": "object",
        "unevaluatedProperties": false,
        "properties": {
          "id": {
            "$ref": "#/components/schemas/identifier"
          },
          "administration_id": {
            "$ref": "#/components/schemas/administration_id"
          },
          "tax_rate_id": {
            "$ref": "#/components/schemas/identifier"
          },
          "ledger_account_id": {
            "$ref": "#/components/schemas/identifier"
          },
          "project_id": {
            "$ref": "#/components/schemas/identifier_nullable"
          },
          "product_id": {
            "$ref": "#/components/schemas/identifier_nullable"
          },
          "amount": {
            "type": [
              "string",
              "null"
            ]
          },
          "amount_decimal": {
            "type": [
              "string",
              "null"
            ]
          },
          "description": {
            "type": "string"
          },
          "price": {
            "type": "string",
            "pattern": "^-?\\d+\\.\\d{1,2}$",
            "examples": [
              "123.45",
              "-500.0",
              "0.0"
            ]
          },
          "period": {
            "type": [
              "string",
              "null"
            ],
            "pattern": "^\\d{6,8}..\\d{6,8}$",
            "example": "20250501..20250531",
            "description": "The period this detail belongs to for bookkeeping, independent of the document date. Revenue or expenses are spread over this period in the reports, so a detail on an invoice dated in May can belong to January. Use this field, not the document date, to tell which months a detail covers. Null when the detail has no period of its own; the document date then decides where it lands."
          },
          "row_order": {
            "type": "integer"
          },
          "total_price_excl_tax_with_discount": {
            "$ref": "#/components/schemas/number"
          },
          "total_price_excl_tax_with_discount_base": {
            "$ref": "#/components/schemas/number"
          },
          "tax_report_reference": {
            "type": "array",
            "items": {
              "type": [
                "string",
                "null"
              ]
            }
          },
          "mandatory_tax_text": {
            "type": [
              "string",
              "null"
            ]
          },
          "created_at": {
            "type": [
              "string",
              "null"
            ],
            "format": "date-time"
          },
          "updated_at": {
            "type": [
              "string",
              "null"
            ],
            "format": "date-time"
          },
          "is_optional": {
            "type": "boolean"
          },
          "is_selected": {
            "type": "boolean"
          }
        }
      },
      "details_attributes": {
        "oneOf": [
          {
            "type": "object",
            "additionalProperties": {
              "type": "object",
              "unevaluatedProperties": false,
              "properties": {
                "id": {
                  "$ref": "#/components/schemas/identifier",
                  "description": "The ID of an existing detail to update. Required when updating or removing an existing detail; omit when creating a new one."
                },
                "description": {
                  "type": "string",
                  "description": "A free-text description for this detail, e.g. the name of the product or service delivered."
                },
                "period": {
                  "type": "string",
                  "description": "String with a date range: `20140101..20141231`, presets are also allowed: `this_month`, `prev_month`, `next_month`, `this_quarter`, `prev_quarter`, `next_quarter`, `this_year`, `prev_year`, `next_year`. Used to indicate the period the detail applies to, independent of the document date. Revenue or expenses are deferred over this period in the profit and loss report. Omit it to let the document date decide where the amounts land."
                },
                "price": {
                  "$ref": "#/components/schemas/money",
                  "description": "The unit price for this detail."
                },
                "amount": {
                  "type": [
                    "integer",
                    "string"
                  ],
                  "description": "The quantity for this detail, e.g. `1`, `5` or `0.5`. Defaults to 1 if not provided."
                },
                "tax_rate_id": {
                  "$ref": "#/components/schemas/identifier",
                  "description": "The ID of the tax rate to apply to this detail. Should be a valid tax rate id. If not provided, the administration's default tax rate is used."
                },
                "ledger_account_id": {
                  "$ref": "#/components/schemas/identifier",
                  "description": "The ID of the ledger account (category) to book this detail to. Should be a valid ledger account id."
                },
                "project_id": {
                  "$ref": "#/components/schemas/identifier",
                  "description": "The ID of the project to associate with this detail. Should be a valid project id. Used to track revenue and expenses per project."
                },
                "product_id": {
                  "$ref": "#/components/schemas/identifier",
                  "description": "The ID of the product to use for this detail. When provided, the product's default price, tax rate, ledger account, description and period are applied as defaults. Explicitly provided values take precedence. Should be a valid product id."
                },
                "row_order": {
                  "type": [
                    "integer",
                    "string"
                  ],
                  "description": "The position of this detail in the document, starting at 0. Used to control the display order of details."
                },
                "is_optional": {
                  "type": [
                    "boolean",
                    "string"
                  ],
                  "description": "Whether this detail is optional. Optional details are shown on estimates but not included in the total unless selected by the client. Only allowed on estimates."
                },
                "is_selected": {
                  "type": [
                    "boolean",
                    "string"
                  ],
                  "description": "Whether this optional detail has been selected by the client. Only relevant when `is_optional` is true."
                },
                "_destroy": {
                  "type": [
                    "boolean",
                    "string"
                  ],
                  "description": "Set to `true` to remove this detail from the document. Requires the `id` of the existing detail."
                },
                "automated_tax_enabled": {
                  "type": [
                    "boolean",
                    "string"
                  ],
                  "description": "Whether automatic tax calculation is enabled for this detail. When enabled, the tax rate is automatically determined based on the product's type and VAT rate type, combined with the contact's country, tax number and address. Requires a `product_id` with smart tax selection enabled (i.e. `product_type` and `vat_rate_type` configured on the product)."
                }
              },
              "required": []
            }
          },
          {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "id": {
                  "$ref": "#/components/schemas/identifier",
                  "description": "The ID of an existing detail to update. Required when updating or removing an existing detail; omit when creating a new one."
                },
                "description": {
                  "type": "string",
                  "description": "A free-text description for this detail, e.g. the name of the product or service delivered."
                },
                "period": {
                  "type": "string",
                  "description": "String with a date range: `20140101..20141231`, presets are also allowed: `this_month`, `prev_month`, `next_month`, `this_quarter`, `prev_quarter`, `next_quarter`, `this_year`, `prev_year`, `next_year`. Used to indicate the period the detail applies to, independent of the document date. Revenue or expenses are deferred over this period in the profit and loss report. Omit it to let the document date decide where the amounts land."
                },
                "price": {
                  "$ref": "#/components/schemas/money",
                  "description": "The unit price for this detail."
                },
                "amount": {
                  "type": [
                    "integer",
                    "string"
                  ],
                  "description": "The quantity for this detail, e.g. `1`, `5` or `0.5`. Defaults to 1 if not provided."
                },
                "tax_rate_id": {
                  "$ref": "#/components/schemas/identifier",
                  "description": "The ID of the tax rate to apply to this detail. Should be a valid tax rate id. If not provided, the administration's default tax rate is used."
                },
                "ledger_account_id": {
                  "$ref": "#/components/schemas/identifier",
                  "description": "The ID of the ledger account (category) to book this detail to. Should be a valid ledger account id."
                },
                "project_id": {
                  "$ref": "#/components/schemas/identifier",
                  "description": "The ID of the project to associate with this detail. Should be a valid project id. Used to track revenue and expenses per project."
                },
                "product_id": {
                  "$ref": "#/components/schemas/identifier",
                  "description": "The ID of the product to use for this detail. When provided, the product's default price, tax rate, ledger account, description and period are applied as defaults. Explicitly provided values take precedence. Should be a valid product id."
                },
                "row_order": {
                  "type": [
                    "integer",
                    "string"
                  ],
                  "description": "The position of this detail in the document, starting at 0. Used to control the display order of details."
                },
                "is_optional": {
                  "type": [
                    "boolean",
                    "string"
                  ],
                  "description": "Whether this detail is optional. Optional details are shown on estimates but not included in the total unless selected by the client. Only allowed on estimates."
                },
                "is_selected": {
                  "type": [
                    "boolean",
                    "string"
                  ],
                  "description": "Whether this optional detail has been selected by the client. Only relevant when `is_optional` is true."
                },
                "_destroy": {
                  "type": [
                    "boolean",
                    "string"
                  ],
                  "description": "Set to `true` to remove this detail from the document. Requires the `id` of the existing detail."
                },
                "automated_tax_enabled": {
                  "type": [
                    "boolean",
                    "string"
                  ],
                  "description": "Whether automatic tax calculation is enabled for this detail. When enabled, the tax rate is automatically determined based on the product's type and VAT rate type, combined with the contact's country, tax number and address. Requires a `product_id` with smart tax selection enabled (i.e. `product_type` and `vat_rate_type` configured on the product)."
                }
              }
            }
          }
        ]
      },
      "disposal_response": {
        "type": "object",
        "unevaluatedProperties": false,
        "properties": {
          "date": {
            "type": "string",
            "format": "date"
          },
          "reason": {
            "type": "string",
            "enum": [
              "out_of_use",
              "sold",
              "private_withdrawal",
              "divested"
            ]
          },
          "externally_booked": {
            "type": "boolean"
          },
          "asset_id": {
            "$ref": "#/components/schemas/identifier"
          },
          "reinvestment_reserve_sale": {
            "oneOf": [
              {
                "type": "null"
              },
              {
                "$ref": "#/components/schemas/reinvestment_reserve_sale_response"
              }
            ]
          }
        }
      },
      "document_style_response": {
        "type": "object",
        "unevaluatedProperties": false,
        "properties": {
          "id": {
            "$ref": "#/components/schemas/identifier"
          },
          "administration_id": {
            "$ref": "#/components/schemas/administration_id"
          },
          "name": {
            "type": "string"
          },
          "identity_id": {
            "$ref": "#/components/schemas/identifier"
          },
          "default": {
            "type": "boolean"
          },
          "logo_hash": {
            "type": [
              "string",
              "null"
            ]
          },
          "logo_container_full_width": {
            "type": [
              "boolean",
              "null"
            ],
            "default": false
          },
          "logo_display_width": {
            "type": [
              "integer",
              "null"
            ],
            "default": 50
          },
          "logo_position": {
            "type": "string",
            "enum": [
              "left",
              "center",
              "right"
            ]
          },
          "background_hash": {
            "type": [
              "string",
              "null"
            ]
          },
          "paper_size": {
            "type": "string",
            "enum": [
              "A4",
              "letter"
            ]
          },
          "address_position": {
            "type": "string",
            "enum": [
              "left",
              "right"
            ]
          },
          "font_size": {
            "type": "integer"
          },
          "font_family": {
            "type": "string"
          },
          "print_on_stationery": {
            "type": [
              "boolean",
              "null"
            ],
            "default": false
          },
          "custom_css": {
            "type": [
              "string",
              "null"
            ]
          },
          "invoice_sender_address": {
            "type": "array",
            "items": {
              "type": "object",
              "additionalProperties": {
                "type": [
                  "string",
                  "boolean"
                ]
              }
            }
          },
          "invoice_metadata_left": {
            "type": "array",
            "items": {
              "type": "object",
              "additionalProperties": {
                "type": [
                  "string",
                  "boolean"
                ]
              }
            }
          },
          "invoice_metadata_right": {
            "type": "array",
            "items": {
              "type": "object",
              "additionalProperties": {
                "type": [
                  "string",
                  "boolean"
                ]
              }
            }
          },
          "estimate_sender_address": {
            "type": "array",
            "items": {
              "type": "object",
              "additionalProperties": {
                "type": [
                  "string",
                  "boolean"
                ]
              }
            }
          },
          "estimate_metadata_left": {
            "type": "array",
            "items": {
              "type": "object",
              "additionalProperties": {
                "type": [
                  "string",
                  "boolean"
                ]
              }
            }
          },
          "estimate_metadata_right": {
            "type": "array",
            "items": {
              "type": "object",
              "additionalProperties": {
                "type": [
                  "string",
                  "boolean"
                ]
              }
            }
          },
          "created_at": {
            "type": [
              "string",
              "null"
            ],
            "format": "date-time"
          },
          "updated_at": {
            "type": [
              "string",
              "null"
            ],
            "format": "date-time"
          }
        }
      },
      "download_response": {
        "type": "object",
        "properties": {
          "id": {
            "$ref": "#/components/schemas/identifier"
          },
          "user_id": {
            "$ref": "#/components/schemas/identifier_nullable",
            "description": "The user who created the download"
          },
          "download_type": {
            "type": "string",
            "description": "The type of download (e.g., export_contacts, export_sales_invoices, auditfile)"
          },
          "filename": {
            "type": "string"
          },
          "content_type": {
            "type": "string"
          },
          "failed": {
            "type": "boolean"
          },
          "downloaded": {
            "type": "boolean"
          },
          "created_at": {
            "$ref": "#/components/schemas/timestamp"
          },
          "updated_at": {
            "$ref": "#/components/schemas/timestamp"
          }
        }
      },
      "estimate_response": {
        "type": "object",
        "unevaluatedProperties": false,
        "properties": {
          "id": {
            "$ref": "#/components/schemas/identifier"
          },
          "administration_id": {
            "$ref": "#/components/schemas/administration_id"
          },
          "contact_id": {
            "$ref": "#/components/schemas/identifier"
          },
          "contact": {
            "oneOf": [
              {
                "$ref": "#/components/schemas/simple_contact_response"
              },
              {
                "type": "null"
              }
            ]
          },
          "contact_person_id": {
            "$ref": "#/components/schemas/identifier_nullable"
          },
          "contact_person": {
            "oneOf": [
              {
                "$ref": "#/components/schemas/contact_person_response"
              },
              {
                "type": "null"
              }
            ]
          },
          "estimate_id": {
            "type": [
              "string",
              "null"
            ]
          },
          "estimate_sequence_id": {
            "type": [
              "string",
              "null"
            ]
          },
          "workflow_id": {
            "$ref": "#/components/schemas/identifier"
          },
          "document_style_id": {
            "$ref": "#/components/schemas/identifier"
          },
          "identity_id": {
            "$ref": "#/components/schemas/identifier"
          },
          "draft_id": {
            "type": [
              "integer",
              "null"
            ]
          },
          "state": {
            "type": "string",
            "enum": [
              "draft",
              "open",
              "late",
              "accepted",
              "rejected",
              "billed",
              "archived"
            ]
          },
          "estimate_date": {
            "type": [
              "string",
              "null"
            ],
            "format": "date"
          },
          "due_date": {
            "type": "string",
            "format": "date"
          },
          "reference": {
            "type": [
              "string",
              "null"
            ]
          },
          "language": {
            "type": [
              "string",
              "null"
            ]
          },
          "currency": {
            "type": "string"
          },
          "exchange_rate": {
            "$ref": "#/components/schemas/number"
          },
          "discount": {
            "$ref": "#/components/schemas/number"
          },
          "original_estimate_id": {
            "$ref": "#/components/schemas/identifier_nullable"
          },
          "show_tax": {
            "type": "boolean",
            "default": true
          },
          "sign_online": {
            "type": "boolean",
            "default": true
          },
          "sent_at": {
            "type": [
              "string",
              "null"
            ],
            "format": "date"
          },
          "accepted_at": {
            "type": [
              "string",
              "null"
            ],
            "format": "date"
          },
          "rejected_at": {
            "type": [
              "string",
              "null"
            ],
            "format": "date"
          },
          "archived_at": {
            "type": [
              "string",
              "null"
            ],
            "format": "date"
          },
          "created_at": {
            "type": [
              "string",
              "null"
            ],
            "format": "date-time"
          },
          "updated_at": {
            "type": [
              "string",
              "null"
            ],
            "format": "date-time"
          },
          "public_view_code": {
            "type": [
              "string",
              "null"
            ],
            "pattern": "^\\d+$"
          },
          "public_view_code_expires_at": {
            "type": [
              "string",
              "null"
            ],
            "format": "date-time"
          },
          "version": {
            "type": "integer"
          },
          "pre_text": {
            "type": [
              "string",
              "null"
            ]
          },
          "post_text": {
            "type": [
              "string",
              "null"
            ]
          },
          "details": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/detail_response"
            }
          },
          "prices_are_incl_tax": {
            "type": "boolean",
            "default": false
          },
          "total_price_excl_tax": {
            "$ref": "#/components/schemas/number"
          },
          "total_price_excl_tax_base": {
            "$ref": "#/components/schemas/number"
          },
          "total_price_incl_tax": {
            "$ref": "#/components/schemas/number"
          },
          "total_price_incl_tax_base": {
            "$ref": "#/components/schemas/number"
          },
          "total_discount": {
            "$ref": "#/components/schemas/number"
          },
          "url": {
            "type": "string"
          },
          "custom_fields": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/custom_field_value_response"
            }
          },
          "notes": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/note_response"
            }
          },
          "attachments": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/attachment_response"
            }
          },
          "events": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/event_response"
            }
          },
          "tax_totals": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/tax_subtotal_response"
            }
          }
        }
      },
      "event_response": {
        "type": "object",
        "unevaluatedProperties": false,
        "properties": {
          "administration_id": {
            "oneOf": [
              {
                "$ref": "#/components/schemas/administration_id"
              },
              {
                "type": "null"
              }
            ]
          },
          "user_id": {
            "$ref": "#/components/schemas/identifier"
          },
          "action": {
            "type": "string"
          },
          "link_entity_id": {
            "$ref": "#/components/schemas/identifier_nullable"
          },
          "link_entity_type": {
            "type": [
              "string",
              "null"
            ]
          },
          "data": {
            "type": "object",
            "additionalProperties": true
          },
          "created_at": {
            "$ref": "#/components/schemas/timestamp"
          },
          "updated_at": {
            "$ref": "#/components/schemas/timestamp"
          }
        }
      },
      "extended_user_response": {
        "unevaluatedProperties": false,
        "allOf": [
          {
            "$ref": "#/components/schemas/base_user_response"
          },
          {
            "type": "object",
            "properties": {
              "email": {
                "type": "string"
              },
              "email_validated": {
                "type": "boolean"
              },
              "language": {
                "type": "string"
              },
              "time_zone": {
                "type": "string",
                "example": "Europe/Amsterdam"
              },
              "user_type": {
                "type": "string",
                "enum": [
                  "end_user",
                  "api_user",
                  "system_user",
                  "deleted_end_user",
                  "deleted_api_user",
                  "owner",
                  "accountant",
                  "employee"
                ]
              },
              "permissions": {
                "type": "array",
                "items": {
                  "type": "string",
                  "enum": [
                    "sales_invoices",
                    "documents",
                    "estimates",
                    "bank",
                    "settings",
                    "ownership",
                    "time_entries"
                  ]
                }
              }
            }
          }
        ]
      },
      "external_sales_invoice_response": {
        "type": "object",
        "unevaluatedProperties": false,
        "properties": {
          "id": {
            "$ref": "#/components/schemas/identifier"
          },
          "administration_id": {
            "$ref": "#/components/schemas/administration_id"
          },
          "contact_id": {
            "$ref": "#/components/schemas/identifier_nullable"
          },
          "contact": {
            "oneOf": [
              {
                "$ref": "#/components/schemas/simple_contact_response"
              },
              {
                "type": "null"
              }
            ]
          },
          "date": {
            "type": "string",
            "format": "date"
          },
          "state": {
            "type": "string",
            "enum": [
              "new",
              "open",
              "late",
              "paid",
              "uncollectible",
              "pending_payment"
            ]
          },
          "due_date": {
            "type": [
              "string",
              "null"
            ],
            "format": "date"
          },
          "reference": {
            "type": [
              "string",
              "null"
            ]
          },
          "entry_number": {
            "type": "integer"
          },
          "origin": {
            "type": [
              "string",
              "null"
            ],
            "enum": [
              "upload",
              "endpoint",
              "si",
              "email",
              "si_local",
              "si_peppol",
              "api",
              "moneybird_bv",
              "mollie",
              null
            ]
          },
          "source": {
            "type": [
              "string",
              "null"
            ]
          },
          "source_url": {
            "type": [
              "string",
              "null"
            ]
          },
          "currency": {
            "$ref": "#/components/schemas/currency"
          },
          "paid_at": {
            "type": [
              "string",
              "null"
            ],
            "format": "date"
          },
          "created_at": {
            "$ref": "#/components/schemas/timestamp"
          },
          "updated_at": {
            "$ref": "#/components/schemas/timestamp"
          },
          "version": {
            "$ref": "#/components/schemas/version"
          },
          "details": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/detail_response"
            }
          },
          "payments": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/payment_response"
            }
          },
          "total_paid": {
            "type": "string"
          },
          "total_unpaid": {
            "type": "string"
          },
          "total_unpaid_base": {
            "type": "string"
          },
          "prices_are_incl_tax": {
            "type": "boolean"
          },
          "total_price_excl_tax": {
            "type": "string"
          },
          "total_price_excl_tax_base": {
            "type": "string"
          },
          "total_price_incl_tax": {
            "type": "string"
          },
          "total_price_incl_tax_base": {
            "type": "string"
          },
          "marked_dubious_on": {
            "type": [
              "string",
              "null"
            ],
            "format": "date"
          },
          "marked_uncollectible_on": {
            "type": [
              "string",
              "null"
            ],
            "format": "date"
          },
          "notes": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/note_response"
            }
          },
          "attachments": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/attachment_response"
            }
          },
          "events": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/event_response"
            }
          },
          "tax_totals": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/tax_subtotal_response"
            }
          }
        }
      },
      "financial_account_response": {
        "type": "object",
        "unevaluatedProperties": false,
        "properties": {
          "id": {
            "$ref": "#/components/schemas/identifier"
          },
          "administration_id": {
            "$ref": "#/components/schemas/administration_id"
          },
          "type": {
            "type": "string"
          },
          "name": {
            "type": "string"
          },
          "identifier": {
            "type": "string"
          },
          "currency": {
            "$ref": "#/components/schemas/currency"
          },
          "provider": {
            "type": [
              "string",
              "null"
            ]
          },
          "moneybird_account": {
            "type": "boolean",
            "description": "Whether Moneybird provides this account (Moneybird Betaalrekening or Moneybird Online Betaalmethoden), rather than an account at an external bank or provider."
          },
          "active": {
            "type": "boolean",
            "default": true
          },
          "created_at": {
            "$ref": "#/components/schemas/timestamp"
          },
          "updated_at": {
            "$ref": "#/components/schemas/timestamp"
          }
        }
      },
      "financial_mutation_response": {
        "type": "object",
        "unevaluatedProperties": false,
        "properties": {
          "id": {
            "$ref": "#/components/schemas/identifier"
          },
          "administration_id": {
            "$ref": "#/components/schemas/administration_id"
          },
          "amount": {
            "type": "string"
          },
          "code": {
            "type": [
              "string",
              "null"
            ]
          },
          "date": {
            "type": "string",
            "format": "date"
          },
          "message": {
            "type": [
              "string",
              "null"
            ]
          },
          "contra_account_name": {
            "type": [
              "string",
              "null"
            ]
          },
          "contra_account_number": {
            "type": "string"
          },
          "state": {
            "type": "string",
            "enum": [
              "unprocessed",
              "processed"
            ],
            "default": "unprocessed"
          },
          "settlement_state": {
            "type": "string",
            "enum": [
              "authorised",
              "cancelled",
              "expired",
              "settled",
              "pending",
              "refused",
              "error",
              "captured",
              "failed",
              "returned"
            ],
            "default": "settled"
          },
          "amount_open": {
            "type": "string"
          },
          "sepa_fields": {
            "type": [
              "object",
              "null"
            ]
          },
          "batch_reference": {
            "type": [
              "string",
              "null"
            ]
          },
          "financial_account_id": {
            "$ref": "#/components/schemas/identifier"
          },
          "currency": {
            "$ref": "#/components/schemas/currency"
          },
          "original_amount": {
            "type": [
              "string",
              "null"
            ]
          },
          "created_at": {
            "$ref": "#/components/schemas/timestamp"
          },
          "updated_at": {
            "$ref": "#/components/schemas/timestamp"
          },
          "version": {
            "$ref": "#/components/schemas/version"
          },
          "financial_statement_id": {
            "$ref": "#/components/schemas/identifier"
          },
          "processed_at": {
            "type": [
              "string",
              "null"
            ],
            "format": "date-time"
          },
          "account_servicer_transaction_id": {
            "type": [
              "string",
              "null"
            ]
          },
          "payments": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/payment_response"
            }
          },
          "ledger_account_bookings": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/ledger_account_booking_response"
            }
          }
        }
      },
      "financial_statement_response": {
        "type": "object",
        "unevaluatedProperties": false,
        "properties": {
          "id": {
            "$ref": "#/components/schemas/identifier"
          },
          "financial_account_id": {
            "$ref": "#/components/schemas/identifier"
          },
          "reference": {
            "type": "string"
          },
          "official_date": {
            "type": [
              "string",
              "null"
            ],
            "format": "date"
          },
          "official_balance": {
            "type": [
              "string",
              "null"
            ]
          },
          "importer_service": {
            "type": [
              "string",
              "null"
            ]
          },
          "financial_mutations": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/financial_mutation_response"
            }
          }
        }
      },
      "fiscal_allocation_response": {
        "type": "object",
        "unevaluatedProperties": false,
        "properties": {
          "id": {
            "$ref": "#/components/schemas/identifier"
          },
          "administration_id": {
            "$ref": "#/components/schemas/administration_id"
          },
          "ledger_account_id": {
            "$ref": "#/components/schemas/identifier"
          },
          "private_ledger_account_id": {
            "$ref": "#/components/schemas/identifier"
          },
          "percentage": {
            "$ref": "#/components/schemas/number"
          },
          "price": {
            "$ref": "#/components/schemas/number"
          },
          "price_base": {
            "$ref": "#/components/schemas/number"
          },
          "created_at": {
            "$ref": "#/components/schemas/timestamp"
          },
          "updated_at": {
            "$ref": "#/components/schemas/timestamp"
          }
        }
      },
      "fiscal_allocations_attributes": {
        "oneOf": [
          {
            "type": "object",
            "additionalProperties": {
              "type": "object",
              "unevaluatedProperties": false,
              "properties": {
                "id": {
                  "$ref": "#/components/schemas/identifier",
                  "description": "The ID of an existing fiscal allocation to update. Required when updating or removing an existing allocation; omit when creating a new one."
                },
                "ledger_account_id": {
                  "$ref": "#/components/schemas/identifier",
                  "description": "The ID of the ledger account (category) this allocation applies to. Must match a ledger account used in the document's details."
                },
                "private_ledger_account_id": {
                  "$ref": "#/components/schemas/identifier",
                  "description": "The ID of the private ledger account (equity account) to allocate the private portion to."
                },
                "percentage": {
                  "$ref": "#/components/schemas/number",
                  "description": "The percentage of expenses for the given ledger account that is allocated to private use. The total percentage across all allocations for the same ledger account on a document must not exceed 100.",
                  "minimum": 0,
                  "maximum": 100
                },
                "_destroy": {
                  "type": [
                    "boolean",
                    "string"
                  ],
                  "description": "Set to `true` to remove this fiscal allocation from the document. Requires the `id` of the existing allocation."
                }
              },
              "required": []
            }
          },
          {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "id": {
                  "$ref": "#/components/schemas/identifier",
                  "description": "The ID of an existing fiscal allocation to update. Required when updating or removing an existing allocation; omit when creating a new one."
                },
                "ledger_account_id": {
                  "$ref": "#/components/schemas/identifier",
                  "description": "The ID of the ledger account (category) this allocation applies to. Must match a ledger account used in the document's details."
                },
                "private_ledger_account_id": {
                  "$ref": "#/components/schemas/identifier",
                  "description": "The ID of the private ledger account (equity account) to allocate the private portion to."
                },
                "percentage": {
                  "$ref": "#/components/schemas/number",
                  "description": "The percentage of expenses for the given ledger account that is allocated to private use. The total percentage across all allocations for the same ledger account on a document must not exceed 100.",
                  "minimum": 0,
                  "maximum": 100
                },
                "_destroy": {
                  "type": [
                    "boolean",
                    "string"
                  ],
                  "description": "Set to `true` to remove this fiscal allocation from the document. Requires the `id` of the existing allocation."
                }
              }
            }
          }
        ]
      },
      "general_document_response": {
        "type": "object",
        "unevaluatedProperties": false,
        "properties": {
          "id": {
            "$ref": "#/components/schemas/identifier"
          },
          "administration_id": {
            "$ref": "#/components/schemas/administration_id"
          },
          "contact_id": {
            "$ref": "#/components/schemas/identifier_nullable"
          },
          "contact": {
            "oneOf": [
              {
                "$ref": "#/components/schemas/simple_contact_response"
              },
              {
                "type": "null"
              }
            ]
          },
          "reference": {
            "type": [
              "string",
              "null"
            ]
          },
          "date": {
            "type": "string",
            "format": "date"
          },
          "due_date": {
            "type": [
              "string",
              "null"
            ],
            "format": "date"
          },
          "entry_number": {
            "type": [
              "integer",
              "null"
            ]
          },
          "state": {
            "type": "string",
            "enum": [
              "new",
              "open",
              "late",
              "paid",
              "saved",
              "pending_payment"
            ]
          },
          "exchange_rate": {
            "type": [
              "string",
              "null"
            ]
          },
          "created_at": {
            "$ref": "#/components/schemas/timestamp"
          },
          "updated_at": {
            "$ref": "#/components/schemas/timestamp"
          },
          "version": {
            "$ref": "#/components/schemas/version"
          },
          "notes": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/note_response"
            }
          },
          "attachments": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/attachment_response"
            }
          },
          "events": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/event_response"
            }
          }
        }
      },
      "general_journal_document_entry_response": {
        "type": "object",
        "unevaluatedProperties": false,
        "properties": {
          "id": {
            "$ref": "#/components/schemas/identifier"
          },
          "administration_id": {
            "$ref": "#/components/schemas/administration_id"
          },
          "ledger_account_id": {
            "$ref": "#/components/schemas/identifier"
          },
          "project_id": {
            "$ref": "#/components/schemas/identifier_nullable"
          },
          "contact_id": {
            "$ref": "#/components/schemas/identifier_nullable"
          },
          "debit": {
            "type": "string"
          },
          "credit": {
            "type": "string"
          },
          "row_order": {
            "type": [
              "integer",
              "null"
            ]
          },
          "created_at": {
            "$ref": "#/components/schemas/timestamp"
          },
          "updated_at": {
            "$ref": "#/components/schemas/timestamp"
          },
          "description": {
            "type": [
              "string",
              "null"
            ]
          }
        }
      },
      "general_journal_document_response": {
        "type": "object",
        "unevaluatedProperties": false,
        "properties": {
          "id": {
            "$ref": "#/components/schemas/identifier"
          },
          "administration_id": {
            "$ref": "#/components/schemas/administration_id"
          },
          "reference": {
            "type": [
              "string",
              "null"
            ]
          },
          "date": {
            "type": "string",
            "format": "date"
          },
          "journal_type": {
            "type": [
              "string",
              "null"
            ],
            "enum": [
              "fiscal_year_ending",
              null
            ]
          },
          "created_at": {
            "$ref": "#/components/schemas/timestamp"
          },
          "updated_at": {
            "$ref": "#/components/schemas/timestamp"
          },
          "version": {
            "$ref": "#/components/schemas/version"
          },
          "general_journal_document_entries": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/general_journal_document_entry_response"
            }
          },
          "notes": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/note_response"
            }
          },
          "attachments": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/attachment_response"
            }
          },
          "events": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/event_response"
            }
          }
        }
      },
      "general_ledger_amounts": {
        "type": "object",
        "properties": {
          "debit_sums": {
            "$ref": "#/components/schemas/ledger_account_data"
          },
          "credit_sums": {
            "$ref": "#/components/schemas/ledger_account_data"
          },
          "start_balance": {
            "$ref": "#/components/schemas/ledger_account_data"
          },
          "final_balance": {
            "$ref": "#/components/schemas/ledger_account_data"
          }
        }
      },
      "identifier": {
        "type": [
          "string",
          "integer"
        ],
        "pattern": "^\\d+$",
        "description": "A unique record identifier",
        "example": "458026356994737217"
      },
      "identifier_nullable": {
        "type": [
          "string",
          "integer",
          "null"
        ],
        "pattern": "^\\d+$",
        "description": "A unique record identifier",
        "example": "458026356994737217"
      },
      "identity_response": {
        "type": "object",
        "unevaluatedProperties": false,
        "properties": {
          "id": {
            "$ref": "#/components/schemas/identifier"
          },
          "administration_id": {
            "$ref": "#/components/schemas/administration_id"
          },
          "company_name": {
            "type": [
              "string",
              "null"
            ]
          },
          "city": {
            "type": [
              "string",
              "null"
            ]
          },
          "country": {
            "type": [
              "string",
              "null"
            ]
          },
          "zipcode": {
            "type": [
              "string",
              "null"
            ]
          },
          "address1": {
            "type": [
              "string",
              "null"
            ]
          },
          "address2": {
            "type": [
              "string",
              "null"
            ]
          },
          "email": {
            "type": [
              "string",
              "null"
            ]
          },
          "phone": {
            "type": [
              "string",
              "null"
            ]
          },
          "bank_account_name": {
            "type": [
              "string",
              "null"
            ]
          },
          "bank_account_number": {
            "type": [
              "string",
              "null"
            ]
          },
          "bank_account_bic": {
            "type": [
              "string",
              "null"
            ]
          },
          "custom_fields": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/custom_field_value_response"
            }
          },
          "updated_at": {
            "$ref": "#/components/schemas/timestamp"
          },
          "created_at": {
            "$ref": "#/components/schemas/timestamp"
          },
          "chamber_of_commerce": {
            "type": [
              "string",
              "null"
            ]
          },
          "tax_number": {
            "type": [
              "string",
              "null"
            ]
          }
        }
      },
      "ledger_account_booking_response": {
        "type": "object",
        "unevaluatedProperties": false,
        "properties": {
          "id": {
            "$ref": "#/components/schemas/identifier"
          },
          "administration_id": {
            "$ref": "#/components/schemas/administration_id"
          },
          "financial_mutation_id": {
            "$ref": "#/components/schemas/identifier"
          },
          "ledger_account_id": {
            "$ref": "#/components/schemas/identifier"
          },
          "project_id": {
            "$ref": "#/components/schemas/identifier_nullable"
          },
          "description": {
            "type": [
              "string",
              "null"
            ]
          },
          "price": {
            "type": "string"
          },
          "created_at": {
            "$ref": "#/components/schemas/timestamp"
          },
          "updated_at": {
            "$ref": "#/components/schemas/timestamp"
          }
        }
      },
      "ledger_account_data": {
        "type": "object",
        "description": "Data grouped by ledger account. Contains an array of ledger account entries with ledger_account_id and value.",
        "required": [
          "ledger_accounts"
        ],
        "properties": {
          "ledger_accounts": {
            "type": "array",
            "description": "Array of ledger account entries with ledger_account_id and value.",
            "items": {
              "type": "object",
              "required": [
                "ledger_account_id",
                "value"
              ],
              "properties": {
                "ledger_account_id": {
                  "type": "string",
                  "description": "The ID of the ledger account"
                },
                "value": {
                  "type": "string",
                  "description": "The value for this ledger account"
                }
              }
            }
          }
        }
      },
      "ledger_account_response": {
        "type": "object",
        "unevaluatedProperties": false,
        "properties": {
          "id": {
            "$ref": "#/components/schemas/identifier"
          },
          "administration_id": {
            "$ref": "#/components/schemas/administration_id"
          },
          "name": {
            "type": "string"
          },
          "account_type": {
            "type": "string",
            "enum": [
              "non_current_assets",
              "current_assets",
              "equity",
              "non_current_liabilities",
              "current_liabilities",
              "revenue",
              "direct_costs",
              "expenses",
              "other_income_expenses",
              "other",
              "temporary",
              "provisions"
            ]
          },
          "account_id": {
            "type": [
              "string",
              "null"
            ]
          },
          "parent_id": {
            "$ref": "#/components/schemas/identifier_nullable"
          },
          "active": {
            "type": "boolean"
          },
          "created_at": {
            "$ref": "#/components/schemas/timestamp"
          },
          "updated_at": {
            "$ref": "#/components/schemas/timestamp"
          },
          "allowed_document_types": {
            "type": "array",
            "items": {
              "type": "string",
              "enum": [
                "sales_invoice",
                "purchase_invoice",
                "general_journal_document",
                "financial_mutation",
                "payment"
              ]
            }
          },
          "taxonomy_item": {
            "oneOf": [
              {
                "$ref": "#/components/schemas/taxonomy_item_response"
              },
              {
                "type": "null"
              }
            ]
          },
          "financial_account_id": {
            "$ref": "#/components/schemas/identifier_nullable"
          }
        }
      },
      "minimal_contact_response": {
        "type": "object",
        "unevaluatedProperties": false,
        "properties": {
          "id": {
            "$ref": "#/components/schemas/identifier"
          },
          "firstname": {
            "type": [
              "string",
              "null"
            ]
          },
          "lastname": {
            "type": [
              "string",
              "null"
            ]
          },
          "company_name": {
            "type": [
              "string",
              "null"
            ]
          }
        }
      },
      "minimal_time_entry_response": {
        "type": "object",
        "unevaluatedProperties": false,
        "properties": {
          "id": {
            "$ref": "#/components/schemas/identifier"
          },
          "administration_id": {
            "$ref": "#/components/schemas/administration_id"
          },
          "contact_id": {
            "$ref": "#/components/schemas/identifier_nullable"
          },
          "project_id": {
            "$ref": "#/components/schemas/identifier_nullable"
          },
          "user_id": {
            "$ref": "#/components/schemas/identifier"
          },
          "started_at": {
            "$ref": "#/components/schemas/timestamp"
          },
          "ended_at": {
            "$ref": "#/components/schemas/timestamp"
          },
          "description": {
            "type": [
              "string",
              "null"
            ]
          },
          "paused_duration": {
            "type": "integer"
          },
          "billable": {
            "type": "boolean"
          },
          "created_at": {
            "$ref": "#/components/schemas/timestamp"
          },
          "updated_at": {
            "$ref": "#/components/schemas/timestamp"
          }
        }
      },
      "money": {
        "oneOf": [
          {
            "type": "string",
            "pattern": "^-?[0-9]+[,\\.]?[0-9]*$",
            "example": "1.0"
          },
          {
            "type": "number",
            "minimum": -1000000000,
            "maximum": 1000000000,
            "example": 1
          },
          {
            "type": "null"
          }
        ],
        "description": "An amount of money. Both a decimal and a string '10,95' are accepted. A string is bound to the same range as a number, -1,000,000,000 <= *n* <= 1,000,000,000."
      },
      "non_symbolic_error": {
        "type": "object",
        "properties": {
          "error": {
            "type": "object",
            "additionalProperties": {
              "type": "array",
              "items": {
                "type": [
                  "string",
                  "object"
                ]
              }
            }
          },
          "details": {
            "type": "object",
            "description": "The validation errors per attribute, as codes where the error has one.",
            "additionalProperties": {
              "type": "array",
              "items": {
                "type": "object",
                "description": "Keys other than `error` hold the values used in the message, for example `count`.",
                "required": [
                  "error"
                ],
                "properties": {
                  "error": {
                    "type": "string",
                    "description": "The error code, for example `blank` or `taken`, or the message when the error has no code."
                  }
                },
                "additionalProperties": true
              }
            }
          },
          "full_message": {
            "type": "string",
            "description": "All validation errors in one sentence. Not every resource returns it."
          }
        }
      },
      "note_response": {
        "type": "object",
        "unevaluatedProperties": false,
        "properties": {
          "id": {
            "$ref": "#/components/schemas/identifier"
          },
          "administration_id": {
            "$ref": "#/components/schemas/administration_id"
          },
          "entity_id": {
            "$ref": "#/components/schemas/identifier_nullable"
          },
          "entity_type": {
            "type": "string"
          },
          "user_id": {
            "$ref": "#/components/schemas/identifier"
          },
          "assignee_id": {
            "$ref": "#/components/schemas/identifier_nullable"
          },
          "todo": {
            "type": [
              "boolean",
              "string",
              "null"
            ],
            "default": false
          },
          "note": {
            "type": [
              "string",
              "null"
            ]
          },
          "completed_at": {
            "type": [
              "string",
              "null"
            ],
            "format": "date-time"
          },
          "completed_by_id": {
            "$ref": "#/components/schemas/identifier_nullable"
          },
          "todo_type": {
            "type": [
              "string",
              "null"
            ],
            "enum": [
              "sales_invoice_due",
              "purchase_invoice_due",
              "general_document_reminder",
              "general_document_due",
              "new_document_awaiting_processing",
              "new_financial_mutation_awaiting_processing",
              "financial_mutations_not_updated",
              "sales_invoice_payment_not_linked_to_financial_mutation",
              "document_payment_not_linked_to_financial_mutation",
              "sales_invoice_awaiting_payment_batch",
              "export_sales_invoices_ready",
              "export_documents_ready",
              "export_contacts_ready",
              "import_contacts_ready",
              "recurring_sales_invoice_auto_send_failed",
              "sales_invoice_scheduled_sending_failed",
              "sales_invoice_reminder_sending_failed",
              "sales_invoice_payment_email_missing_sender_email",
              "sales_invoice_becoming_due",
              "sales_invoice_collecting_failed",
              "estimate_due",
              "export_estimates_ready",
              "sales_invoice_email_delivery_failed",
              "sales_invoice_email_marked_as_spam",
              "estimate_email_delivery_failed",
              "estimate_email_marked_as_spam",
              "purchase_invoice_invalid_ubl",
              "sales_invoice_unprintable",
              "estimate_unprintable",
              "auditfile_ready",
              "import_financial_statement_finished",
              "recurring_sales_invoice_auto_send_skipped_import_wizard",
              "ledger_account_report_export_ready",
              "recurring_sales_invoice_failed_deleted_contact",
              "recurring_sales_invoice_create_invoice_failed",
              "sales_invoice_simplerinvoicing_delivery_failed_unroutable",
              "purchase_invoice_received_simplerinvoicing",
              "sales_invoice_simplerinvoicing_delivery_error",
              "purchase_transaction_expired",
              "sales_invoice_si_delivery_failed_contact_unreachable",
              "sales_invoice_si_delivery_failed_deactivated",
              "sales_invoice_si_delivery_failed_identity_unverified",
              "sales_invoice_si_delivery_failed_length_exceeded",
              "recurring_document_stopped_by_contact_delete",
              "sales_invoice_email_previously_bounced",
              "estimate_email_previously_bounced",
              "email_domain_invalidated",
              "external_sales_invoice_invalid_ubl",
              "sales_invoice_email_invalid_address",
              "estimate_email_invalid_address",
              "gateway_connection_terminated",
              "sales_invoice_email_payload_too_large",
              "estimate_email_payload_too_large",
              "ponto_organization_not_activated",
              "ponto_financial_institution_deprecated",
              "contact_email_delivery_failed",
              "contact_email_marked_as_spam",
              "contact_email_previously_bounced",
              "contact_email_invalid_address",
              "contact_email_payload_too_large",
              "sales_invoice_scheduling_failed_due_to_payment_information",
              "sales_invoice_scheduling_failed_due_to_delivery_information",
              "sales_invoice_scheduling_failed_due_to_collection_method",
              "sales_invoice_collecting_failed_missing_subscription",
              "sales_invoice_collecting_failed_no_mandate",
              "sales_invoice_si_delivery_failed_ubl_validation_failed",
              "sales_invoice_email_sender_limit",
              "estimate_email_sender_limit",
              "contact_email_sender_limit",
              "sales_invoice_email_blocked",
              "estimate_email_blocked",
              "contact_email_blocked",
              "sales_invoice_email_invalid_attachment",
              "estimate_email_invalid_attachment",
              "contact_email_invalid_attachment",
              "sales_invoice_collecting_failed_monthly_limit_exceeded",
              "sales_invoice_collecting_failed_invalid_currency",
              "mollie_credential_needs_reconnect",
              "adyen_verification_error",
              "contact_email_not_present",
              "financial_mutation_failed",
              "sales_invoice_si_delivery_failed_invalid_sender",
              "sales_invoice_tax_number_invalid",
              "payment_transaction_no_positive_payment",
              "financial_mutation_payment_locked",
              "sales_invoice_withdrawal_requested",
              null
            ]
          },
          "data": {
            "type": [
              "object",
              "null"
            ]
          },
          "created_at": {
            "$ref": "#/components/schemas/timestamp"
          },
          "updated_at": {
            "$ref": "#/components/schemas/timestamp"
          }
        }
      },
      "number": {
        "oneOf": [
          {
            "type": "string",
            "pattern": "^-?[0-9]+[,\\.]?[0-9]*$",
            "example": "1.0"
          },
          {
            "type": "number",
            "example": 1
          },
          {
            "type": "null"
          }
        ]
      },
      "payment_response": {
        "type": "object",
        "unevaluatedProperties": false,
        "properties": {
          "id": {
            "$ref": "#/components/schemas/identifier"
          },
          "administration_id": {
            "$ref": "#/components/schemas/administration_id"
          },
          "invoice_type": {
            "type": "string",
            "enum": [
              "SalesInvoice",
              "Document",
              "ExternalSalesInvoice",
              "VatDocument"
            ]
          },
          "invoice_id": {
            "$ref": "#/components/schemas/identifier"
          },
          "financial_account_id": {
            "$ref": "#/components/schemas/identifier_nullable"
          },
          "user_id": {
            "$ref": "#/components/schemas/identifier"
          },
          "payment_transaction_id": {
            "$ref": "#/components/schemas/identifier_nullable"
          },
          "transaction_identifier": {
            "type": [
              "string",
              "null"
            ]
          },
          "price": {
            "$ref": "#/components/schemas/number"
          },
          "price_base": {
            "$ref": "#/components/schemas/number"
          },
          "payment_date": {
            "type": "string",
            "format": "date"
          },
          "credit_invoice_id": {
            "$ref": "#/components/schemas/identifier_nullable"
          },
          "financial_mutation_id": {
            "$ref": "#/components/schemas/identifier_nullable"
          },
          "ledger_account_id": {
            "$ref": "#/components/schemas/identifier_nullable"
          },
          "linked_payment_id": {
            "$ref": "#/components/schemas/identifier_nullable"
          },
          "manual_payment_action": {
            "type": [
              "string",
              "null"
            ]
          },
          "created_at": {
            "$ref": "#/components/schemas/timestamp"
          },
          "updated_at": {
            "$ref": "#/components/schemas/timestamp"
          }
        }
      },
      "product_response": {
        "type": "object",
        "unevaluatedProperties": false,
        "properties": {
          "id": {
            "$ref": "#/components/schemas/identifier"
          },
          "administration_id": {
            "$ref": "#/components/schemas/administration_id"
          },
          "description": {
            "type": [
              "string",
              "null"
            ]
          },
          "title": {
            "type": [
              "string",
              "null"
            ]
          },
          "identifier": {
            "type": [
              "string",
              "null"
            ]
          },
          "price": {
            "type": "string"
          },
          "currency": {
            "type": "string"
          },
          "frequency": {
            "type": [
              "integer",
              "null"
            ]
          },
          "frequency_type": {
            "type": [
              "string",
              "null"
            ],
            "enum": [
              "day",
              "week",
              "month",
              "quarter",
              "year",
              null
            ]
          },
          "tax_rate_id": {
            "$ref": "#/components/schemas/identifier_nullable"
          },
          "ledger_account_id": {
            "$ref": "#/components/schemas/identifier"
          },
          "created_at": {
            "$ref": "#/components/schemas/timestamp"
          },
          "updated_at": {
            "$ref": "#/components/schemas/timestamp"
          }
        }
      },
      "profit_loss_amounts": {
        "type": "object",
        "properties": {
          "revenue_by_ledger_account": {
            "$ref": "#/components/schemas/ledger_account_data"
          },
          "direct_costs_by_ledger_account": {
            "$ref": "#/components/schemas/ledger_account_data"
          },
          "expenses_by_ledger_account": {
            "$ref": "#/components/schemas/ledger_account_data"
          },
          "other_income_expenses_by_ledger_account": {
            "$ref": "#/components/schemas/ledger_account_data"
          },
          "gross_profit": {
            "type": "string",
            "description": "`total_revenue` minus the total of `direct_costs_by_ledger_account`"
          },
          "operating_profit": {
            "type": "string",
            "description": "`gross_profit` minus the total of `expenses_by_ledger_account`, so excluding other income and expenses"
          },
          "net_profit": {
            "type": "string",
            "description": "`total_revenue` minus `total_expenses`"
          },
          "total_expenses": {
            "type": "string",
            "description": "The total of `direct_costs_by_ledger_account` plus `expenses_by_ledger_account` minus `other_income_expenses_by_ledger_account`"
          },
          "total_revenue": {
            "type": "string",
            "description": "The total of `revenue_by_ledger_account`"
          }
        }
      },
      "project_report_item": {
        "type": "object",
        "description": "Project report data item",
        "properties": {
          "project_id": {
            "$ref": "#/components/schemas/identifier_nullable"
          },
          "amount": {
            "type": "string"
          }
        },
        "required": [
          "project_id",
          "amount"
        ]
      },
      "project_response": {
        "type": "object",
        "unevaluatedProperties": false,
        "properties": {
          "id": {
            "$ref": "#/components/schemas/identifier"
          },
          "name": {
            "type": "string"
          },
          "state": {
            "type": "string",
            "enum": [
              "active",
              "archived"
            ]
          },
          "budget": {
            "type": [
              "integer",
              "null"
            ]
          }
        }
      },
      "purchase_invoice_response": {
        "type": "object",
        "unevaluatedProperties": false,
        "properties": {
          "id": {
            "$ref": "#/components/schemas/identifier"
          },
          "administration_id": {
            "$ref": "#/components/schemas/administration_id"
          },
          "contact_id": {
            "$ref": "#/components/schemas/identifier_nullable"
          },
          "contact": {
            "oneOf": [
              {
                "$ref": "#/components/schemas/simple_contact_response"
              },
              {
                "type": "null"
              }
            ]
          },
          "reference": {
            "type": [
              "string",
              "null"
            ]
          },
          "date": {
            "type": "string",
            "format": "date",
            "description": "The date of the record itself. It does not say which periods the amounts belong to, because a detail can carry its own `period` and a record dated in one month can cover another. Read `details[].period` for the periods; only a detail without a period of its own lands on this date."
          },
          "due_date": {
            "type": [
              "string",
              "null"
            ],
            "format": "date"
          },
          "entry_number": {
            "type": [
              "integer",
              "null"
            ]
          },
          "state": {
            "type": "string",
            "enum": [
              "new",
              "open",
              "late",
              "paid",
              "saved",
              "pending_payment"
            ]
          },
          "currency": {
            "$ref": "#/components/schemas/currency"
          },
          "exchange_rate": {
            "type": [
              "string",
              "null"
            ]
          },
          "revenue_invoice": {
            "type": [
              "boolean",
              "null"
            ]
          },
          "prices_are_incl_tax": {
            "type": [
              "boolean",
              "null"
            ]
          },
          "origin": {
            "type": [
              "string",
              "null"
            ],
            "enum": [
              "upload",
              "endpoint",
              "si",
              "email",
              "si_local",
              "si_peppol",
              "api",
              "moneybird_bv",
              "mollie",
              null
            ]
          },
          "paid_at": {
            "type": [
              "string",
              "null"
            ],
            "format": "date"
          },
          "tax_number": {
            "type": [
              "string",
              "null"
            ]
          },
          "total_price_excl_tax": {
            "type": [
              "string",
              "null"
            ]
          },
          "total_price_excl_tax_base": {
            "type": [
              "string",
              "null"
            ]
          },
          "total_price_incl_tax": {
            "type": [
              "string",
              "null"
            ]
          },
          "total_price_incl_tax_base": {
            "type": [
              "string",
              "null"
            ]
          },
          "created_at": {
            "$ref": "#/components/schemas/timestamp"
          },
          "updated_at": {
            "$ref": "#/components/schemas/timestamp"
          },
          "version": {
            "$ref": "#/components/schemas/version"
          },
          "details": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/detail_response"
            }
          },
          "fiscal_allocations": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/fiscal_allocation_response"
            }
          },
          "payments": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/payment_response"
            }
          },
          "notes": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/note_response"
            }
          },
          "attachments": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/attachment_response"
            }
          },
          "events": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/event_response"
            }
          }
        }
      },
      "purchase_transaction_batch_response": {
        "type": "object",
        "unevaluatedProperties": false,
        "properties": {
          "id": {
            "$ref": "#/components/schemas/identifier"
          },
          "administration_id": {
            "$ref": "#/components/schemas/administration_id"
          },
          "financial_account_id": {
            "$ref": "#/components/schemas/identifier"
          },
          "state": {
            "type": "string",
            "enum": [
              "exported",
              "cancelled",
              "open"
            ]
          },
          "identifier": {
            "type": "string"
          },
          "created_at": {
            "$ref": "#/components/schemas/timestamp"
          },
          "updated_at": {
            "$ref": "#/components/schemas/timestamp"
          }
        }
      },
      "purchase_transaction_response": {
        "type": "object",
        "unevaluatedProperties": false,
        "properties": {
          "id": {
            "$ref": "#/components/schemas/identifier"
          },
          "administration_id": {
            "$ref": "#/components/schemas/administration_id"
          },
          "financial_account_id": {
            "$ref": "#/components/schemas/identifier"
          },
          "payment_instrument_id": {
            "$ref": "#/components/schemas/identifier_nullable"
          },
          "state": {
            "type": "string",
            "enum": [
              "open",
              "cancelled",
              "paid",
              "pending_payment",
              "error",
              "awaiting_authorization",
              "preparing"
            ]
          },
          "sepa_iban": {
            "type": "string"
          },
          "sepa_iban_account_name": {
            "type": "string"
          },
          "sepa_bic": {
            "type": "string"
          },
          "source_sepa_iban": {
            "type": [
              "string",
              "null"
            ]
          },
          "source_sepa_iban_account_name": {
            "type": [
              "string",
              "null"
            ]
          },
          "date": {
            "type": [
              "string",
              "null"
            ],
            "format": "date"
          },
          "description": {
            "type": "string"
          },
          "end_to_end_id": {
            "type": "string"
          },
          "contact": {
            "oneOf": [
              {
                "$ref": "#/components/schemas/simple_contact_response"
              },
              {
                "type": "null"
              }
            ]
          },
          "amount": {
            "type": "string"
          },
          "created_at": {
            "$ref": "#/components/schemas/timestamp"
          },
          "updated_at": {
            "$ref": "#/components/schemas/timestamp"
          },
          "payable_type": {
            "type": [
              "string",
              "null"
            ]
          },
          "payable_id": {
            "$ref": "#/components/schemas/identifier_nullable"
          },
          "payment_method": {
            "type": [
              "string",
              "null"
            ]
          }
        }
      },
      "receipt_response": {
        "type": "object",
        "unevaluatedProperties": false,
        "properties": {
          "id": {
            "$ref": "#/components/schemas/identifier"
          },
          "administration_id": {
            "$ref": "#/components/schemas/administration_id"
          },
          "contact_id": {
            "$ref": "#/components/schemas/identifier_nullable"
          },
          "contact": {
            "oneOf": [
              {
                "$ref": "#/components/schemas/simple_contact_response"
              },
              {
                "type": "null"
              }
            ]
          },
          "reference": {
            "type": [
              "string",
              "null"
            ]
          },
          "date": {
            "type": "string",
            "format": "date",
            "description": "The date of the record itself. It does not say which periods the amounts belong to, because a detail can carry its own `period` and a record dated in one month can cover another. Read `details[].period` for the periods; only a detail without a period of its own lands on this date."
          },
          "due_date": {
            "type": [
              "string",
              "null"
            ],
            "format": "date"
          },
          "entry_number": {
            "type": [
              "integer",
              "null"
            ]
          },
          "state": {
            "type": "string",
            "enum": [
              "new",
              "open",
              "late",
              "paid",
              "saved",
              "pending_payment"
            ]
          },
          "currency": {
            "type": [
              "string",
              "null"
            ]
          },
          "exchange_rate": {
            "$ref": "#/components/schemas/number"
          },
          "revenue_invoice": {
            "type": [
              "boolean",
              "null"
            ]
          },
          "prices_are_incl_tax": {
            "type": [
              "boolean",
              "null"
            ]
          },
          "origin": {
            "type": [
              "string",
              "null"
            ],
            "enum": [
              "upload",
              "endpoint",
              "si",
              "email",
              "si_local",
              "si_peppol",
              "api",
              "moneybird_bv",
              "mollie",
              null
            ]
          },
          "paid_at": {
            "type": [
              "string",
              "null"
            ],
            "format": "date"
          },
          "tax_number": {
            "type": [
              "string",
              "null"
            ]
          },
          "total_price_excl_tax": {
            "type": [
              "string",
              "null"
            ]
          },
          "total_price_excl_tax_base": {
            "type": [
              "string",
              "null"
            ]
          },
          "total_price_incl_tax": {
            "type": [
              "string",
              "null"
            ]
          },
          "total_price_incl_tax_base": {
            "type": [
              "string",
              "null"
            ]
          },
          "created_at": {
            "$ref": "#/components/schemas/timestamp"
          },
          "updated_at": {
            "$ref": "#/components/schemas/timestamp"
          },
          "version": {
            "$ref": "#/components/schemas/version"
          },
          "details": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/detail_response"
            }
          },
          "fiscal_allocations": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/fiscal_allocation_response"
            }
          },
          "payments": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/payment_response"
            }
          },
          "notes": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/note_response"
            }
          },
          "attachments": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/attachment_response"
            }
          },
          "events": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/event_response"
            }
          }
        }
      },
      "recurring_contract_response": {
        "type": "object",
        "unevaluatedProperties": false,
        "properties": {
          "type": {
            "type": [
              "string",
              "null"
            ]
          },
          "sepa_mandate": {
            "type": "boolean"
          },
          "bank": {
            "type": [
              "string",
              "null"
            ]
          },
          "iban": {
            "type": [
              "string",
              "null"
            ]
          },
          "bic": {
            "type": [
              "string",
              "null"
            ]
          },
          "iban_account_name": {
            "type": [
              "string",
              "null"
            ]
          },
          "card_expiry_month": {
            "type": [
              "string",
              "null"
            ]
          },
          "card_expiry_year": {
            "type": [
              "string",
              "null"
            ]
          },
          "card_final_digits": {
            "type": [
              "string",
              "null"
            ]
          },
          "created_at": {
            "$ref": "#/components/schemas/timestamp"
          }
        }
      },
      "recurring_sales_invoice_response": {
        "type": "object",
        "unevaluatedProperties": false,
        "properties": {
          "id": {
            "$ref": "#/components/schemas/identifier"
          },
          "administration_id": {
            "$ref": "#/components/schemas/administration_id"
          },
          "contact_id": {
            "$ref": "#/components/schemas/identifier"
          },
          "contact": {
            "$ref": "#/components/schemas/simple_contact_response"
          },
          "contact_person_id": {
            "$ref": "#/components/schemas/identifier_nullable"
          },
          "contact_person": {
            "oneOf": [
              {
                "$ref": "#/components/schemas/contact_person_response"
              },
              {
                "type": "null"
              }
            ]
          },
          "workflow_id": {
            "$ref": "#/components/schemas/identifier"
          },
          "start_date": {
            "type": "string",
            "format": "date"
          },
          "invoice_date": {
            "type": "string",
            "format": "date"
          },
          "last_date": {
            "type": [
              "string",
              "null"
            ],
            "format": "date"
          },
          "active": {
            "type": [
              "boolean",
              "null"
            ]
          },
          "payment_conditions": {
            "type": [
              "string",
              "null"
            ]
          },
          "reference": {
            "type": [
              "string",
              "null"
            ]
          },
          "language": {
            "type": "string"
          },
          "currency": {
            "type": "string"
          },
          "discount": {
            "type": [
              "string",
              "null"
            ]
          },
          "first_due_interval": {
            "type": "integer"
          },
          "auto_send": {
            "type": [
              "boolean",
              "null"
            ]
          },
          "sending_scheduled_at": {
            "type": [
              "string",
              "null"
            ],
            "format": "date-time"
          },
          "sending_scheduled_user_id": {
            "$ref": "#/components/schemas/identifier_nullable"
          },
          "frequency_type": {
            "type": "string",
            "enum": [
              "day",
              "week",
              "month",
              "quarter",
              "year"
            ]
          },
          "frequency": {
            "type": "integer"
          },
          "created_at": {
            "type": [
              "string",
              "null"
            ],
            "format": "date-time"
          },
          "updated_at": {
            "type": [
              "string",
              "null"
            ],
            "format": "date-time"
          },
          "version": {
            "$ref": "#/components/schemas/version"
          },
          "prices_are_incl_tax": {
            "type": "boolean"
          },
          "total_price_excl_tax": {
            "type": "string"
          },
          "total_price_excl_tax_base": {
            "type": "string"
          },
          "total_price_incl_tax": {
            "type": "string"
          },
          "total_price_incl_tax_base": {
            "type": "string"
          },
          "details": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/detail_response"
            }
          },
          "custom_fields": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/custom_field_value_response"
            }
          },
          "notes": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/note_response"
            }
          },
          "attachments": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/attachment_response"
            }
          },
          "events": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/event_response"
            }
          },
          "subscription": {
            "oneOf": [
              {
                "$ref": "#/components/schemas/subscription_response"
              },
              {
                "type": "null"
              }
            ]
          }
        }
      },
      "reinvestment_reserve_purchase_response": {
        "type": "object",
        "unevaluatedProperties": false,
        "properties": {
          "id": {
            "$ref": "#/components/schemas/identifier"
          },
          "amount": {
            "$ref": "#/components/schemas/number"
          },
          "date": {
            "type": "string",
            "format": "date"
          },
          "asset_id": {
            "$ref": "#/components/schemas/identifier"
          }
        }
      },
      "reinvestment_reserve_sale_response": {
        "type": "object",
        "unevaluatedProperties": false,
        "properties": {
          "id": {
            "$ref": "#/components/schemas/identifier"
          },
          "amount": {
            "$ref": "#/components/schemas/number"
          },
          "date": {
            "type": "string",
            "format": "date"
          },
          "disposal_id": {
            "$ref": "#/components/schemas/identifier"
          }
        }
      },
      "sales_invoice_response": {
        "type": "object",
        "unevaluatedProperties": false,
        "properties": {
          "id": {
            "$ref": "#/components/schemas/identifier"
          },
          "administration_id": {
            "$ref": "#/components/schemas/administration_id"
          },
          "contact_id": {
            "$ref": "#/components/schemas/identifier"
          },
          "contact": {
            "$ref": "#/components/schemas/simple_contact_response"
          },
          "contact_person_id": {
            "$ref": "#/components/schemas/identifier_nullable"
          },
          "contact_person": {
            "oneOf": [
              {
                "$ref": "#/components/schemas/contact_person_response"
              },
              {
                "type": "null"
              }
            ]
          },
          "invoice_id": {
            "type": [
              "string",
              "null"
            ],
            "description": "The invoice number. It is `null` while the invoice is a draft."
          },
          "recurring_sales_invoice_id": {
            "$ref": "#/components/schemas/identifier_nullable"
          },
          "subscription_id": {
            "$ref": "#/components/schemas/identifier_nullable"
          },
          "workflow_id": {
            "$ref": "#/components/schemas/identifier"
          },
          "document_style_id": {
            "$ref": "#/components/schemas/identifier"
          },
          "identity_id": {
            "$ref": "#/components/schemas/identifier"
          },
          "draft_id": {
            "type": [
              "integer",
              "null"
            ],
            "description": "Sequence number a draft is referred to by while it has no invoice number yet."
          },
          "state": {
            "type": "string",
            "enum": [
              "draft",
              "scheduled",
              "open",
              "pending_payment",
              "reminded",
              "late",
              "paid",
              "uncollectible"
            ]
          },
          "invoice_date": {
            "type": [
              "string",
              "null"
            ],
            "format": "date",
            "description": "The date of the record itself. It does not say which periods the amounts belong to, because a detail can carry its own `period` and a record dated in one month can cover another. Read `details[].period` for the periods; only a detail without a period of its own lands on this date."
          },
          "due_date": {
            "type": "string",
            "format": "date"
          },
          "payment_conditions": {
            "type": [
              "string",
              "null"
            ]
          },
          "payment_reference": {
            "type": [
              "string",
              "null"
            ]
          },
          "short_payment_reference": {
            "type": [
              "string",
              "null"
            ]
          },
          "reference": {
            "type": [
              "string",
              "null"
            ]
          },
          "language": {
            "type": [
              "string",
              "null"
            ]
          },
          "currency": {
            "type": "string"
          },
          "discount": {
            "type": [
              "string",
              "null"
            ]
          },
          "original_sales_invoice_id": {
            "$ref": "#/components/schemas/identifier_nullable"
          },
          "paused": {
            "type": "boolean"
          },
          "paid_at": {
            "type": [
              "string",
              "null"
            ],
            "format": "date"
          },
          "sent_at": {
            "type": [
              "string",
              "null"
            ],
            "format": "date"
          },
          "created_at": {
            "type": "string",
            "format": "date-time"
          },
          "updated_at": {
            "type": "string",
            "format": "date-time"
          },
          "public_view_code": {
            "type": [
              "string",
              "null"
            ]
          },
          "public_view_code_expires_at": {
            "type": [
              "string",
              "null"
            ],
            "format": "date-time"
          },
          "version": {
            "$ref": "#/components/schemas/version"
          },
          "details": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/detail_response"
            }
          },
          "payments": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/payment_response"
            }
          },
          "total_paid": {
            "type": "string"
          },
          "total_unpaid": {
            "type": "string"
          },
          "total_unpaid_base": {
            "type": "string"
          },
          "prices_are_incl_tax": {
            "type": "boolean"
          },
          "total_price_excl_tax": {
            "type": "string"
          },
          "total_price_excl_tax_base": {
            "type": "string"
          },
          "total_price_incl_tax": {
            "type": "string"
          },
          "total_price_incl_tax_base": {
            "type": "string"
          },
          "total_discount": {
            "type": "string"
          },
          "marked_dubious_on": {
            "type": [
              "string",
              "null"
            ],
            "format": "date"
          },
          "marked_uncollectible_on": {
            "type": [
              "string",
              "null"
            ],
            "format": "date"
          },
          "reminder_count": {
            "type": [
              "integer",
              "null"
            ]
          },
          "next_reminder": {
            "type": [
              "string",
              "null"
            ],
            "format": "date"
          },
          "original_estimate_id": {
            "$ref": "#/components/schemas/identifier_nullable"
          },
          "url": {
            "type": "string"
          },
          "payment_url": {
            "type": "string"
          },
          "custom_fields": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/custom_field_value_response"
            }
          },
          "notes": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/note_response"
            }
          },
          "attachments": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/attachment_response"
            }
          },
          "events": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/event_response"
            }
          },
          "tax_totals": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/tax_subtotal_response"
            }
          },
          "time_entries": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/minimal_time_entry_response"
            }
          }
        }
      },
      "simple_contact_response": {
        "type": "object",
        "unevaluatedProperties": false,
        "properties": {
          "id": {
            "$ref": "#/components/schemas/identifier"
          },
          "administration_id": {
            "$ref": "#/components/schemas/administration_id"
          },
          "company_name": {
            "type": [
              "string",
              "null"
            ]
          },
          "firstname": {
            "type": [
              "string",
              "null"
            ]
          },
          "lastname": {
            "type": [
              "string",
              "null"
            ]
          },
          "address1": {
            "type": [
              "string",
              "null"
            ]
          },
          "address2": {
            "type": [
              "string",
              "null"
            ]
          },
          "zipcode": {
            "type": [
              "string",
              "null"
            ]
          },
          "city": {
            "type": [
              "string",
              "null"
            ]
          },
          "country": {
            "type": "string"
          },
          "phone": {
            "type": [
              "string",
              "null"
            ]
          },
          "delivery_method": {
            "type": [
              "string",
              "null"
            ],
            "enum": [
              "Email",
              "Post",
              "Manual",
              "Simplerinvoicing",
              "Peppol",
              null
            ]
          },
          "customer_id": {
            "type": "string"
          },
          "tax_number": {
            "type": [
              "string",
              "null"
            ]
          },
          "chamber_of_commerce": {
            "type": [
              "string",
              "null"
            ]
          },
          "bank_account": {
            "type": [
              "string",
              "null"
            ]
          },
          "is_trusted": {
            "type": "boolean"
          },
          "max_transfer_amount": {
            "type": [
              "string",
              "null"
            ]
          },
          "attention": {
            "type": [
              "string",
              "null"
            ]
          },
          "email": {
            "type": [
              "string",
              "null"
            ]
          },
          "email_ubl": {
            "type": "boolean"
          },
          "send_invoices_to_attention": {
            "type": [
              "string",
              "null"
            ]
          },
          "send_invoices_to_email": {
            "type": [
              "string",
              "null"
            ]
          },
          "send_estimates_to_attention": {
            "type": [
              "string",
              "null"
            ]
          },
          "send_estimates_to_email": {
            "type": [
              "string",
              "null"
            ]
          },
          "direct_debit": {
            "type": "boolean"
          },
          "sepa_active": {
            "type": [
              "boolean",
              "null"
            ]
          },
          "sepa_iban": {
            "type": [
              "string",
              "null"
            ]
          },
          "sepa_iban_account_name": {
            "type": [
              "string",
              "null"
            ]
          },
          "sepa_bic": {
            "type": [
              "string",
              "null"
            ]
          },
          "sepa_mandate_id": {
            "type": [
              "string",
              "null"
            ]
          },
          "sepa_mandate_date": {
            "type": [
              "string",
              "null"
            ],
            "format": "date"
          },
          "sepa_sequence_type": {
            "type": "string",
            "enum": [
              "RCUR",
              "FRST",
              "OOFF",
              "FNAL"
            ]
          },
          "credit_card_number": {
            "type": [
              "string",
              "null"
            ]
          },
          "credit_card_reference": {
            "type": [
              "string",
              "null"
            ]
          },
          "credit_card_type": {
            "type": [
              "string",
              "null"
            ],
            "enum": [
              "mastercard",
              "visa",
              null
            ]
          },
          "tax_number_validated_at": {
            "type": [
              "string",
              "null"
            ],
            "format": "date-time"
          },
          "tax_number_valid": {
            "type": [
              "boolean",
              "null"
            ]
          },
          "invoice_workflow_id": {
            "$ref": "#/components/schemas/identifier_nullable"
          },
          "estimate_workflow_id": {
            "$ref": "#/components/schemas/identifier_nullable"
          },
          "si_identifier": {
            "type": [
              "string",
              "null"
            ]
          },
          "si_identifier_type": {
            "type": [
              "string",
              "null"
            ]
          },
          "moneybird_payments_mandate": {
            "type": [
              "boolean",
              "null"
            ]
          },
          "created_at": {
            "type": [
              "string",
              "null"
            ],
            "format": "date-time"
          },
          "updated_at": {
            "type": [
              "string",
              "null"
            ],
            "format": "date-time"
          },
          "version": {
            "$ref": "#/components/schemas/version"
          },
          "sales_invoices_url": {
            "type": "string"
          },
          "notes": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/note_response"
            }
          },
          "custom_fields": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/custom_field_value_response"
            }
          },
          "contact_people": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/contact_person_response"
            }
          },
          "archived": {
            "type": "boolean"
          }
        }
      },
      "source_response": {
        "type": "object",
        "unevaluatedProperties": false,
        "properties": {
          "id": {
            "$ref": "#/components/schemas/identifier"
          },
          "asset_id": {
            "$ref": "#/components/schemas/identifier"
          },
          "detail_id": {
            "$ref": "#/components/schemas/identifier"
          },
          "general_journal_document_entry_id": {
            "$ref": "#/components/schemas/identifier"
          }
        }
      },
      "subscription_additional_charge_response": {
        "type": "object",
        "unevaluatedProperties": false,
        "properties": {
          "id": {
            "$ref": "#/components/schemas/identifier"
          },
          "administration_id": {
            "$ref": "#/components/schemas/administration_id"
          },
          "contact_id": {
            "$ref": "#/components/schemas/identifier_nullable"
          },
          "subscription_id": {
            "$ref": "#/components/schemas/identifier_nullable"
          },
          "product_id": {
            "$ref": "#/components/schemas/identifier"
          },
          "detail_id": {
            "$ref": "#/components/schemas/identifier_nullable"
          },
          "amount": {
            "type": [
              "string",
              "null"
            ]
          },
          "price": {
            "type": "string"
          },
          "period": {
            "type": "string",
            "pattern": "^[0-9]{6}..[0-9]{6}$",
            "example": "202501..202506"
          },
          "description": {
            "type": "string"
          }
        }
      },
      "subscription_product_response": {
        "type": "object",
        "unevaluatedProperties": false,
        "properties": {
          "start_date": {
            "type": "string",
            "format": "date"
          },
          "end_date": {
            "type": [
              "string",
              "null"
            ],
            "format": "date"
          },
          "product_id": {
            "$ref": "#/components/schemas/identifier"
          },
          "product": {
            "$ref": "#/components/schemas/product_response"
          },
          "amount": {
            "type": "string"
          },
          "discount": {
            "type": [
              "string",
              "null"
            ]
          }
        }
      },
      "subscription_response": {
        "type": "object",
        "unevaluatedProperties": false,
        "properties": {
          "id": {
            "$ref": "#/components/schemas/identifier"
          },
          "administration_id": {
            "$ref": "#/components/schemas/administration_id"
          },
          "start_date": {
            "type": "string",
            "format": "date"
          },
          "end_date": {
            "type": [
              "string",
              "null"
            ],
            "format": "date"
          },
          "frequency": {
            "type": [
              "integer",
              "null"
            ]
          },
          "frequency_type": {
            "type": [
              "string",
              "null"
            ],
            "enum": [
              "day",
              "week",
              "month",
              "quarter",
              "year",
              null
            ]
          },
          "reference": {
            "type": [
              "string",
              "null"
            ]
          },
          "cancelled_at": {
            "type": [
              "string",
              "null"
            ],
            "format": "date-time"
          },
          "product_id": {
            "$ref": "#/components/schemas/identifier"
          },
          "product": {
            "$ref": "#/components/schemas/product_response"
          },
          "contact_id": {
            "$ref": "#/components/schemas/identifier"
          },
          "contact": {
            "$ref": "#/components/schemas/simple_contact_response"
          },
          "contact_person_id": {
            "$ref": "#/components/schemas/identifier_nullable"
          },
          "contact_person": {
            "oneOf": [
              {
                "$ref": "#/components/schemas/contact_person_response"
              },
              {
                "type": "null"
              }
            ]
          },
          "subscription_products": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/subscription_product_response"
            }
          },
          "recurring_sales_invoice_id": {
            "$ref": "#/components/schemas/identifier_nullable"
          }
        }
      },
      "subscription_template_response": {
        "type": "object",
        "unevaluatedProperties": false,
        "properties": {
          "id": {
            "$ref": "#/components/schemas/identifier"
          },
          "administration_id": {
            "$ref": "#/components/schemas/administration_id"
          },
          "workflow_id": {
            "$ref": "#/components/schemas/identifier"
          },
          "document_style_id": {
            "$ref": "#/components/schemas/identifier"
          },
          "mergeable": {
            "type": "boolean"
          },
          "contact_can_update": {
            "type": "boolean"
          },
          "products": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/product_response"
            }
          }
        }
      },
      "symbolic_error": {
        "type": "object",
        "properties": {
          "error": {
            "type": [
              "string"
            ]
          },
          "symbolic": {
            "type": "object",
            "additionalProperties": {
              "type": [
                "string",
                "object",
                "array"
              ]
            }
          }
        }
      },
      "task_list_group_response": {
        "type": "object",
        "unevaluatedProperties": false,
        "properties": {
          "id": {
            "$ref": "#/components/schemas/identifier"
          },
          "name": {
            "type": [
              "string",
              "null"
            ]
          },
          "row_order": {
            "type": "integer"
          },
          "report_type": {
            "type": [
              "string",
              "null"
            ]
          },
          "created_at": {
            "$ref": "#/components/schemas/timestamp"
          },
          "updated_at": {
            "$ref": "#/components/schemas/timestamp"
          },
          "tasks": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/task_list_task_response"
            }
          }
        }
      },
      "task_list_response": {
        "type": "object",
        "unevaluatedProperties": false,
        "properties": {
          "id": {
            "$ref": "#/components/schemas/identifier"
          },
          "administration_id": {
            "$ref": "#/components/schemas/identifier"
          },
          "name": {
            "type": "string"
          },
          "description": {
            "type": [
              "string",
              "null"
            ]
          },
          "deadline_on": {
            "type": [
              "string",
              "null"
            ],
            "format": "date"
          },
          "period_begin": {
            "type": [
              "string",
              "null"
            ],
            "format": "date"
          },
          "period_end": {
            "type": [
              "string",
              "null"
            ],
            "format": "date"
          },
          "completed": {
            "type": "boolean"
          },
          "template_id": {
            "$ref": "#/components/schemas/identifier_nullable"
          },
          "total_tasks_count": {
            "type": "integer"
          },
          "completed_tasks_count": {
            "type": "integer"
          },
          "created_at": {
            "$ref": "#/components/schemas/timestamp"
          },
          "updated_at": {
            "$ref": "#/components/schemas/timestamp"
          },
          "groups": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/task_list_group_response"
            }
          }
        }
      },
      "task_list_task_response": {
        "type": "object",
        "unevaluatedProperties": false,
        "properties": {
          "id": {
            "$ref": "#/components/schemas/identifier"
          },
          "administration_id": {
            "$ref": "#/components/schemas/identifier"
          },
          "name": {
            "type": "string"
          },
          "description": {
            "type": [
              "string",
              "null"
            ]
          },
          "row_order": {
            "type": "integer"
          },
          "completed_at": {
            "type": [
              "string",
              "null"
            ],
            "format": "date-time"
          },
          "report_type": {
            "type": [
              "string",
              "null"
            ]
          },
          "task_lists_group_id": {
            "$ref": "#/components/schemas/identifier_nullable"
          },
          "parent_task_id": {
            "$ref": "#/components/schemas/identifier_nullable"
          },
          "assignee_id": {
            "$ref": "#/components/schemas/identifier_nullable"
          },
          "created_at": {
            "$ref": "#/components/schemas/timestamp"
          },
          "updated_at": {
            "$ref": "#/components/schemas/timestamp"
          },
          "subtasks": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/task_list_task_response"
            }
          },
          "notes": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/note_response"
            }
          },
          "events": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/event_response"
            }
          }
        }
      },
      "task_list_template_response": {
        "type": "object",
        "unevaluatedProperties": false,
        "properties": {
          "id": {
            "$ref": "#/components/schemas/identifier"
          },
          "administration_id": {
            "$ref": "#/components/schemas/identifier"
          },
          "name": {
            "type": "string"
          },
          "description": {
            "type": [
              "string",
              "null"
            ]
          },
          "period": {
            "type": [
              "string",
              "null"
            ],
            "description": "ISO 8601 duration string (e.g. \"P1M\" for one month, \"P3M\" for one quarter, \"P1Y\" for one year)"
          },
          "deadline_after": {
            "type": [
              "string",
              "null"
            ],
            "description": "ISO 8601 duration string representing the deadline offset from the period end"
          },
          "created_at": {
            "$ref": "#/components/schemas/timestamp"
          },
          "updated_at": {
            "$ref": "#/components/schemas/timestamp"
          },
          "groups": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/task_list_group_response"
            }
          }
        }
      },
      "tax_rate_response": {
        "type": "object",
        "unevaluatedProperties": false,
        "properties": {
          "id": {
            "$ref": "#/components/schemas/identifier"
          },
          "administration_id": {
            "$ref": "#/components/schemas/administration_id"
          },
          "name": {
            "type": "string"
          },
          "percentage": {
            "oneOf": [
              {
                "$ref": "#/components/schemas/number"
              },
              {
                "type": "null"
              }
            ]
          },
          "tax_rate_type": {
            "type": "string",
            "enum": [
              "sales_invoice",
              "purchase_invoice",
              "general_journal_document"
            ]
          },
          "show_tax": {
            "type": [
              "boolean",
              "null"
            ]
          },
          "active": {
            "type": [
              "boolean",
              "null"
            ]
          },
          "country": {
            "type": [
              "string",
              "null"
            ]
          },
          "created_at": {
            "type": [
              "string",
              "null"
            ],
            "format": "date-time"
          },
          "updated_at": {
            "type": [
              "string",
              "null"
            ],
            "format": "date-time"
          }
        }
      },
      "tax_report_amounts": {
        "type": "object",
        "properties": {
          "tax_rates": {
            "type": "array",
            "items": {
              "type": "object",
              "unevaluatedProperties": false,
              "properties": {
                "tax_rate_id": {
                  "$ref": "#/components/schemas/identifier"
                },
                "name": {
                  "type": "string"
                },
                "percentage": {
                  "type": [
                    "string",
                    "null"
                  ]
                },
                "report_reference": {
                  "type": "string"
                },
                "amount": {
                  "type": "string"
                },
                "type": {
                  "type": "string"
                },
                "tax": {
                  "type": "string"
                }
              }
            }
          }
        }
      },
      "tax_subtotal_response": {
        "type": "object",
        "unevaluatedProperties": false,
        "properties": {
          "tax_rate_id": {
            "$ref": "#/components/schemas/identifier"
          },
          "taxable_amount": {
            "$ref": "#/components/schemas/number"
          },
          "taxable_amount_base": {
            "$ref": "#/components/schemas/number"
          },
          "tax_amount": {
            "$ref": "#/components/schemas/number"
          },
          "tax_amount_base": {
            "$ref": "#/components/schemas/number"
          }
        }
      },
      "taxonomy_item_response": {
        "type": "object",
        "unevaluatedProperties": false,
        "properties": {
          "taxonomy_version": {
            "type": "string"
          },
          "code": {
            "type": "string"
          },
          "name": {
            "type": "string"
          },
          "name_english": {
            "type": [
              "string",
              "null"
            ]
          },
          "reference": {
            "type": [
              "string",
              "null"
            ]
          }
        }
      },
      "time_entry_response": {
        "type": "object",
        "unevaluatedProperties": false,
        "properties": {
          "id": {
            "$ref": "#/components/schemas/identifier"
          },
          "administration_id": {
            "$ref": "#/components/schemas/administration_id"
          },
          "contact_id": {
            "$ref": "#/components/schemas/identifier_nullable"
          },
          "project_id": {
            "$ref": "#/components/schemas/identifier_nullable"
          },
          "sales_invoice_id": {
            "$ref": "#/components/schemas/identifier_nullable"
          },
          "user_id": {
            "$ref": "#/components/schemas/identifier"
          },
          "started_at": {
            "$ref": "#/components/schemas/timestamp"
          },
          "ended_at": {
            "oneOf": [
              {
                "$ref": "#/components/schemas/timestamp"
              },
              {
                "type": "null"
              }
            ]
          },
          "description": {
            "type": "string"
          },
          "paused_duration": {
            "type": "integer"
          },
          "billable": {
            "type": [
              "boolean",
              "null"
            ]
          },
          "created_at": {
            "$ref": "#/components/schemas/timestamp"
          },
          "updated_at": {
            "$ref": "#/components/schemas/timestamp"
          },
          "contact": {
            "oneOf": [
              {
                "$ref": "#/components/schemas/minimal_contact_response"
              },
              {
                "type": "null"
              }
            ]
          },
          "user": {
            "$ref": "#/components/schemas/user_response"
          },
          "project": {
            "oneOf": [
              {
                "$ref": "#/components/schemas/project_response"
              },
              {
                "type": "null"
              }
            ]
          },
          "sales_invoice": {
            "oneOf": [
              {
                "$ref": "#/components/schemas/sales_invoice_response"
              },
              {
                "type": "null"
              }
            ]
          },
          "events": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/event_response"
            }
          },
          "notes": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/note_response"
            }
          }
        }
      },
      "timestamp": {
        "type": "string",
        "format": "date-time"
      },
      "typeless_document_response": {
        "type": "object",
        "unevaluatedProperties": false,
        "properties": {
          "id": {
            "$ref": "#/components/schemas/identifier"
          },
          "administration_id": {
            "$ref": "#/components/schemas/administration_id"
          },
          "contact_id": {
            "$ref": "#/components/schemas/identifier_nullable"
          },
          "contact": {
            "oneOf": [
              {
                "$ref": "#/components/schemas/simple_contact_response"
              },
              {
                "type": "null"
              }
            ]
          },
          "reference": {
            "type": [
              "string",
              "null"
            ]
          },
          "date": {
            "type": "string",
            "format": "date"
          },
          "state": {
            "type": "string",
            "enum": [
              "new",
              "open",
              "late",
              "paid",
              "saved",
              "pending_payment"
            ]
          },
          "origin": {
            "type": [
              "string",
              "null"
            ],
            "enum": [
              "upload",
              "endpoint",
              "si",
              "email",
              "si_local",
              "si_peppol",
              "api",
              "moneybird_bv",
              "mollie",
              null
            ]
          },
          "created_at": {
            "$ref": "#/components/schemas/timestamp"
          },
          "updated_at": {
            "$ref": "#/components/schemas/timestamp"
          },
          "version": {
            "$ref": "#/components/schemas/version"
          },
          "attachments": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/attachment_response"
            }
          },
          "events": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/event_response"
            }
          }
        }
      },
      "user_response": {
        "$ref": "#/components/schemas/base_user_response"
      },
      "value_change_response": {
        "type": "object",
        "unevaluatedProperties": false,
        "properties": {
          "type": {
            "type": "string",
            "enum": [
              "divestment",
              "full_depreciation",
              "manual",
              "arbitrary",
              "linear"
            ]
          },
          "date": {
            "type": "string",
            "format": "date"
          },
          "amount": {
            "$ref": "#/components/schemas/number"
          },
          "description": {
            "type": [
              "null",
              "string"
            ]
          },
          "externally_booked": {
            "type": "boolean"
          },
          "asset_id": {
            "$ref": "#/components/schemas/identifier"
          }
        }
      },
      "verification_response": {
        "type": "object",
        "unevaluatedProperties": false,
        "properties": {
          "emails": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "bank_account_numbers": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "chamber_of_commerce_number": {
            "type": "string"
          },
          "tax_number": {
            "type": "string"
          }
        }
      },
      "verifications_response": {
        "$ref": "#/components/schemas/verification_response"
      },
      "version": {
        "type": "integer"
      },
      "webhook_response": {
        "type": "object",
        "unevaluatedProperties": false,
        "properties": {
          "id": {
            "$ref": "#/components/schemas/identifier"
          },
          "administration_id": {
            "$ref": "#/components/schemas/administration_id"
          },
          "url": {
            "type": "string"
          },
          "enabled_events": {
            "type": "array",
            "items": {
              "type": "string"
            },
            "description": "List of events this webhook is subscribed to. See [webhook events](https://developer.moneybird.com/webhooks/events) for all available events and event groups."
          },
          "last_http_status": {
            "type": [
              "integer",
              "string",
              "null"
            ],
            "description": "HTTP status code of the request last received back from the webhook"
          },
          "last_http_body": {
            "type": [
              "string",
              "null"
            ],
            "description": "Body of the request last received back from the webhook"
          },
          "token": {
            "type": "string"
          },
          "secret": {
            "type": "string",
            "description": "The webhook's secret, used to generate webhook signatures. Only returned at creation."
          },
          "deactivated_at": {
            "oneOf": [
              {
                "$ref": "#/components/schemas/timestamp"
              },
              {
                "type": "null"
              }
            ],
            "description": "Timestamp when the webhook was deactivated. Null if the webhook is active."
          }
        }
      },
      "workflow_response": {
        "type": "object",
        "unevaluatedProperties": false,
        "properties": {
          "id": {
            "$ref": "#/components/schemas/identifier"
          },
          "administration_id": {
            "$ref": "#/components/schemas/administration_id"
          },
          "type": {
            "type": "string"
          },
          "name": {
            "type": "string"
          },
          "default": {
            "type": "boolean"
          },
          "currency": {
            "type": "string"
          },
          "language": {
            "type": "string"
          },
          "active": {
            "type": "boolean"
          },
          "prices_are_incl_tax": {
            "type": "boolean"
          },
          "payment_methods": {
            "type": [
              "array",
              "null"
            ],
            "items": {
              "type": "string"
            }
          },
          "collection_method": {
            "type": [
              "string",
              "null"
            ]
          },
          "number_of_collections": {
            "type": "integer"
          },
          "show_qr_code": {
            "type": "boolean"
          },
          "created_at": {
            "$ref": "#/components/schemas/timestamp"
          },
          "updated_at": {
            "$ref": "#/components/schemas/timestamp"
          },
          "steps": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/workflow_step_response"
            }
          }
        }
      },
      "workflow_step_response": {
        "type": "object",
        "unevaluatedProperties": false,
        "properties": {
          "id": {
            "$ref": "#/components/schemas/identifier"
          },
          "administration_id": {
            "$ref": "#/components/schemas/administration_id"
          },
          "step_order": {
            "type": "integer"
          },
          "due_interval": {
            "type": "integer"
          },
          "reminder_delay": {
            "type": "integer"
          },
          "reminder_text": {
            "type": [
              "string",
              "null"
            ]
          },
          "reminder_auto_send": {
            "type": "boolean"
          },
          "action": {
            "type": [
              "string",
              "null"
            ],
            "enum": [
              "suspend_moneybird_account",
              "reactivate_moneybird_account",
              "warn_moneybird_account",
              "cancel_subscription",
              null
            ]
          },
          "created_at": {
            "$ref": "#/components/schemas/timestamp"
          },
          "updated_at": {
            "$ref": "#/components/schemas/timestamp"
          }
        }
      },
      "working_capital_amounts": {
        "type": "object",
        "properties": {
          "working_capital": {
            "type": "string",
            "description": "Current assets minus current liabilities"
          },
          "bank": {
            "type": "string",
            "description": "The balance of the financial accounts, or zero when that balance is negative"
          },
          "to_receive": {
            "type": "string",
            "description": "The current assets other than `bank`"
          },
          "to_pay": {
            "type": "string",
            "description": "The current liabilities, including a negative balance of the financial accounts"
          }
        }
      }
    },
    "securitySchemes": {
      "bearerAuth": {
        "type": "http",
        "scheme": "bearer"
      }
    }
  }
}