openapi: 3.2.0 info: title: Monite Payables API contact: name: Monite team url: https://monite.com/about/ email: developers@monite.com termsOfService: https://monite.com/terms version: '1.0' description: 'Operations tagged Payables across 3 of this provider''s published API definitions: monite-openapi-2023-09-01.json, monite-openapi-2024-05-25.json, monite-openapi.yml. Each path carries the servers of the definition it was published in.' servers: - url: https://api.dev.monite.com/v1 description: Development environment - url: https://api.sandbox.monite.com/v1 description: Sandbox environment - url: https://api.monite.com/v1 description: Production environment (Europe) - url: https://us.api.monite.com/v1 description: Production environment (North America) - url: https://api.monite.oaknorth.co.uk/v1 description: Oak POC environment tags: - name: Payables paths: /payables: get: tags: - Payables summary: Get payables description: 'Lists all payables from the connected entity. If you already have the data of the payable (amount in minor units, currency, vendor information, and other details) stored somewhere as individual attributes, you can create a payable with these attributes by calling POST /payables and providing the base64-encoded contents of the original invoice file in the field `base64_encoded_file`. A payable is a financial document given by an entity`s supplier itemizing the purchase of a good or a service and demanding payment. The `file_name` field is optional. If omitted, it defaults to “default_file_name”. If the settings are configured to automatically set `suggested_payment_term`, this object can be omitted from the request body. The `id` generated for this payable can be used in other API calls to update the data of this payable or trigger status transitions, for example. essential data fields to move from `draft` to `new` Related guide: Create a payable from data See also: Automatic calculation of due date Suggested payment date Attach file Collect payables by email Manage line items' operationId: get_payables parameters: - required: true schema: type: string format: date example: '2023-09-01' name: x-monite-version in: header - description: Sort order (ascending by default). Typically used together with the `sort` parameter. required: false schema: allOf: - $ref: '#/components/schemas/OrderEnum' default: asc name: order in: query - description: The number of items (0 .. 100) to return in a single page of the response. The response may contain fewer items if it is the last or only page. required: false schema: type: integer maximum: 100.0 minimum: 1.0 default: 100 name: limit in: query - description: 'A pagination token obtained from a previous call to this endpoint. Use it to get the next or previous page of results for your initial query. If `pagination_token` is specified, all other query parameters are ignored and inferred from the initial query. If not specified, the first page of results will be returned.' required: false schema: type: string name: pagination_token in: query - description: The field to sort the results by. Typically used together with the `order` parameter. required: false schema: allOf: - $ref: '#/components/schemas/PayableCursorFields' name: sort in: query - description: Return only payables created in Monite after the specified date and time. The value must be in the ISO 8601 format YYYY-MM-DDThh:mm[:ss[.ffffff]][Z|±hh:mm]. required: false schema: type: string format: date-time name: created_at__gt in: query - description: Return only payables created in Monite before the specified date and time. required: false schema: type: string format: date-time name: created_at__lt in: query - description: Return only payables created in Monite on or after the specified date and time. required: false schema: type: string format: date-time name: created_at__gte in: query - description: Return only payables created in Monite before or on the specified date and time. required: false schema: type: string format: date-time name: created_at__lte in: query - description: 'Return only payables that have the specified [status](https://docs.monite.com/accounts-payable/payables/index). To query multiple statuses at once, use the `status__in` parameter instead.' required: false schema: allOf: - $ref: '#/components/schemas/PayableStateEnum' name: status in: query - description: 'Return only payables that have the specified [statuses](https://docs.monite.com/accounts-payable/payables/index). To specify multiple statuses, repeat this parameter for each value: `status__in=draft&status__in=new`' required: false schema: items: $ref: '#/components/schemas/PayableStateEnum' type: array name: status__in in: query - description: 'Return only payables with specified IDs. Valid but nonexistent IDs do not raise errors but produce no results. To specify multiple IDs, repeat this parameter for each value: `id__in=&id__in=`' required: false schema: items: type: string format: uuid type: array name: id__in in: query - description: Return only payables with the exact specified total amount. The amount must be specified in the minor units of currency. For example, $12.5 is represented as 1250. required: false schema: type: integer name: total_amount in: query - description: Return only payables whose total amount (in minor units) exceeds the specified value. required: false schema: type: integer name: total_amount__gt in: query - description: Return only payables whose total amount (in minor units) is less than the specified value. required: false schema: type: integer name: total_amount__lt in: query - description: Return only payables whose total amount (in minor units) is greater than or equal to the specified value. required: false schema: type: integer name: total_amount__gte in: query - description: Return only payables whose total amount (in minor units) is less than or equal to the specified value. required: false schema: type: integer name: total_amount__lte in: query - description: Return only payables with the specified amount. required: false schema: type: integer name: amount in: query - description: Return only payables whose amount (in minor units) exceeds the specified value. required: false schema: type: integer name: amount__gt in: query - description: Return only payables whose amount (in minor units) is less than the specified value. required: false schema: type: integer name: amount__lt in: query - description: Return only payables whose amount (in minor units) is greater than or equal to the specified value. required: false schema: type: integer name: amount__gte in: query - description: Return only payables whose amount (in minor units) is less than or equal to the specified value. required: false schema: type: integer name: amount__lte in: query - description: Return only payables that use the specified currency. required: false schema: allOf: - $ref: '#/components/schemas/CurrencyEnum' name: currency in: query - description: 'Return only payables received from counterparts with the specified name (exact match, case-sensitive). For counterparts of `type = individual`, the full name is formatted as `first_name last_name`.' required: false schema: type: string name: counterpart_name in: query - description: Return payables that are due on the specified date (YYYY-MM-DD) required: false schema: type: string format: date-time name: due_date in: query - description: Return payables that are due after the specified date (exclusive, YYYY-MM-DD). required: false schema: type: string format: date-time name: due_date__gt in: query - description: Return payables that are due before the specified date (exclusive, YYYY-MM-DD). required: false schema: type: string format: date-time name: due_date__lt in: query - description: Return payables that are due on or after the specified date (YYYY-MM-DD). required: false schema: type: string format: date-time name: due_date__gte in: query - description: Return payables that are due before or on the specified date (YYYY-MM-DD). required: false schema: type: string format: date-time name: due_date__lte in: query - description: Return payables that are issued at the specified date (YYYY-MM-DD) required: false schema: type: string format: date name: issued_at in: query - description: Return payables that are issued after the specified date (exclusive, YYYY-MM-DD). required: false schema: type: string format: date name: issued_at__gt in: query - description: Return payables that are issued before the specified date (exclusive, YYYY-MM-DD). required: false schema: type: string format: date name: issued_at__lt in: query - description: Return payables that are issued on or after the specified date (YYYY-MM-DD). required: false schema: type: string format: date name: issued_at__gte in: query - description: Return payables that are issued before or on the specified date (YYYY-MM-DD). required: false schema: type: string format: date name: issued_at__lte in: query - description: 'Return a payable with the exact specified document number (case-sensitive). The `document_id` is the user-facing document number such as INV-00042, not to be confused with Monite resource IDs (`id`).' required: false schema: type: string name: document_id in: query - description: Return only payables whose document number (`document_id`) contains the specified string (case-sensitive). required: false schema: type: string name: document_id__contains in: query - description: Return only payables whose document number (`document_id`) contains the specified string (case-insensitive). required: false schema: type: string name: document_id__icontains in: query - description: Return only payables created in Monite by the entity user with the specified ID. required: false schema: type: string format: uuid name: was_created_by_user_id in: query - description: 'Return only payables received from the counterpart with the specified ID. Counterparts that have been deleted but have associated payables will still return results here because the payables contain a frozen copy of the counterpart data. If the specified counterpart ID does not exist and never existed, no results are returned.' required: false schema: type: string format: uuid name: counterpart_id in: query - description: Return only payables coming from the specified source. required: false schema: allOf: - $ref: '#/components/schemas/SourceOfPayableDataEnum' name: source_of_payable_data in: query - description: Return only payables with specific OCR statuses. required: false schema: allOf: - $ref: '#/components/schemas/OcrStatusEnum' name: ocr_status in: query - description: Search for a payable by the identifier of the line item associated with it. required: false schema: type: string format: uuid name: line_item_id in: query - description: Search for a payable by the identifier of the purchase order associated with it. required: false schema: type: string format: uuid name: purchase_order_id in: query - description: 'Return only payables assigned to the project with the specified ID. Valid but nonexistent project IDs do not raise errors but return no results.' required: false schema: type: string format: uuid name: project_id in: query - description: The ID of the entity that owns the requested resource. required: true schema: type: string format: uuid examples: - 9d2b4c8f-2087-4738-ba91-7359683c49a4 name: x-monite-entity-id in: header responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/PayablePaginationResponse' '405': description: Method Not Allowed content: application/json: schema: $ref: '#/components/schemas/ErrorSchemaResponse2' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/ErrorSchemaResponse2' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ErrorSchemaResponse2' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ErrorSchemaResponse2' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/ErrorSchemaResponse2' '406': description: Not Acceptable content: application/json: schema: $ref: '#/components/schemas/ErrorSchemaResponse2' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - HTTPBearer: [] post: tags: - Payables summary: Create a payable description: 'Add a new payable by providing the amount, currency, vendor name, and other details. You can provide the base64_encoded contents of the original invoice file in the field `base64_encoded_file`. You can use this endpoint to bypass the Monite OCR service and provide the data directly (for example, if you already have the data in place). A newly created payable has the the `draft` status.' operationId: post_payables parameters: - required: true schema: type: string format: date example: '2023-09-01' name: x-monite-version in: header - description: The ID of the entity that owns the requested resource. required: true schema: type: string format: uuid examples: - 9d2b4c8f-2087-4738-ba91-7359683c49a4 name: x-monite-entity-id in: header requestBody: content: application/json: schema: $ref: '#/components/schemas/PayableUploadWithDataSchema' required: true responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/PayableResponseSchema' '405': description: Method Not Allowed content: application/json: schema: $ref: '#/components/schemas/ErrorSchemaResponse2' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/ErrorSchemaResponse2' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ErrorSchemaResponse2' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ErrorSchemaResponse2' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/ErrorSchemaResponse2' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - HTTPBearer: [] servers: - url: https://api.dev.monite.com/v1 description: Development environment - url: https://api.sandbox.monite.com/v1 description: Sandbox environment - url: https://api.monite.com/v1 description: Production environment (Europe) - url: https://us.api.monite.com/v1 description: Production environment (North America) - url: https://api.monite.oaknorth.co.uk/v1 description: Oak POC environment /payables/analytics: get: tags: - Payables summary: Get payables analytics description: 'Retrieve aggregated statistics for payables, including total amount and count, both overall and by status. For more flexible configuration and retrieval of other data types, use `GET /analytics/payables`.' operationId: get_payables_analytics parameters: - required: true schema: type: string format: date example: '2023-09-01' name: x-monite-version in: header - description: Return only payables created in Monite after the specified date and time. The value must be in the ISO 8601 format YYYY-MM-DDThh:mm[:ss[.ffffff]][Z|±hh:mm]. required: false schema: type: string format: date-time name: created_at__gt in: query - description: Return only payables created in Monite before the specified date and time. required: false schema: type: string format: date-time name: created_at__lt in: query - description: Return only payables created in Monite on or after the specified date and time. required: false schema: type: string format: date-time name: created_at__gte in: query - description: Return only payables created in Monite before or on the specified date and time. required: false schema: type: string format: date-time name: created_at__lte in: query - description: 'Return only payables that have the specified [status](https://docs.monite.com/accounts-payable/payables/index). To query multiple statuses at once, use the `status__in` parameter instead.' required: false schema: allOf: - $ref: '#/components/schemas/PayableStateEnum' name: status in: query - description: 'Return only payables that have the specified [statuses](https://docs.monite.com/accounts-payable/payables/index). To specify multiple statuses, repeat this parameter for each value: `status__in=draft&status__in=new`' required: false schema: items: $ref: '#/components/schemas/PayableStateEnum' type: array name: status__in in: query - description: 'Return only payables with specified IDs. Valid but nonexistent IDs do not raise errors but produce no results. To specify multiple IDs, repeat this parameter for each value: `id__in=&id__in=`' required: false schema: items: type: string format: uuid type: array name: id__in in: query - description: Return only payables with the exact specified total amount. The amount must be specified in the minor units of currency. For example, $12.5 is represented as 1250. required: false schema: type: integer name: total_amount in: query - description: Return only payables whose total amount (in minor units) exceeds the specified value. required: false schema: type: integer name: total_amount__gt in: query - description: Return only payables whose total amount (in minor units) is less than the specified value. required: false schema: type: integer name: total_amount__lt in: query - description: Return only payables whose total amount (in minor units) is greater than or equal to the specified value. required: false schema: type: integer name: total_amount__gte in: query - description: Return only payables whose total amount (in minor units) is less than or equal to the specified value. required: false schema: type: integer name: total_amount__lte in: query - description: Return only payables with the specified amount. required: false schema: type: integer name: amount in: query - description: Return only payables whose amount (in minor units) exceeds the specified value. required: false schema: type: integer name: amount__gt in: query - description: Return only payables whose amount (in minor units) is less than the specified value. required: false schema: type: integer name: amount__lt in: query - description: Return only payables whose amount (in minor units) is greater than or equal to the specified value. required: false schema: type: integer name: amount__gte in: query - description: Return only payables whose amount (in minor units) is less than or equal to the specified value. required: false schema: type: integer name: amount__lte in: query - description: Return only payables that use the specified currency. required: false schema: allOf: - $ref: '#/components/schemas/CurrencyEnum' name: currency in: query - description: 'Return only payables received from counterparts with the specified name (exact match, case-sensitive). For counterparts of `type = individual`, the full name is formatted as `first_name last_name`.' required: false schema: type: string name: counterpart_name in: query - description: Return only payables received from counterparts whose name contains the specified string (case-sensitive). required: false schema: type: string name: counterpart_name__contains in: query - description: Return only payables received from counterparts whose name contains the specified string (case-insensitive). required: false schema: type: string name: counterpart_name__icontains in: query - description: Apply the `icontains` condition to search for the specified text in the `document_id` and `counterpart_name` fields in the payables. required: false schema: type: string name: search_text in: query - description: Return payables that are due on the specified date (YYYY-MM-DD) required: false schema: type: string format: date name: due_date in: query - description: Return payables that are due after the specified date (exclusive, YYYY-MM-DD). required: false schema: type: string format: date name: due_date__gt in: query - description: Return payables that are due before the specified date (exclusive, YYYY-MM-DD). required: false schema: type: string format: date name: due_date__lt in: query - description: Return payables that are due on or after the specified date (YYYY-MM-DD). required: false schema: type: string format: date name: due_date__gte in: query - description: Return payables that are due before or on the specified date (YYYY-MM-DD). required: false schema: type: string format: date name: due_date__lte in: query - description: Return payables that are issued at the specified date (YYYY-MM-DD) required: false schema: type: string format: date name: issued_at in: query - description: Return payables that are issued after the specified date (exclusive, YYYY-MM-DD). required: false schema: type: string format: date name: issued_at__gt in: query - description: Return payables that are issued before the specified date (exclusive, YYYY-MM-DD). required: false schema: type: string format: date name: issued_at__lt in: query - description: Return payables that are issued on or after the specified date (YYYY-MM-DD). required: false schema: type: string format: date name: issued_at__gte in: query - description: Return payables that are issued before or on the specified date (YYYY-MM-DD). required: false schema: type: string format: date name: issued_at__lte in: query - description: 'Return a payable with the exact specified document number (case-sensitive). The `document_id` is the user-facing document number such as INV-00042, not to be confused with Monite resource IDs (`id`).' required: false schema: type: string name: document_id in: query - description: Return only payables whose document number (`document_id`) contains the specified string (case-sensitive). required: false schema: type: string name: document_id__contains in: query - description: Return only payables whose document number (`document_id`) contains the specified string (case-insensitive). required: false schema: type: string name: document_id__icontains in: query - description: Return only payables created in Monite by the entity user with the specified ID. required: false schema: type: string format: uuid name: was_created_by_user_id in: query - description: 'Return only payables received from the counterpart with the specified ID. Counterparts that have been deleted but have associated payables will still return results here because the payables contain a frozen copy of the counterpart data. If the specified counterpart ID does not exist and never existed, no results are returned.' required: false schema: type: string format: uuid name: counterpart_id in: query - description: Return only payables coming from the specified source. required: false schema: allOf: - $ref: '#/components/schemas/SourceOfPayableDataEnum' name: source_of_payable_data in: query - description: Return only payables with specific OCR statuses. required: false schema: allOf: - $ref: '#/components/schemas/OcrStatusEnum' name: ocr_status in: query - description: Search for a payable by the identifier of the line item associated with it. required: false schema: type: string format: uuid name: line_item_id in: query - description: Search for a payable by the identifier of the purchase order associated with it. required: false schema: type: string format: uuid name: purchase_order_id in: query - description: 'Return only payables assigned to the project with the specified ID. Valid but nonexistent project IDs do not raise errors but return no results.' required: false schema: type: string format: uuid name: project_id in: query - description: Return only payables whose `project_id` include at least one of the project_id with the specified IDs. Valid but nonexistent project IDs do not raise errors but produce no results. required: false schema: items: type: string format: uuid type: array name: project_id__in in: query - description: Return only payables whose `tags` include at least one of the tags with the specified IDs. Valid but nonexistent tag IDs do not raise errors but produce no results. required: false schema: items: type: string format: uuid type: array name: tag_ids in: query - description: Return only payables whose `tags` do not include any of the tags with the specified IDs. Valid but nonexistent tag IDs do not raise errors but produce the results. required: false schema: items: type: string format: uuid type: array name: tag_ids__not_in in: query - description: Filter objects based on whether they have tags. If true, only objects with tags are returned. If false, only objects without tags are returned. required: false schema: type: boolean name: has_tags in: query - description: Return only payables from a given origin ['einvoice', 'upload', 'email'] required: false schema: allOf: - $ref: '#/components/schemas/PayableOriginEnum' name: origin in: query - description: Return only payables with or without attachments (files) required: false schema: type: boolean name: has_file in: query - description: The ID of the entity that owns the requested resource. required: true schema: type: string format: uuid examples: - 9d2b4c8f-2087-4738-ba91-7359683c49a4 name: x-monite-entity-id in: header responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/PayableAggregatedDataResponse' '405': description: Method Not Allowed content: application/json: schema: $ref: '#/components/schemas/ErrorSchemaResponse2' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/ErrorSchemaResponse2' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ErrorSchemaResponse2' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/ErrorSchemaResponse2' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' deprecated: true security: - HTTPBearer: [] servers: - url: https://api.dev.monite.com/v1 description: Development environment - url: https://api.sandbox.monite.com/v1 description: Sandbox environment - url: https://api.monite.com/v1 description: Production environment (Europe) - url: https://us.api.monite.com/v1 description: Production environment (North America) - url: https://api.monite.oaknorth.co.uk/v1 description: Oak POC environment /payables/upload_from_file: post: tags: - Payables summary: Upload a payable from a file description: Upload an incoming invoice (payable) in PDF, PNG, or JPEG format and scan its contents. The maximum file size is 20MB. operationId: post_payables_upload_from_file parameters: - required: true schema: type: string format: date example: '2023-09-01' name: x-monite-version in: header - description: The ID of the entity that owns the requested resource. required: true schema: type: string format: uuid examples: - 9d2b4c8f-2087-4738-ba91-7359683c49a4 name: x-monite-entity-id in: header requestBody: content: multipart/form-data: schema: $ref: '#/components/schemas/PayableUploadFile' required: true responses: '201': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/PayableResponseSchema' '405': description: Method Not Allowed content: application/json: schema: $ref: '#/components/schemas/ErrorSchemaResponse2' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/ErrorSchemaResponse2' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ErrorSchemaResponse2' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ErrorSchemaResponse2' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/ErrorSchemaResponse2' '409': description: "Error uploading the file. You can check the upload\n [limitations in the documentation](https://docs.monite.com/accounts-payable/payables/collect#about-monite-ocr)." content: application/json: schema: $ref: '#/components/schemas/ErrorSchemaResponse2' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - HTTPBearer: [] servers: - url: https://api.dev.monite.com/v1 description: Development environment - url: https://api.sandbox.monite.com/v1 description: Sandbox environment - url: https://api.monite.com/v1 description: Production environment (Europe) - url: https://us.api.monite.com/v1 description: Production environment (North America) - url: https://api.monite.oaknorth.co.uk/v1 description: Oak POC environment /payables/validations: get: tags: - Payables summary: Get payables validations description: Get payable validations. operationId: get_payables_validations parameters: - required: true schema: type: string format: date example: '2023-09-01' name: x-monite-version in: header responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/PayableValidationsResource' '405': description: Method Not Allowed content: application/json: schema: $ref: '#/components/schemas/ErrorSchemaResponse2' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/ErrorSchemaResponse2' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ErrorSchemaResponse2' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ErrorSchemaResponse2' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/ErrorSchemaResponse2' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - HTTPBearer: [] put: tags: - Payables summary: Update payables validations description: Update payable validations. operationId: put_payables_validations parameters: - required: true schema: type: string format: date example: '2023-09-01' name: x-monite-version in: header requestBody: content: application/json: schema: $ref: '#/components/schemas/PayableValidationsUpdateRequest' required: true responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/PayableValidationsResource' '405': description: Method Not Allowed content: application/json: schema: $ref: '#/components/schemas/ErrorSchemaResponse2' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/ErrorSchemaResponse2' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ErrorSchemaResponse2' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ErrorSchemaResponse2' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/ErrorSchemaResponse2' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - HTTPBearer: [] servers: - url: https://api.dev.monite.com/v1 description: Development environment - url: https://api.sandbox.monite.com/v1 description: Sandbox environment - url: https://api.monite.com/v1 description: Production environment (Europe) - url: https://us.api.monite.com/v1 description: Production environment (North America) - url: https://api.monite.oaknorth.co.uk/v1 description: Oak POC environment /payables/validations/reset: post: tags: - Payables summary: Reset payables validations description: Reset payable validations to default ones. operationId: post_payables_validations_reset parameters: - required: true schema: type: string format: date example: '2023-09-01' name: x-monite-version in: header responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/PayableValidationsResource' '405': description: Method Not Allowed content: application/json: schema: $ref: '#/components/schemas/ErrorSchemaResponse2' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/ErrorSchemaResponse2' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ErrorSchemaResponse2' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ErrorSchemaResponse2' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/ErrorSchemaResponse2' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - HTTPBearer: [] servers: - url: https://api.dev.monite.com/v1 description: Development environment - url: https://api.sandbox.monite.com/v1 description: Sandbox environment - url: https://api.monite.com/v1 description: Production environment (Europe) - url: https://us.api.monite.com/v1 description: Production environment (North America) - url: https://api.monite.oaknorth.co.uk/v1 description: Oak POC environment /payables/variables: get: tags: - Payables summary: Get the available variables for payable email templates description: Get a list of placeholders allowed to insert into an email template for customization operationId: get_payables_variables parameters: - required: true schema: type: string format: date example: '2023-09-01' name: x-monite-version in: header - description: The ID of the entity that owns the requested resource. required: true schema: type: string format: uuid examples: - 9d2b4c8f-2087-4738-ba91-7359683c49a4 name: x-monite-entity-id in: header responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/PayableTemplatesVariablesObjectList' '405': description: Method Not Allowed content: application/json: schema: $ref: '#/components/schemas/ErrorSchemaResponse2' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/ErrorSchemaResponse2' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/ErrorSchemaResponse2' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - HTTPBearer: [] servers: - url: https://api.dev.monite.com/v1 description: Development environment - url: https://api.sandbox.monite.com/v1 description: Sandbox environment - url: https://api.monite.com/v1 description: Production environment (Europe) - url: https://us.api.monite.com/v1 description: Production environment (North America) - url: https://api.monite.oaknorth.co.uk/v1 description: Oak POC environment /payables/{payable_id}: get: tags: - Payables summary: Get a payable by ID description: Retrieves information about a specific payable with the given ID. operationId: get_payables_id parameters: - required: true schema: type: string format: date example: '2023-09-01' name: x-monite-version in: header - required: true schema: type: string format: uuid name: payable_id in: path - description: The ID of the entity that owns the requested resource. required: true schema: type: string format: uuid examples: - 9d2b4c8f-2087-4738-ba91-7359683c49a4 name: x-monite-entity-id in: header responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/PayableResponseSchema' '405': description: Method Not Allowed content: application/json: schema: $ref: '#/components/schemas/ErrorSchemaResponse2' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/ErrorSchemaResponse2' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ErrorSchemaResponse2' '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/ErrorSchemaResponse2' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/ErrorSchemaResponse2' '409': description: 'Possible responses: `Action for {object_type} at permissions not found: {action}`, `Object type at permissions not found: {object_type}`, `Action {action} for {object_type} not allowed`, `Payable couldn''t be updated due to current state`, `The file cannot be attached because another file is already attached. Please note that only one file attachment is allowed.`' content: application/json: schema: $ref: '#/components/schemas/ErrorSchemaResponse2' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - HTTPBearer: [] patch: tags: - Payables summary: Update a payable description: Updates the information about a specific payable. operationId: patch_payables_id parameters: - required: true schema: type: string format: date example: '2023-09-01' name: x-monite-version in: header - required: true schema: type: string format: uuid name: payable_id in: path - description: The ID of the entity that owns the requested resource. required: true schema: type: string format: uuid examples: - 9d2b4c8f-2087-4738-ba91-7359683c49a4 name: x-monite-entity-id in: header requestBody: content: application/json: schema: $ref: '#/components/schemas/PayableUpdateSchema' required: true responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/PayableResponseSchema' '405': description: Method Not Allowed content: application/json: schema: $ref: '#/components/schemas/ErrorSchemaResponse2' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/ErrorSchemaResponse2' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ErrorSchemaResponse2' '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/ErrorSchemaResponse2' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/ErrorSchemaResponse2' '409': description: 'Possible responses: `Action for {object_type} at permissions not found: {action}`, `Object type at permissions not found: {object_type}`, `Action {action} for {object_type} not allowed`, `Payable couldn''t be updated due to current state`, `The file cannot be attached because another file is already attached. Please note that only one file attachment is allowed.`' content: application/json: schema: $ref: '#/components/schemas/ErrorSchemaResponse2' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - HTTPBearer: [] delete: tags: - Payables summary: Delete a payable description: Deletes a specific payable. operationId: delete_payables_id parameters: - required: true schema: type: string format: date example: '2023-09-01' name: x-monite-version in: header - required: true schema: type: string format: uuid name: payable_id in: path - description: The ID of the entity that owns the requested resource. required: true schema: type: string format: uuid examples: - 9d2b4c8f-2087-4738-ba91-7359683c49a4 name: x-monite-entity-id in: header responses: '204': description: Successful Response '405': description: Method Not Allowed content: application/json: schema: $ref: '#/components/schemas/ErrorSchemaResponse2' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/ErrorSchemaResponse2' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ErrorSchemaResponse2' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/ErrorSchemaResponse2' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/ErrorSchemaResponse2' '409': description: Business logic error content: application/json: schema: $ref: '#/components/schemas/ErrorSchemaResponse2' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - HTTPBearer: [] servers: - url: https://api.dev.monite.com/v1 description: Development environment - url: https://api.sandbox.monite.com/v1 description: Sandbox environment - url: https://api.monite.com/v1 description: Production environment (Europe) - url: https://us.api.monite.com/v1 description: Production environment (North America) - url: https://api.monite.oaknorth.co.uk/v1 description: Oak POC environment /payables/{payable_id}/approve_payment_operation: post: tags: - Payables summary: Approve a payable for payment description: Confirms that the payable is ready to be paid. operationId: post_payables_id_approve_payment_operation parameters: - required: true schema: type: string format: date example: '2023-09-01' name: x-monite-version in: header - required: true schema: type: string format: uuid name: payable_id in: path - description: The ID of the entity that owns the requested resource. required: true schema: type: string format: uuid examples: - 9d2b4c8f-2087-4738-ba91-7359683c49a4 name: x-monite-entity-id in: header responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/PayableResponseSchema' '405': description: Method Not Allowed content: application/json: schema: $ref: '#/components/schemas/ErrorSchemaResponse2' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/ErrorSchemaResponse2' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ErrorSchemaResponse2' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ErrorSchemaResponse2' '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/ErrorSchemaResponse2' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/ErrorSchemaResponse2' '409': description: 'Possible responses: `Action for {object_type} at permissions not found: {action}`, `Object type at permissions not found: {object_type}`, `Action {action} for {object_type} not allowed`, `Payable couldn''t be updated due to current state`, `The file cannot be attached because another file is already attached. Please note that only one file attachment is allowed.`' content: application/json: schema: $ref: '#/components/schemas/ErrorSchemaResponse2' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - HTTPBearer: [] servers: - url: https://api.dev.monite.com/v1 description: Development environment - url: https://api.sandbox.monite.com/v1 description: Sandbox environment - url: https://api.monite.com/v1 description: Production environment (Europe) - url: https://us.api.monite.com/v1 description: Production environment (North America) - url: https://api.monite.oaknorth.co.uk/v1 description: Oak POC environment /payables/{payable_id}/attach_file: post: tags: - Payables summary: Attach a file to a payable description: Attach file to payable without existing attachment. operationId: post_payables_id_attach_file parameters: - required: true schema: type: string format: date example: '2023-09-01' name: x-monite-version in: header - required: true schema: type: string format: uuid name: payable_id in: path - description: The ID of the entity that owns the requested resource. required: true schema: type: string format: uuid examples: - 9d2b4c8f-2087-4738-ba91-7359683c49a4 name: x-monite-entity-id in: header requestBody: content: multipart/form-data: schema: $ref: '#/components/schemas/PayableAttachFile' required: true responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/PayableResponseSchema' '405': description: Method Not Allowed content: application/json: schema: $ref: '#/components/schemas/ErrorSchemaResponse2' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/ErrorSchemaResponse2' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ErrorSchemaResponse2' '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/ErrorSchemaResponse2' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/ErrorSchemaResponse2' '409': description: 'Possible responses: `Action for {object_type} at permissions not found: {action}`, `Object type at permissions not found: {object_type}`, `Action {action} for {object_type} not allowed`, `Payable couldn''t be updated due to current state`, `The file cannot be attached because another file is already attached. Please note that only one file attachment is allowed.`' content: application/json: schema: $ref: '#/components/schemas/ErrorSchemaResponse2' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - HTTPBearer: [] servers: - url: https://api.dev.monite.com/v1 description: Development environment - url: https://api.sandbox.monite.com/v1 description: Sandbox environment - url: https://api.monite.com/v1 description: Production environment (Europe) - url: https://us.api.monite.com/v1 description: Production environment (North America) - url: https://api.monite.oaknorth.co.uk/v1 description: Oak POC environment /payables/{payable_id}/cancel: post: tags: - Payables summary: Cancel a payable description: Cancels the payable that was not confirmed during the review. operationId: post_payables_id_cancel parameters: - required: true schema: type: string format: date example: '2023-09-01' name: x-monite-version in: header - required: true schema: type: string format: uuid name: payable_id in: path - description: The ID of the entity that owns the requested resource. required: true schema: type: string format: uuid examples: - 9d2b4c8f-2087-4738-ba91-7359683c49a4 name: x-monite-entity-id in: header responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/PayableResponseSchema' '405': description: Method Not Allowed content: application/json: schema: $ref: '#/components/schemas/ErrorSchemaResponse2' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/ErrorSchemaResponse2' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ErrorSchemaResponse2' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ErrorSchemaResponse2' '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/ErrorSchemaResponse2' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/ErrorSchemaResponse2' '409': description: 'Possible responses: `Action for {object_type} at permissions not found: {action}`, `Object type at permissions not found: {object_type}`, `Action {action} for {object_type} not allowed`, `Payable couldn''t be updated due to current state`, `The file cannot be attached because another file is already attached. Please note that only one file attachment is allowed.`' content: application/json: schema: $ref: '#/components/schemas/ErrorSchemaResponse2' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - HTTPBearer: [] servers: - url: https://api.dev.monite.com/v1 description: Development environment - url: https://api.sandbox.monite.com/v1 description: Sandbox environment - url: https://api.monite.com/v1 description: Production environment (Europe) - url: https://us.api.monite.com/v1 description: Production environment (North America) - url: https://api.monite.oaknorth.co.uk/v1 description: Oak POC environment /payables/{payable_id}/history: get: tags: - Payables summary: Returns the history of the specified accounts payable document operationId: get_payables_id_history parameters: - required: true schema: type: string format: date example: '2023-09-01' name: x-monite-version in: header - required: true schema: type: string format: uuid name: payable_id in: path - description: Sort order (ascending by default). Typically used together with the `sort` parameter. required: false schema: allOf: - $ref: '#/components/schemas/OrderEnum' default: asc name: order in: query - description: The number of items (0 .. 100) to return in a single page of the response. The response may contain fewer items if it is the last or only page. required: false schema: type: integer maximum: 100.0 minimum: 1.0 default: 100 name: limit in: query - description: 'A pagination token obtained from a previous call to this endpoint. Use it to get the next or previous page of results for your initial query. If `pagination_token` is specified, all other query parameters are ignored and inferred from the initial query. If not specified, the first page of results will be returned.' required: false schema: type: string name: pagination_token in: query - description: The field to sort the results by. Typically used together with the `order` parameter. required: false schema: allOf: - $ref: '#/components/schemas/PayableHistoryCursorFields' name: sort in: query - description: Return only the specified event types required: false schema: items: $ref: '#/components/schemas/PayableHistoryEventTypeEnum' type: array name: event_type__in in: query - description: 'Return only events caused by the entity users with the specified IDs. To specify multiple user IDs, repeat this parameter for each ID: `entity_user_id__in=&entity_user_id__in=`' required: false schema: items: type: string format: uuid type: array name: entity_user_id__in in: query - description: Return only events that occurred after the specified date and time. The value must be in the ISO 8601 format `YYYY-MM-DDThh:mm[:ss[.ffffff]][Z|±hh:mm]`. required: false schema: type: string format: date-time name: timestamp__gt in: query - description: Return only events that occurred before the specified date and time. required: false schema: type: string format: date-time name: timestamp__lt in: query - description: Return only events that occurred on or after the specified date and time. required: false schema: type: string format: date-time name: timestamp__gte in: query - description: Return only events that occurred before or on the specified date and time. required: false schema: type: string format: date-time name: timestamp__lte in: query - description: The ID of the entity that owns the requested resource. required: true schema: type: string format: uuid examples: - 9d2b4c8f-2087-4738-ba91-7359683c49a4 name: x-monite-entity-id in: header responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/PayableHistoryPaginationResponse' '405': description: Method Not Allowed content: application/json: schema: $ref: '#/components/schemas/ErrorSchemaResponse2' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/ErrorSchemaResponse2' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ErrorSchemaResponse2' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ErrorSchemaResponse2' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/ErrorSchemaResponse2' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/ErrorSchemaResponse2' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - HTTPBearer: [] servers: - url: https://api.dev.monite.com/v1 description: Development environment - url: https://api.sandbox.monite.com/v1 description: Sandbox environment - url: https://api.monite.com/v1 description: Production environment (Europe) - url: https://us.api.monite.com/v1 description: Production environment (North America) - url: https://api.monite.oaknorth.co.uk/v1 description: Oak POC environment /payables/{payable_id}/mark_as_paid: post: tags: - Payables summary: Mark a payable as paid description: 'Mark a payable as paid. Payables can be paid using the payment channels offered by Monite or through external payment channels. In the latter case, the invoice is not automatically marked as paid in the system and needs to be converted to the paid status manually. Optionally, it is possible to pass the `comment` field in the request body, to describe how and when the invoice was paid. Notes: - To use this endpoint with an entity user token, this entity user must have a role that includes the `pay` permission for payables. - The `amount_to_pay` field is automatically calculated based on the `amount_due` less the percentage described in the `payment_terms.discount` value. Related guide: Mark a payable as paid See also: Payables lifecycle Payables status transitions' operationId: post_payables_id_mark_as_paid parameters: - required: true schema: type: string format: date example: '2023-09-01' name: x-monite-version in: header - required: true schema: type: string format: uuid name: payable_id in: path - description: The ID of the entity that owns the requested resource. required: true schema: type: string format: uuid examples: - 9d2b4c8f-2087-4738-ba91-7359683c49a4 name: x-monite-entity-id in: header requestBody: content: application/json: schema: $ref: '#/components/schemas/CommentPayload' responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/PayableResponseSchema' '405': description: Method Not Allowed content: application/json: schema: $ref: '#/components/schemas/ErrorSchemaResponse2' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/ErrorSchemaResponse2' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ErrorSchemaResponse2' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ErrorSchemaResponse2' '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/ErrorSchemaResponse2' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/ErrorSchemaResponse2' '409': description: 'Possible responses: `Action for {object_type} at permissions not found: {action}`, `Object type at permissions not found: {object_type}`, `Action {action} for {object_type} not allowed`, `Payable couldn''t be updated due to current state`, `The file cannot be attached because another file is already attached. Please note that only one file attachment is allowed.`' content: application/json: schema: $ref: '#/components/schemas/ErrorSchemaResponse2' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - HTTPBearer: [] servers: - url: https://api.dev.monite.com/v1 description: Development environment - url: https://api.sandbox.monite.com/v1 description: Sandbox environment - url: https://api.monite.com/v1 description: Production environment (Europe) - url: https://us.api.monite.com/v1 description: Production environment (North America) - url: https://api.monite.oaknorth.co.uk/v1 description: Oak POC environment /payables/{payable_id}/mark_as_partially_paid: post: tags: - Payables summary: Mark a payable as partially paid description: 'Mark a payable as partially paid. If the payable is partially paid, its status is moved to `partially_paid`. The value of the `amount_paid` field must be the sum of all payments made, not only the last one. Notes: - This endpoint can be used for payables in the `waiting_to_be_paid` status. - The `amount_paid` must be greater than 0 and less than the total payable amount specified by the `amount` field. - You can use this endpoint multiple times for the same payable to reflect multiple partial payments, always setting the sum of all payments made. - To use this endpoint with an entity user token, this entity user must have a role that includes the `pay` permission for payables. - The `amount_to_pay` field is automatically calculated based on the `amount_due` less the percentage described in the `payment_terms.discount` value. Related guide: Mark a payable as partially paid See also: Payables lifecycle Payables status transitions Mark a payable as paid' operationId: post_payables_id_mark_as_partially_paid parameters: - required: true schema: type: string format: date example: '2023-09-01' name: x-monite-version in: header - required: true schema: type: string format: uuid name: payable_id in: path - description: The ID of the entity that owns the requested resource. required: true schema: type: string format: uuid examples: - 9d2b4c8f-2087-4738-ba91-7359683c49a4 name: x-monite-entity-id in: header requestBody: content: application/json: schema: $ref: '#/components/schemas/PartiallyPaidPayload' required: true responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/PayableResponseSchema' '405': description: Method Not Allowed content: application/json: schema: $ref: '#/components/schemas/ErrorSchemaResponse2' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/ErrorSchemaResponse2' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ErrorSchemaResponse2' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ErrorSchemaResponse2' '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/ErrorSchemaResponse2' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/ErrorSchemaResponse2' '409': description: 'Possible responses: `Action for {object_type} at permissions not found: {action}`, `Object type at permissions not found: {object_type}`, `Action {action} for {object_type} not allowed`, `Payable couldn''t be updated due to current state`, `The file cannot be attached because another file is already attached. Please note that only one file attachment is allowed.`' content: application/json: schema: $ref: '#/components/schemas/ErrorSchemaResponse2' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - HTTPBearer: [] servers: - url: https://api.dev.monite.com/v1 description: Development environment - url: https://api.sandbox.monite.com/v1 description: Sandbox environment - url: https://api.monite.com/v1 description: Production environment (Europe) - url: https://us.api.monite.com/v1 description: Production environment (North America) - url: https://api.monite.oaknorth.co.uk/v1 description: Oak POC environment /payables/{payable_id}/reject: post: tags: - Payables summary: Reject a payable description: Declines the payable when an approver finds any mismatch or discrepancies. operationId: post_payables_id_reject parameters: - required: true schema: type: string format: date example: '2023-09-01' name: x-monite-version in: header - required: true schema: type: string format: uuid name: payable_id in: path - description: The ID of the entity that owns the requested resource. required: true schema: type: string format: uuid examples: - 9d2b4c8f-2087-4738-ba91-7359683c49a4 name: x-monite-entity-id in: header responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/PayableResponseSchema' '405': description: Method Not Allowed content: application/json: schema: $ref: '#/components/schemas/ErrorSchemaResponse2' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/ErrorSchemaResponse2' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ErrorSchemaResponse2' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ErrorSchemaResponse2' '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/ErrorSchemaResponse2' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/ErrorSchemaResponse2' '409': description: 'Possible responses: `Action for {object_type} at permissions not found: {action}`, `Object type at permissions not found: {object_type}`, `Action {action} for {object_type} not allowed`, `Payable couldn''t be updated due to current state`, `The file cannot be attached because another file is already attached. Please note that only one file attachment is allowed.`' content: application/json: schema: $ref: '#/components/schemas/ErrorSchemaResponse2' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - HTTPBearer: [] servers: - url: https://api.dev.monite.com/v1 description: Development environment - url: https://api.sandbox.monite.com/v1 description: Sandbox environment - url: https://api.monite.com/v1 description: Production environment (Europe) - url: https://us.api.monite.com/v1 description: Production environment (North America) - url: https://api.monite.oaknorth.co.uk/v1 description: Oak POC environment /payables/{payable_id}/reopen: post: tags: - Payables summary: Reopen a rejected or waiting_to_be_paid payable description: Reset payable state from rejected or waiting_to_be_paid to new. operationId: post_payables_id_reopen parameters: - required: true schema: type: string format: date example: '2023-09-01' name: x-monite-version in: header - required: true schema: type: string format: uuid name: payable_id in: path - description: The ID of the entity that owns the requested resource. required: true schema: type: string format: uuid examples: - 9d2b4c8f-2087-4738-ba91-7359683c49a4 name: x-monite-entity-id in: header responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/PayableResponseSchema' '405': description: Method Not Allowed content: application/json: schema: $ref: '#/components/schemas/ErrorSchemaResponse2' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/ErrorSchemaResponse2' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ErrorSchemaResponse2' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ErrorSchemaResponse2' '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/ErrorSchemaResponse2' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/ErrorSchemaResponse2' '409': description: 'Possible responses: `Action for {object_type} at permissions not found: {action}`, `Object type at permissions not found: {object_type}`, `Action {action} for {object_type} not allowed`, `Payable couldn''t be updated due to current state`, `The file cannot be attached because another file is already attached. Please note that only one file attachment is allowed.`' content: application/json: schema: $ref: '#/components/schemas/ErrorSchemaResponse2' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - HTTPBearer: [] servers: - url: https://api.dev.monite.com/v1 description: Development environment - url: https://api.sandbox.monite.com/v1 description: Sandbox environment - url: https://api.monite.com/v1 description: Production environment (Europe) - url: https://us.api.monite.com/v1 description: Production environment (North America) - url: https://api.monite.oaknorth.co.uk/v1 description: Oak POC environment /payables/{payable_id}/submit_for_approval: post: tags: - Payables summary: Submit a payable for approval description: Starts the approval process once the uploaded payable is validated. operationId: post_payables_id_submit_for_approval parameters: - required: true schema: type: string format: date example: '2023-09-01' name: x-monite-version in: header - required: true schema: type: string format: uuid name: payable_id in: path - description: The ID of the entity that owns the requested resource. required: true schema: type: string format: uuid examples: - 9d2b4c8f-2087-4738-ba91-7359683c49a4 name: x-monite-entity-id in: header responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/PayableResponseSchema' '405': description: Method Not Allowed content: application/json: schema: $ref: '#/components/schemas/ErrorSchemaResponse2' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/ErrorSchemaResponse2' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ErrorSchemaResponse2' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ErrorSchemaResponse2' '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/ErrorSchemaResponse2' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/ErrorSchemaResponse2' '409': description: 'Possible responses: `Action for {object_type} at permissions not found: {action}`, `Object type at permissions not found: {object_type}`, `Action {action} for {object_type} not allowed`, `Payable couldn''t be updated due to current state`, `The file cannot be attached because another file is already attached. Please note that only one file attachment is allowed.`' content: application/json: schema: $ref: '#/components/schemas/ErrorSchemaResponse2' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - HTTPBearer: [] servers: - url: https://api.dev.monite.com/v1 description: Development environment - url: https://api.sandbox.monite.com/v1 description: Sandbox environment - url: https://api.monite.com/v1 description: Production environment (Europe) - url: https://us.api.monite.com/v1 description: Production environment (North America) - url: https://api.monite.oaknorth.co.uk/v1 description: Oak POC environment /payables/{payable_id}/suggestions: get: tags: - Payables summary: Get suggestions description: Get AI suggestions operationId: get_payables_id_suggestions parameters: - required: true schema: type: string format: date example: '2023-09-01' name: x-monite-version in: header - required: true schema: type: string format: uuid name: payable_id in: path - description: The ID of the entity that owns the requested resource. required: true schema: type: string format: uuid examples: - 9d2b4c8f-2087-4738-ba91-7359683c49a4 name: x-monite-entity-id in: header responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/SuggestedResponse' '405': description: Method Not Allowed content: application/json: schema: $ref: '#/components/schemas/ErrorSchemaResponse2' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/ErrorSchemaResponse2' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ErrorSchemaResponse2' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ErrorSchemaResponse2' '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/ErrorSchemaResponse2' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - HTTPBearer: [] delete: tags: - Payables summary: Delete suggestions description: Remove AI suggestions operationId: delete_payables_id_suggestions parameters: - required: true schema: type: string format: date example: '2023-09-01' name: x-monite-version in: header - required: true schema: type: string format: uuid name: payable_id in: path - description: The ID of the entity that owns the requested resource. required: true schema: type: string format: uuid examples: - 9d2b4c8f-2087-4738-ba91-7359683c49a4 name: x-monite-entity-id in: header responses: '200': description: Successful Response content: application/json: schema: {} '405': description: Method Not Allowed content: application/json: schema: $ref: '#/components/schemas/ErrorSchemaResponse2' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/ErrorSchemaResponse2' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ErrorSchemaResponse2' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ErrorSchemaResponse2' '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/ErrorSchemaResponse2' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - HTTPBearer: [] servers: - url: https://api.dev.monite.com/v1 description: Development environment - url: https://api.sandbox.monite.com/v1 description: Sandbox environment - url: https://api.monite.com/v1 description: Production environment (Europe) - url: https://us.api.monite.com/v1 description: Production environment (North America) - url: https://api.monite.oaknorth.co.uk/v1 description: Oak POC environment /payables/{payable_id}/validate: post: tags: - Payables summary: Validate a payable description: Check the invoice for compliance with the requirements for movement from draft to new status. operationId: post_payables_id_validate parameters: - required: true schema: type: string format: date example: '2023-09-01' name: x-monite-version in: header - required: true schema: type: string format: uuid name: payable_id in: path - description: The ID of the entity that owns the requested resource. required: true schema: type: string format: uuid examples: - 9d2b4c8f-2087-4738-ba91-7359683c49a4 name: x-monite-entity-id in: header responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/PayableValidationResponse' '405': description: Method Not Allowed content: application/json: schema: $ref: '#/components/schemas/ErrorSchemaResponse2' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/ErrorSchemaResponse2' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ErrorSchemaResponse2' '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/ErrorSchemaResponse2' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/ErrorSchemaResponse2' '409': description: 'Possible responses: `Action for {object_type} at permissions not found: {action}`, `Object type at permissions not found: {object_type}`, `Action {action} for {object_type} not allowed`, `Payable couldn''t be updated due to current state`, `The file cannot be attached because another file is already attached. Please note that only one file attachment is allowed.`' content: application/json: schema: $ref: '#/components/schemas/ErrorSchemaResponse2' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - HTTPBearer: [] servers: - url: https://api.dev.monite.com/v1 description: Development environment - url: https://api.sandbox.monite.com/v1 description: Sandbox environment - url: https://api.monite.com/v1 description: Production environment (Europe) - url: https://us.api.monite.com/v1 description: Production environment (North America) - url: https://api.monite.oaknorth.co.uk/v1 description: Oak POC environment /payables/{payable_id}/cancel_ocr: post: tags: - Payables summary: Cancel OCR of a payable description: Request to cancel the OCR processing of the specified payable. operationId: post_payables_id_cancel_ocr parameters: - required: true schema: type: string format: date example: '2024-05-25' name: x-monite-version in: header - required: true schema: type: string format: uuid name: payable_id in: path - description: The ID of the entity that owns the requested resource. required: true schema: type: string format: uuid examples: - 9d2b4c8f-2087-4738-ba91-7359683c49a4 name: x-monite-entity-id in: header responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/PayableResponseSchema' '405': description: Method Not Allowed content: application/json: schema: $ref: '#/components/schemas/ErrorSchemaResponse2' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/ErrorSchemaResponse2' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ErrorSchemaResponse2' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ErrorSchemaResponse2' '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/ErrorSchemaResponse2' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/ErrorSchemaResponse2' '409': description: 'Possible responses: `Action for {object_type} at permissions not found: {action}`, `Object type at permissions not found: {object_type}`, `Action {action} for {object_type} not allowed`, `Payable couldn''t be updated due to current state`, `The file cannot be attached because another file is already attached. Please note that only one file attachment is allowed.`' content: application/json: schema: $ref: '#/components/schemas/ErrorSchemaResponse2' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - HTTPBearer: [] servers: - url: https://api.dev.monite.com/v1 description: Development environment - url: https://api.sandbox.monite.com/v1 description: Sandbox environment - url: https://api.monite.com/v1 description: Production environment (Europe) - url: https://us.api.monite.com/v1 description: Production environment (North America) - url: https://api.monite.oaknorth.co.uk/v1 description: Oak POC environment components: schemas: CurrencyExchangeSchema2: properties: default_currency_code: type: string rate: type: number exclusiveMinimum: 0.0 total: type: number additionalProperties: false type: object required: - default_currency_code - rate - total CounterpartRawBankAccountUpdateRequest: properties: account_holder_name: type: string description: Vendor's bank account name. account_number: type: string description: Vendor's bank account number, IBAN, or similar (if specified in the payable document). example: '123456789012' bic: type: string maxLength: 11 description: SWIFT code (BIC) of the vendor's bank. example: DEUTDE2HXXX iban: type: string maxLength: 34 description: required for non-GB bank accounts routing_number: type: string description: required for US bank accounts sort_code: type: string description: required for GB bank accounts additionalProperties: false type: object PayableUploadWithDataSchema: properties: base64_encoded_file: type: string description: "Base64-encoded contents of the original issued payable. The file is provided for reference purposes as the original source of the data.\n\n Any file formats are allowed. The most common formats are PDF, PNG, JPEG, TIFF." counterpart_address_id: type: string format: uuid description: The ID of counterpart address object stored in counterparts service counterpart_bank_account_id: type: string format: uuid description: The ID of counterpart bank account object stored in counterparts service counterpart_id: type: string format: uuid description: The ID of the counterpart object that represents the vendor or supplier. counterpart_vat_id_id: type: string format: uuid description: The ID of counterpart VAT ID object stored in counterparts service currency: allOf: - $ref: '#/components/schemas/CurrencyEnum' description: The [currency code](https://docs.monite.com/references/currencies) of the currency used in the payable. example: EUR description: type: string maxLength: 255 description: An arbitrary description of this payable. discount: type: integer description: The value of the additional discount that will be applied to the total amount. in [minor units](https://docs.monite.com/references/currencies#minor-units). For example, $12.50 is represented as 1250. example: 500 document_id: type: string description: A unique invoice number assigned by the invoice issuer for payment tracking purposes. example: DE2287 due_date: type: string format: date description: The date by which the payable must be paid, in the YYYY-MM-DD format. If the payable specifies payment terms with early payment discounts, this is the final payment date. enforce_approval_policy_id: type: string format: uuid description: Id of an existing approval policy that should be enforced when submitting the payable for approval.If this field is set, no other policies will be evaluated via their triggers - the specified policy will always be applied instead. file_name: type: string maxLength: 512 description: The original file name. example: invoice.pdf issued_at: type: string format: date description: The date when the payable was issued, in the YYYY-MM-DD format. partner_metadata: type: object description: Metadata for partner needs payment_terms: allOf: - $ref: '#/components/schemas/PayablePaymentTermsCreatePayload' description: The number of days to pay with potential discount for options shorter than due_date project_id: type: string format: uuid description: The ID of a project purchase_order_id: type: string format: uuid description: The identifier of the purchase order to which this payable belongs. sender: type: string format: email description: The email address from which the invoice was sent to the entity. example: hello@example.com subtotal: type: integer description: The subtotal amount to be paid, in [minor units](https://docs.monite.com/references/currencies#minor-units). For example, $12.50 is represented as 1250. example: 1250 suggested_payment_term: allOf: - $ref: '#/components/schemas/SuggestedPaymentTerm' description: The suggested date and corresponding discount in which payable could be paid. The date is in the YYYY-MM-DD format. The discount is calculated as X * (10^-4) - for example, 100 is 1%, 25 is 0,25%, 10000 is 100 %. Date varies depending on the payment terms and may even be equal to the due date with discount 0. tag_ids: items: type: string format: uuid type: array description: A list of IDs of user-defined tags (labels) assigned to this payable. Tags can be used to trigger a specific approval policy for this payable. tax: type: integer description: Registered tax percentage applied for a service price in minor units, e.g. 200 means 2%. 1050 means 10.5%. example: 2000 tax_amount: type: integer description: Tax amount in [minor units](https://docs.monite.com/references/currencies#minor-units). For example, $12.50 is represented as 1250. example: 250 total_amount: type: integer description: The total amount to be paid, in [minor units](https://docs.monite.com/references/currencies#minor-units). For example, $12.50 is represented as 1250. example: 15000 additionalProperties: false type: object description: This schema is used to create a new payable by providing its data along with the original file. ObjectType: type: string enum: - account - approval - approval_request - approval_policy - approval_policy_process - audit_trail - comment - counterpart - counterpart_address - counterpart_bank_account - counterpart_contact_person - counterpart_partner_metadata - counterpart_tax_id - counterpart_vat_id - delivery_note - einvoicing - entity - entity_bank_account - entity_settings - entity_token - entity_user - entity_user_token - entity_vat_ids - export - mailbox - monitescript_process - ocr_task - onboarding - overdue_reminder - partner - partner_internal_config - partner_settings - partner_token - payable - payable_line_item - payables_credit_note - payables_purchase_order - payment - payment_intent - payment_link - payment_record - payment_reminder - person - product - project - receivable - reconciliation - recurrence - role - tag - todo_task - todo_task_mute - transaction - webhook - workflow - workflow_pipeline PayableAggregatedItem: properties: count: type: integer description: The total count of payables with this specific status. status: allOf: - $ref: '#/components/schemas/PayableStateEnum' description: The status of the payable (e.g., paid, draft, etc.). sum_total_amount: type: integer description: The total sum of the amount field for all payables with this specific status. additionalProperties: false type: object required: - count - status - sum_total_amount PayableCreditNoteUnlinkedEventData: properties: credit_note_document_id: type: string credit_note_id: type: string additionalProperties: false type: object required: - credit_note_id TagCategory: type: string enum: - document_type - department - project - cost_center - vendor_type - payment_method - approval_status CounterpartRawDataUpdateRequest: properties: address: allOf: - $ref: '#/components/schemas/CounterpartRawAddressUpdateRequest' description: The address of the vendor or supplier. bank_account: allOf: - $ref: '#/components/schemas/CounterpartRawBankAccountUpdateRequest' description: Object representing counterpart bank account. email: type: string format: email description: The email address of the organization example: acme@example.com name: type: string description: Vendor or supplier name. example: Acme Inc. phone: type: string description: The phone number of the organization example: '5551231234' tax_id: type: string maxLength: 30 description: The tax id of the counterpart. example: DE12345678 vat_id: allOf: - $ref: '#/components/schemas/CounterpartRawVatIDUpdateRequest' description: VAT ID of the vendor or supplier which was used in the invoice. additionalProperties: false type: object PayablePaymentTermsCreatePayload: properties: description: type: string name: type: string term_1: $ref: '#/components/schemas/PayablePaymentTermDiscount' term_2: $ref: '#/components/schemas/PayablePaymentTermDiscount' term_final: $ref: '#/components/schemas/PayablePaymentTermFinal' additionalProperties: false type: object required: - name - term_final PayableCursorFields: type: string enum: - id - created_at - issued_at OCRResponseInvoiceReceiptData: properties: counterpart_account_id: type: string description: Counterpart bank ID example: DEUTDEFF counterpart_account_number: type: string description: The bank account number counterpart_address: type: string description: Counterpart address counterpart_address_object: allOf: - $ref: '#/components/schemas/OCRAddress' description: Counterpart address as a json object compatible with counterparts service counterpart_branch_number: type: string description: The bank branch number counterpart_email: type: string description: Email address of the counterpart counterpart_name: type: string description: Counterpart name example: Monite GMbH counterpart_routing_number: type: string description: The bank routing number counterpart_vat_id: type: string description: Counterpart VAT ID example: DE88939004 currency: type: string description: ISO 4217 currency code example: EUR discount_raw: type: number description: Discount Raw amount document_due_date: type: string description: Document due date in ISO format document_id: type: string description: Invoice/receipt ID example: CST-13341 document_issued_at_date: type: string description: Document issuance date in ISO format line_items_raw: items: $ref: '#/components/schemas/OCRResponseInvoiceReceiptLineItemRaw' type: array description: List of line items from document raw, without minor units conversion. payment_terms_raw: items: type: string type: array description: Raw payment terms parsed but not calculated. purchase_order_number: type: string description: Purchase Order Number example: '1234' tax_payer_id: type: string description: Tax payer ID example: '12345678901' total_excl_vat_raw: type: number description: Subtotal, without minor units example: 77 total_paid_amount_raw: type: number description: Total paid amount default: 0 example: 50 total_raw: type: number description: Total, without minor units example: 70 total_vat_amount_raw: type: number description: VAT amount, without minor units example: 7 total_vat_rate_raw: type: number description: VAT Percent raw, without minor units. example: 12.5 type: type: string enum: - invoice default: invoice type: object PayableValidationResponse: properties: id: type: string format: uuid description: A unique ID assigned to this payable. validation_errors: items: type: object type: array type: object required: - id PayableValidationsUpdateRequest: properties: required_fields: items: $ref: '#/components/schemas/PayablesFieldsAllowedForValidate' type: array additionalProperties: false type: object required: - required_fields PayableHistoryEventTypeEnum: type: string enum: - status_changed - payable_created - payable_updated - credit_note_linked - credit_note_unlinked - file_attached TagReadSchema: properties: id: type: string format: uuid description: A unique ID of this tag. example: ea837e28-509b-4b6a-a600-d54b6aa0b1f5 created_at: type: string format: date-time description: Date and time when the tag was created. Timestamps follow the [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) standard. example: '2022-09-07T16:35:18.484507+00:00' updated_at: type: string format: date-time description: Date and time when the tag was last updated. Timestamps follow the [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) standard. example: '2022-09-07T16:35:18.484507+00:00' category: allOf: - $ref: '#/components/schemas/TagCategory' description: The tag category. example: department created_by_entity_user_id: type: string format: uuid description: ID of the user who created the tag. example: ea837e28-509b-4b6a-a600-d54b6aa0b1f5 description: type: string maxLength: 255 minLength: 1 description: The tag description. example: Tag for the Marketing Department name: type: string description: The tag name. example: Marketing type: object required: - id - created_at - updated_at - name description: Represents a user-defined tag that can be assigned to resources to filter them. PayableTemplatesVariablesObject: properties: object_subtype: $ref: '#/components/schemas/PayablesVariableType' object_type: $ref: '#/components/schemas/ObjectType' variables: items: $ref: '#/components/schemas/PayableTemplatesVariable' type: array additionalProperties: false type: object required: - object_subtype - object_type - variables PayableCreditNoteLinkedEventData: properties: credit_note_document_id: type: string credit_note_id: type: string additionalProperties: false type: object required: - credit_note_id PayableResponseSchema: properties: id: type: string format: uuid description: A unique ID assigned to this payable. created_at: type: string format: date-time description: UTC date and time when this payable was created. Timestamps follow the [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. updated_at: type: string format: date-time description: UTC date and time when this payable was last updated. Timestamps follow the [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. amount_due: type: integer description: How much is left to be paid on the invoice (in minor units). example: 1000 amount_paid: type: integer description: How much was paid on the invoice (in minor units). example: 1000 amount_to_pay: type: integer description: How much is left to be paid on the invoice (in minor units) with discounts from payment terms. example: 1000 approval_policy_id: type: string format: uuid description: Id of existing approval policy that applies to this payable, if any. A policy is applied if the payable matches the policy trigger conditions. counterpart: allOf: - $ref: '#/components/schemas/CounterpartRawData' description: Object representing de-normalized counterpart data. Filled at the moment of invoice submitting for approval or payment. counterpart_address_id: type: string format: uuid description: The ID of counterpart address object stored in counterparts service counterpart_bank_account_id: type: string format: uuid description: The ID of counterpart bank account object stored in counterparts service counterpart_id: type: string format: uuid description: The ID of the counterpart object that represents the vendor or supplier. counterpart_raw_data: allOf: - $ref: '#/components/schemas/CounterpartRawData' description: Object representing counterpart data which was extracted by OCR. Used for informational purposes. counterpart_vat_id_id: type: string format: uuid description: The ID of counterpart VAT ID object stored in counterparts service created_by_role_id: type: string format: uuid description: The ID of the role that the entity user who created this payable had at that time. If the payable was created using a partner access token, the value is `null`. credit_notes: items: $ref: '#/components/schemas/PayableCreditNoteData' type: array description: The list of linked credit notes of the payable. currency: allOf: - $ref: '#/components/schemas/CurrencyEnum' description: The [currency code](https://docs.monite.com/references/currencies) of the currency used in the payable. example: EUR currency_exchange: $ref: '#/components/schemas/CurrencyExchangeSchema2' description: type: string description: An arbitrary description of this payable. discount: type: integer description: The value of the additional discount that will be applied to the total amount. in [minor units](https://docs.monite.com/references/currencies#minor-units). For example, $12.50 is represented as 1250. example: 500 document_id: type: string description: A unique invoice number assigned by the invoice issuer for payment tracking purposes. This is different from `id` which is an internal ID created automatically by Monite. example: DE2287 due_date: type: string format: date description: The date by which the payable must be paid, in the YYYY-MM-DD format. If the payable specifies payment terms with early payment discounts, this is the final payment date. einvoice_file_url: type: string description: The URL to download the original e-invoice file. example: https://bucketname.s3.amazonaws.com/12345/67890.xml enforce_approval_policy_id: type: string format: uuid description: Id of an existing approval policy that should be enforced when submitting the payable for approval.If this field is set, no other policies will be evaluated via their triggers - the specified policy will always be applied instead. entity_id: type: string format: uuid description: The ID of the entity to which the payable was issued. file: allOf: - $ref: '#/components/schemas/FileSchema' description: The original file from which this payable was created. file_id: type: string format: uuid description: File id to retrieve file info from file saver. issued_at: type: string format: date description: The date when the payable was issued, in the YYYY-MM-DD format. marked_as_paid_by_entity_user_id: type: string format: uuid description: The ID of the entity user who marked this document as paid. example: 71e8875a-43b3-434f-b12a-54c84c176ef3 marked_as_paid_with_comment: type: string description: An arbitrary comment that describes how and when this payable was paid. example: Was paid partly in the end of the month. ocr_request_id: type: string format: uuid description: Id of OCR request to match asynchronous result of processing payable. ocr_status: allOf: - $ref: '#/components/schemas/OcrStatusEnum' description: The status of the data recognition process using OCR. The 'processing' status means that the data recognition is in progress and the user needs to wait for the data enrichment. The 'error' status indicates that some error occurred on the OCR side and the user can fill in the data manually. The 'success' status means the data recognition has been successfully completed, after which the user can check the data if desired and enrich or correct it. other_extracted_data: anyOf: - $ref: '#/components/schemas/OCRResponseInvoiceReceiptData' - $ref: '#/components/schemas/OcrRecognitionResponse' description: Data extracted from the uploaded payable by OCR. paid_at: type: string format: date-time description: The date by which the payable was paid partner_metadata: type: object description: Metadata for partner needs payable_origin: allOf: - $ref: '#/components/schemas/PayableOriginEnum' description: 'Specifies how this payable was created in Monite: `upload` - created via an API call, `email` - sent via email to the entity''s mailbox.' payment_terms: allOf: - $ref: '#/components/schemas/PayablePaymentTermsCreatePayload' description: The number of days to pay with potential discount for options shorter than due_date project_id: type: string format: uuid description: Project id of a payable. purchase_order_id: type: string format: uuid description: The identifier of the purchase order to which this payable belongs. sender: type: string format: email description: The email address from which the invoice was sent to the entity. example: hello@example.com source_of_payable_data: allOf: - $ref: '#/components/schemas/SourceOfPayableDataEnum' description: 'Specifies how the property values of this payable were provided: `ocr` - Monite OCR service extracted the values from the provided PDF or image file, `user_specified` - values were added or updated via an API call.' status: allOf: - $ref: '#/components/schemas/PayableStateEnum' description: The [status](https://docs.monite.com/accounts-payable/payables/index) of the payable. subtotal: type: integer description: The subtotal amount to be paid, in [minor units](https://docs.monite.com/references/currencies#minor-units). For example, $12.50 is represented as 1250. example: 1250 suggested_payment_term: allOf: - $ref: '#/components/schemas/SuggestedPaymentTerm' description: The suggested date and corresponding discount in which payable could be paid. The date is in the YYYY-MM-DD format. The discount is calculated as X * (10^-4) - for example, 100 is 1%, 25 is 0,25%, 10000 is 100 %. Date varies depending on the payment terms and may even be equal to the due date with discount 0. tags: items: $ref: '#/components/schemas/TagReadSchema' type: array description: A list of user-defined tags (labels) assigned to this payable. Tags can be used to trigger a specific approval policy for this payable. tax: type: integer description: Registered tax percentage applied for a service price in minor units, e.g. 200 means 2%, 1050 means 10.5%. example: 2000 tax_amount: type: integer description: Tax amount in [minor units](https://docs.monite.com/references/currencies#minor-units). For example, $12.50 is represented as 1250. example: 250 total_amount: type: integer description: The total amount to be paid, in [minor units](https://docs.monite.com/references/currencies#minor-units). For example, $12.50 is represented as 1250. example: 1500 total_amount_with_credit_notes: type: integer description: The total price of the payable in [minor units](https://docs.monite.com/references/currencies#minor-units), excluding all issued credit notes. was_created_by_user_id: type: string format: uuid type: object required: - id - created_at - updated_at - credit_notes - entity_id - payable_origin - source_of_payable_data - status description: Represents an Accounts Payable document received from a vendor or supplier. PayableAggregatedDataResponse: properties: count: type: integer description: The total count of payables across all statuses. data: items: $ref: '#/components/schemas/PayableAggregatedItem' type: array description: A list of aggregated items, each representing a status with its associated sum of the amount field and count. sum_total_amount: type: integer description: The total sum of the amount field for all payables across all statuses. additionalProperties: false type: object required: - count - data - sum_total_amount PayableStatusChangedEventData: properties: new_status: $ref: '#/components/schemas/PayableStateEnum' old_status: $ref: '#/components/schemas/PayableStateEnum' additionalProperties: false type: object required: - new_status - old_status CounterpartRawAddress: properties: city: type: string description: City name. example: Berlin country: allOf: - $ref: '#/components/schemas/AllowedCountries' description: Two-letter ISO country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)). example: DE line1: type: string description: Street address. example: Flughafenstrasse 52 line2: type: string description: Additional address information (if any). postal_code: type: string description: ZIP or postal code. example: '10115' state: type: string description: State, region, province, or county. type: object description: Address information. PageSchema2: properties: id: type: string format: uuid description: A unique ID of the image. mimetype: type: string description: The [media type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types) of the image. example: image/png number: type: integer minimum: 0.0 description: The page number in the PDF document, from 0. example: 0 size: type: integer minimum: 0.0 description: Image file size, in bytes. example: 21972 url: type: string description: The URL to download the image. example: https://bucket.s3.amazonaws.com/123/456.png type: object required: - id - mimetype - size - number - url description: 'When a PDF document is uploaded to Monite, it extracts individual pages from the document and saves them as PNG images. This object contains the image and metadata of a single page.' OcrStatusEnum: type: string enum: - processing - error - success PayableUpdateSchema: properties: amount_paid: type: integer minimum: 0.0 description: How much was paid on the invoice (in minor units). counterpart_address_id: type: string format: uuid description: The ID of counterpart address object stored in counterparts service counterpart_bank_account_id: type: string format: uuid description: The ID of counterpart bank account object stored in counterparts service counterpart_id: type: string format: uuid description: The ID of the counterpart object that represents the vendor or supplier. counterpart_raw_data: allOf: - $ref: '#/components/schemas/CounterpartRawDataUpdateRequest' description: Allows to fix some data in counterpart recognised fields to correct them in order to make autolinking happen. counterpart_vat_id_id: type: string format: uuid description: The ID of counterpart VAT ID object stored in counterparts service currency: allOf: - $ref: '#/components/schemas/CurrencyEnum' description: The [currency code](https://docs.monite.com/references/currencies) of the currency used in the payable. example: EUR description: type: string maxLength: 255 description: An arbitrary description of this payable. discount: type: integer description: The value of the additional discount that will be applied to the total amount. in [minor units](https://docs.monite.com/references/currencies#minor-units). For example, $12.50 is represented as 1250. example: 500 document_id: type: string description: A unique invoice number assigned by the invoice issuer for payment tracking purposes. example: DE2287 due_date: type: string format: date description: The date by which the payable must be paid, in the YYYY-MM-DD format. If the payable specifies payment terms with early payment discounts, this is the final payment date. enforce_approval_policy_id: type: string format: uuid description: Id of an existing approval policy that should be enforced when submitting the payable for approval.If this field is set, no other policies will be evaluated via their triggers - the specified policy will always be applied instead. issued_at: type: string format: date description: The date when the payable was issued, in the YYYY-MM-DD format. partner_metadata: type: object description: Metadata for partner needs payment_terms: allOf: - $ref: '#/components/schemas/PayablePaymentTermsCreatePayload' description: The number of days to pay with potential discount for options shorter than due_date project_id: type: string format: uuid description: The project ID of the payable. purchase_order_id: type: string format: uuid description: The identifier of the purchase order to which this payable belongs. sender: type: string format: email description: The email address from which the invoice was sent to the entity. example: hello@example.com subtotal: type: integer description: The subtotal amount to be paid, in [minor units](https://docs.monite.com/references/currencies#minor-units). For example, $12.50 is represented as 1250. example: 1250 suggested_payment_term: allOf: - $ref: '#/components/schemas/SuggestedPaymentTerm' description: The suggested date and corresponding discount in which payable could be paid. The date is in the YYYY-MM-DD format. The discount is calculated as X * (10^-4) - for example, 100 is 1%, 25 is 0,25%, 10000 is 100 %. Date varies depending on the payment terms and may even be equal to the due date with discount 0. tag_ids: items: type: string format: uuid type: array description: A list of IDs of user-defined tags (labels) assigned to this payable. Tags can be used to trigger a specific approval policy for this payable. tax: type: integer description: Registered tax percentage applied for a service price in minor units, e.g. 200 means 2%, 1050 means 10.5%. example: 2000 tax_amount: type: integer description: Tax amount in [minor units](https://docs.monite.com/references/currencies#minor-units). For example, $12.50 is represented as 1250. example: 250 total_amount: type: integer description: The total amount to be paid, in [minor units](https://docs.monite.com/references/currencies#minor-units). For example, $12.50 is represented as 1250. example: 15000 additionalProperties: false type: object description: This schema is used to update the data of an existing payable. PartiallyPaidPayload: properties: amount_paid: type: integer minimum: 0.0 description: How much was paid on the invoice (in minor units). additionalProperties: false type: object required: - amount_paid PayableValidationsResource: properties: required_fields: items: $ref: '#/components/schemas/PayablesFieldsAllowedForValidate' type: array type: object required: - required_fields CommentPayload: properties: comment: type: string description: An arbitrary comment that describes how and when this payable was paid. additionalProperties: false type: object FileAttachedEventData: properties: file_name: type: string file_size: type: integer url: type: string additionalProperties: false type: object required: - file_name - file_size - url SuggestedCounterpartPayload: properties: id: type: string format: uuid address_id: type: string format: uuid bank_account_id: type: string format: uuid vat_id_id: type: string format: uuid additionalProperties: false type: object required: - id LabelNValue: properties: label: allOf: - $ref: '#/components/schemas/Item' description: Text label. example: text: total confidence: 99.799 value: allOf: - $ref: '#/components/schemas/Item' description: The value (if any). type: object required: - label - value description: 'A label-value pair extracted from an uploaded document by OCR. For example, the label could be "Total" and the value could be a currency amount.' ErrorSchemaResponse2: properties: error: $ref: '#/components/schemas/ErrorSchema2' type: object required: - error PayableTemplatesVariablesObjectList: properties: data: items: $ref: '#/components/schemas/PayableTemplatesVariablesObject' type: array additionalProperties: false type: object required: - data SourceOfPayableDataEnum: type: string enum: - ocr - user_specified - einvoicing Item: properties: confidence: type: number maximum: 100.0 minimum: 0.0 description: OCR confidence score - the estimated accuracy percentage of character recognition of the extracted text, from 0 to 100%. example: 96.238 processed_text: description: 'If the `text` value is identified as a currency amount or a date, `processed_text` contains this value converted to a common format: * Currency amounts (such as the total, subtotal, tax/VAT, line item prices) are converted to numbers with the currency character removed. For example, "€1,125.00" becomes 1125.0.* Dates are converted to the [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format, `YYYY-MM-DDThh:mm:ss`. For example, "26/3/2021" becomes "2021-03-26T00:00:00". If `text` is not a currency amount or a date, `processed_text` is `null`.' example: 1125 text: type: string description: The text as recognized by OCR. example: €1,125.00 type: object required: - confidence - text description: Contains information about a text block or line extracted from an uploaded document by OCR. OCRResponseInvoiceReceiptLineItemRaw: properties: description: type: string description: Human-readable line item description example: 'Impact Players : How to Take the Lead , Play Bigger , and Multiply Your' item_adjusted: type: boolean description: Item Quantity/Unit Price adjusted default: false line_item_ocr_id: type: string description: OCR Id of line item quantity: type: number description: Quantity example: 1.2 total_excl_vat: type: number description: Total excluded VAT as parsed. example: 120 total_incl_vat: type: number description: Total included VAT as parsed. example: 135 unit: type: string description: Unit example: meters unit_price: type: number description: Price as parsed example: 100 vat_amount: type: number description: VAT Amount as parsed. example: 15 vat_percentage: type: number description: VAT Percent as parsed. example: 12.5 type: object PayablesVariableType: type: string enum: - payables_purchase_order - payables_notify_approver OrderEnum: type: string enum: - asc - desc SuggestedPaymentTerm: properties: date: type: string format: date discount: type: integer maximum: 10000.0 minimum: 0.0 additionalProperties: false type: object required: - date description: Suggested payment date and corresponding discount PayableTemplatesVariable: properties: description: type: string name: type: string additionalProperties: false type: object required: - description - name PayableCreatedEventData: properties: payable_source: $ref: '#/components/schemas/PayableOriginEnum' additionalProperties: false type: object required: - payable_source CounterpartRawData: properties: address: allOf: - $ref: '#/components/schemas/CounterpartRawAddress' description: The address of the vendor or supplier. bank_account: allOf: - $ref: '#/components/schemas/CounterpartRawBankAccount' description: Object representing counterpart bank account. email: type: string format: email description: The email address of the organization example: acme@example.com name: type: string description: Vendor or supplier name. example: Acme Inc. phone: type: string description: The phone number of the organization example: '5551231234' tax_id: type: string description: The tax id of the counterpart. example: DE12345678 vat_id: allOf: - $ref: '#/components/schemas/CounterpartRawVatID' description: VAT ID of the vendor or supplier which was used in the invoice. type: object PayablePaymentTermFinal: properties: number_of_days: type: integer description: The amount of days after the invoice issue date. additionalProperties: false type: object required: - number_of_days PayablesFieldsAllowedForValidate: type: string enum: - currency - document_id - due_date - issued_at - tax_amount - total_amount - subtotal - description - suggested_payment_term - payment_terms - tax - sender - file_id - counterpart_id - counterpart_bank_account_id - counterpart_address_id - counterpart_vat_id_id - line_items - line_items.quantity - line_items.unit_price - line_items.tax - line_items.ledger_account_id - line_items.accounting_tax_rate_id - line_items.unit - line_items.name - line_items.description - line_items.subtotal - line_items.total - line_items.tax_amount PayablePaginationResponse: properties: data: items: $ref: '#/components/schemas/PayableResponseSchema' type: array next_pagination_token: type: string description: A token that can be sent in the `pagination_token` query parameter to get the next page of results, or `null` if there is no next page (i.e. you've reached the last page). prev_pagination_token: type: string description: A token that can be sent in the `pagination_token` query parameter to get the previous page of results, or `null` if there is no previous page (i.e. you've reached the first page). type: object required: - data description: A paginated list of payables. CounterpartRawVatIDUpdateRequest: properties: country: $ref: '#/components/schemas/AllowedCountries' type: type: string value: type: string maxLength: 32 additionalProperties: false type: object PayableHistoryResponse: properties: id: type: string format: uuid description: A unique ID of the history record. examples: - cd58435b-1c79-4b17-9f79-f898c93e5f97 entity_user_id: type: string format: uuid description: ID of the entity user who made the change or trigger the event, or `null` if it was done by using a partner access token. examples: - d5a577b0-01c0-4566-ac5c-44f41935e8c4 event_data: anyOf: - $ref: '#/components/schemas/PayableStatusChangedEventData' - $ref: '#/components/schemas/PayableUpdatedEventData' - $ref: '#/components/schemas/PayableCreatedEventData' - $ref: '#/components/schemas/PayableCreditNoteLinkedEventData' - $ref: '#/components/schemas/PayableCreditNoteUnlinkedEventData' - $ref: '#/components/schemas/FileAttachedEventData' description: 'An object containing additional information about the event or change. The object structure varies based on the `event_type`. ' event_type: allOf: - $ref: '#/components/schemas/PayableHistoryEventTypeEnum' description: The type of the event or change. payable_id: type: string format: uuid description: ID of the payable document that was changed or triggered an event. examples: - f669a8a4-0563-4ab9-b54f-e9d700d282c5 timestamp: type: string format: date-time description: UTC date and time when the event or change occurred. type: object required: - id - event_data - event_type - payable_id - timestamp OCRAddress: properties: city: type: string description: City name. example: Berlin country: type: string description: Two-letter ISO country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)). example: DE line1: type: string description: Street address. example: Flughafenstrasse 52 line2: type: string description: Additional address information (if any). original_country_name: type: string description: Country name as it is stated in the document. example: Berlin postal_code: type: string description: ZIP or postal code. example: '10115' state: type: string description: State, region, province, or county. type: object description: 'In general it''s compatible with CounterpartAddress model but * All fields are optional * There is an additional field original_country_name' CounterpartRawAddressUpdateRequest: properties: city: type: string description: City name. example: Berlin country: allOf: - $ref: '#/components/schemas/AllowedCountries' description: Two-letter ISO country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)). example: DE line1: type: string description: Street address. example: Flughafenstrasse 52 line2: type: string description: Additional address information (if any). postal_code: type: string description: ZIP or postal code. example: '10115' state: type: string description: State, region, province, or county. additionalProperties: false type: object description: Address information. ErrorSchema2: properties: message: type: string type: object required: - message PayableAttachFile: properties: file: type: string format: binary type: object required: - file PayableUpdatedEventData: properties: {} additionalProperties: false type: object PayableHistoryCursorFields: type: string enum: - timestamp OcrRecognitionResponse: properties: line_items: items: $ref: '#/components/schemas/LabelNValue' type: array description: Text content of the invoice line items as recognized by OCR. summary: items: $ref: '#/components/schemas/LabelNValue' type: array description: Invoice text content other than the line items. Such as the invoice issue and due dates, vendor name and address, and other general information. type: object description: 'Contains information about all text blocks extracted from an uploaded invoice by OCR. The text blocks are grouped into `line_items` (invoice line items) and `summary` (all other information). Legacy schema used for AWS textract recognition.' CounterpartRawVatID: properties: country: $ref: '#/components/schemas/AllowedCountries' type: type: string value: type: string type: object HTTPValidationError: properties: detail: items: $ref: '#/components/schemas/ValidationError' type: array type: object FileSchema: properties: id: type: string format: uuid description: A unique ID of this file. created_at: type: string format: date-time description: UTC date and time when this file was uploaded to Monite. Timestamps follow the [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. file_type: type: string description: The type of the business object associated with this file. example: payables md5: type: string description: The MD5 hash of the file. example: 31d1a2dd1ad3dfc39be849d70a68dac0 mimetype: type: string description: The file's [media type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types). example: application/pdf name: type: string maxLength: 512 description: The original file name (if available). example: invoice.pdf pages: items: $ref: '#/components/schemas/PageSchema2' type: array description: If the file is a PDF document, this property contains individual pages extracted from the file. Otherwise, an empty array. default: [] previews: items: $ref: '#/components/schemas/PreviewSchema2' type: array description: Preview images generated for this file. There can be multiple images with different sizes. default: [] region: type: string description: Geographical region of the data center where the file is stored. example: eu-central-1 size: type: integer minimum: 0.0 description: The file size in bytes. example: 24381 url: type: string description: The URL to download the file. example: https://bucketname.s3.amazonaws.com/12345/67890.pdf type: object required: - id - created_at - file_type - name - region - md5 - mimetype - url - size description: Represents a file (such as a PDF invoice) that was uploaded to Monite. PreviewSchema2: properties: height: type: integer description: The image height in pixels. example: 400 url: type: string description: The image URL. example: https://bucketname.s3.amazonaws.com/1/2/3.png width: type: integer description: The image width in pixels. example: 200 type: object required: - url - width - height description: A preview image generated for a file. SuggestedResponse: properties: suggested_counterpart: $ref: '#/components/schemas/SuggestedCounterpartPayload' additionalProperties: false type: object required: - suggested_counterpart PayableHistoryPaginationResponse: properties: data: items: $ref: '#/components/schemas/PayableHistoryResponse' type: array next_pagination_token: type: string description: A token that can be sent in the `pagination_token` query parameter to get the next page of results, or `null` if there is no next page (i.e. you've reached the last page). prev_pagination_token: type: string description: A token that can be sent in the `pagination_token` query parameter to get the previous page of results, or `null` if there is no previous page (i.e. you've reached the first page). additionalProperties: false type: object required: - data description: A paginated list of change history records. PayableUploadFile: properties: file: type: string format: binary type: object required: - file ValidationError: properties: loc: items: anyOf: - type: string - type: integer type: array msg: type: string type: type: string type: object required: - loc - msg - type PayableCreditNoteData: properties: id: type: string format: uuid description: The unique identifier of the credit note. example: 123e4567-e89b-12d3-a456-426614174000 document_id: type: string description: The credit note's unique document number. example: CN-123456 issued_at: type: string format: date description: The date when the credit note was issued, in the YYYY-MM-DD format example: '2024-01-15' status: type: string maxLength: 30 description: The current status of the credit note in its lifecycle example: submitted_for_approval total_amount: type: integer description: Credit note total amount. example: 1000 type: object required: - id - status AllowedCountries: type: string enum: - AF - AX - AL - DZ - AS - AD - AO - AI - AQ - AG - AR - AM - AW - AU - AT - AZ - BS - BH - BD - BB - BY - BE - BZ - BJ - BM - BT - BO - BA - BW - BV - BR - IO - BN - BG - BF - BI - KH - CM - CA - IC - CV - KY - CF - EA - TD - CL - CN - CX - CC - CO - KM - CG - CD - CK - CR - CI - HR - CU - CY - CZ - DK - DJ - DM - DO - EC - EG - SV - GQ - ER - EE - SZ - ET - FK - FO - FJ - FI - FR - GF - PF - TF - GA - GM - GE - DE - GH - GI - GR - GL - GD - GP - GU - GT - GG - GN - GW - GY - HT - HM - VA - HN - HK - HU - IS - IN - ID - IR - IQ - IE - IM - IL - IT - JM - JP - JE - JO - KZ - KE - KI - KP - KR - KW - KG - LA - LV - LB - LS - LR - LY - LI - LT - LU - MO - MG - MW - MY - MV - ML - MT - MH - MQ - MR - MU - YT - MX - FM - MD - MC - MN - ME - MS - MA - MZ - MM - NA - NR - NP - NL - AN - NC - NZ - NI - NE - NG - NU - NF - MP - MK - 'NO' - OM - PK - PW - PS - PA - PG - PY - PE - PH - PN - PL - PT - PR - QA - RE - RO - RU - RW - SH - KN - LC - PM - VC - WS - SM - ST - SA - SN - RS - SC - SL - SG - SK - SI - SB - SO - ZA - SS - GS - ES - LK - SD - SR - SJ - SE - CH - SY - TW - TJ - TZ - TH - TL - TG - TK - TO - TT - TN - TR - TM - TC - TV - UG - UA - AE - GB - US - UM - UY - UZ - VU - VE - VN - VG - VI - WF - EH - YE - ZM - ZW - BL - BQ - CW - MF - SX PayablePaymentTermDiscount: properties: discount: type: integer description: The discount percentage in minor units. E.g., 200 means 2%, 1050 means 10.5%. number_of_days: type: integer description: The amount of days after the invoice issue date. additionalProperties: false type: object required: - discount - number_of_days PayableStateEnum: type: string enum: - draft - new - approve_in_progress - waiting_to_be_paid - partially_paid - paid - canceled - rejected CounterpartRawBankAccount: properties: account_holder_name: type: string description: Vendor's bank account name. account_number: type: string description: Vendor's bank account number, IBAN, or similar (if specified in the payable document). example: '123456789012' bic: type: string description: SWIFT code (BIC) of the vendor's bank. example: DEUTDE2HXXX iban: type: string description: required for non-GB bank accounts routing_number: type: string description: required for US bank accounts sort_code: type: string description: required for GB bank accounts type: object PayableOriginEnum: type: string enum: - upload - email - einvoicing CurrencyEnum: type: string enum: - AED - AFN - ALL - AMD - ANG - AOA - ARS - AUD - AWG - AZN - BAM - BBD - BDT - BGN - BHD - BIF - BMD - BND - BOB - BRL - BSD - BTN - BWP - BYN - BZD - CAD - CDF - CHF - CLP - CNY - COP - CRC - CVE - CZK - DJF - DKK - DOP - DZD - EGP - ETB - EUR - FJD - FKP - GBP - GEL - GHS - GIP - GMD - GNF - GTQ - GYD - HKD - HNL - HTG - HUF - IDR - ILS - INR - IQD - ISK - JMD - JOD - JPY - KES - KGS - KHR - KMF - KRW - KWD - KYD - KZT - LAK - LBP - LKR - LRD - LSL - LYD - MAD - MDL - MGA - MKD - MMK - MNT - MOP - MUR - MVR - MWK - MXN - MYR - MZN - NAD - NGN - NIO - NOK - NPR - NZD - OMR - PAB - PEN - PGK - PHP - PKR - PLN - PYG - QAR - RON - RSD - RUB - RWF - SAR - SBD - SCR - SEK - SGD - SHP - SLE - SOS - SRD - SSP - SVC - SZL - THB - TJS - TMT - TND - TOP - TRY - TTD - TWD - TZS - UAH - UGX - USD - UYU - UZS - VND - VUV - WST - XAF - XCD - XOF - XPF - YER - ZAR - ZMW OcrStatusEnum_2: type: string enum: - processing - error - success - canceled OcrStatusEnum_3: type: string enum: - processing - error - success - canceled securitySchemes: HTTPBearer: type: http scheme: bearer x-refined-from: - monite-openapi-2023-09-01.json - monite-openapi-2024-05-25.json - monite-openapi.yml