openapi: 3.2.0 info: title: Monite Receivables 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 Receivables 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: Receivables paths: /receivables: get: tags: - Receivables summary: Get receivables description: 'Returns a list of accounts receivable documents - invoices, quotes, and credit notes - of the specified entity. Results can be filtered by amount, counterpart, due date, and other criteria. Multiple filters are combined using logical AND unless specified otherwise. If no documents matching the search criteria are found, the endpoint returns a successful response with an empty `data` array. This endpoint supports pagination and sorting. By default, results are sorted by the creation date in ascending order (from oldest to newest). #### Examples ##### Invoices * Get all overdue invoices: ``` GET /receivables?type=invoice&status=overdue ``` * Get all invoices created for the counterpart named "Solarwind" (case-insensitive): ``` GET /receivables?type=invoice?counterpart_name__icontains=Solarwind ``` * Get invoices whose total amount starts from 500 EUR: ``` GET /receivables?type=invoice&total_amount__gte=50000 ``` * Get invoices that are due for payment in September 2024: ``` GET /receivables?type=invoice&due_date__gte=2024-09-01&due_date__lt=2024-10-01 ``` **Note:** This will only return invoices with a set due date. Invoices without due dates are excluded from date range filters. * Get invoices without a due date: ``` GET /receivables?type=invoice&has_due_date=false ``` * Get invoices with any due date (excluding those without due dates): ``` GET /receivables?type=invoice&has_due_date=true ``` * Get invoices created on or after September 1, 2024: ``` GET /receivables?type=invoice&created_at__gte=2024-09-01T00:00:00Z ``` * Find an invoice created from a specific quote: ``` GET /receivables?type=invoice?based_on=QUOTE_ID ``` ##### Quotes * Get the latest created quote: ``` GET /receivables?type=quote&sort=created_at&order=desc&limit=1 ``` * Get the latest issued quote: ``` GET /receivables?type=quote&sort=issue_date&order=desc&limit=1 ``` ##### Credit notes * Find all credit notes created for a specific invoice: ``` GET /receivables?type=credit_note?based_on=INVOICE_ID ```' operationId: get_receivables 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 .. 250) to return in a single page of the response. Default is 100. The response may contain fewer items if it is the last or only page. \n\nWhen using pagination with a non-default `limit`, you must provide the `limit` value alongside `pagination_token` in all subsequent pagination requests. Unlike other query parameters, `limit` is not inferred from `pagination_token`." required: false schema: type: integer maximum: 250.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 except `limit` 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: 'Return only receivables with the 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 receivables that have the specified statuses. See the applicable [invoice statuses](https://docs.monite.com/accounts-receivable/invoices/index), [quote statuses](https://docs.monite.com/accounts-receivable/quotes/index), and [credit note statuses](https://docs.monite.com/accounts-receivable/credit-notes#credit-note-lifecycle). To specify multiple statuses, repeat this parameter for each value: `status__in=draft&status__in=issued`' required: false schema: items: type: string enum: - draft - issuing - issued - failed - accepted - expired - declined - recurring - partially_paid - paid - overdue - uncollectible - canceled type: array name: status__in in: query - description: 'Return only receivables created 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=` If the request is authenticated using an entity user token, this user must have the `receivable.read.allowed` (rather than `allowed_for_own`) permission to be able to query receivables created by other users. IDs of deleted users will still produce results here if those users had associated receivables. Valid but nonexistent user IDs do not raise errors but produce no results.' required: false schema: items: type: string format: uuid type: array name: entity_user_id__in in: query - description: The field to sort the results by. Typically used together with the `order` parameter. required: false schema: allOf: - $ref: '#/components/schemas/ReceivableCursorFields' name: sort in: query - description: 'Return only receivables whose [tags](https://docs.monite.com/common/tags) include at least one of the tags with the specified IDs. For example, given receivables with the following tags: 1. tagA 2. tagB 3. tagA, tagB 4. tagC 5. tagB, tagC `tag_ids__in=&tag_ids__in=` will return receivables 1, 2, 3, and 5. 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 in: query - description: 'Return only receivables whose [tags](https://docs.monite.com/common/tags) include all of the tags with the specified IDs and optionally other tags that are not specified. For example, given receivables with the following tags: 1. tagA 2. tagB 3. tagA, tagB 4. tagC 5. tagA, tagB, tagC `tag_ids=&tag_ids=` will return receivables 3 and 5.' required: false schema: items: type: string format: uuid type: array name: tag_ids in: query - description: "Return only receivables whose line items include at least one of the product IDs with the specified IDs. \n\nTo specify multiple product IDs, repeat this parameter for each ID:\n`product_ids__in=&product_ids__in=`\n\nFor example, given receivables with the following product IDs:\n1. productA\n2. productB\n3. productA, productB\n4. productC\n5. productB, productC\n\n\n`product_ids__in=&product_ids__in=` will return receivables 1, 2, 3, and 5.Valid but nonexistent product IDs do not raise errors but produce no results." required: false schema: items: type: string format: uuid type: array name: product_ids__in in: query - description: "Return only receivables whose line items include all of the product IDs with the specified IDs and optionally other products that are not specified. \n\nTo specify multiple product IDs, repeat this parameter for each ID:\n`product_ids=&product_ids=`\n\nFor example, given receivables with the following product IDs:\n1. productA\n2. productB\n3. productA, productB\n4. productC\n5. productA, productB, productC\n\n\n`product_ids=&product_ids=` will return receivables 3 and 5.\n\n" required: false schema: items: type: string format: uuid type: array name: product_ids in: query - description: Return only receivables 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 - required: false schema: $ref: '#/components/schemas/ReceivableType' name: type in: query - required: false schema: type: string name: document_id in: query - required: false schema: type: string name: document_id__contains in: query - required: false schema: type: string name: document_id__icontains in: query - required: false schema: type: string format: date-time name: issue_date__gt in: query - required: false schema: type: string format: date-time name: issue_date__lt in: query - required: false schema: type: string format: date-time name: issue_date__gte in: query - required: false schema: type: string format: date-time name: issue_date__lte in: query - required: false schema: type: string format: date-time name: created_at__gt in: query - required: false schema: type: string format: date-time name: created_at__lt in: query - required: false schema: type: string format: date-time name: created_at__gte in: query - required: false schema: type: string format: date-time name: created_at__lte in: query - required: false schema: type: string format: uuid name: counterpart_id in: query - required: false schema: type: string name: counterpart_name in: query - required: false schema: type: string name: counterpart_name__contains in: query - required: false schema: type: string name: counterpart_name__icontains in: query - required: false schema: type: integer name: amount in: query - required: false schema: type: integer name: amount__gt in: query - required: false schema: type: integer name: amount__lt in: query - required: false schema: type: integer name: amount__gte in: query - required: false schema: type: integer name: amount__lte in: query - required: false schema: type: string enum: - draft - issuing - issued - failed - accepted - expired - declined - recurring - partially_paid - paid - overdue - uncollectible - canceled name: status in: query - required: false schema: type: string format: uuid name: entity_user_id in: query - required: false schema: type: string format: uuid name: based_on in: query - required: false schema: type: string format: date name: due_date__gt in: query - required: false schema: type: string format: date name: due_date__lt in: query - required: false schema: type: string format: date name: due_date__gte in: query - required: false schema: type: string format: date name: due_date__lte in: query - required: false schema: type: boolean name: has_due_date in: query - required: false schema: type: string format: uuid name: project_id in: query - required: false schema: type: string name: search_text 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/ReceivablePaginationResponse' '405': description: Method Not Allowed content: application/json: schema: $ref: '#/components/schemas/ErrorSchemaResponse' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/ErrorSchemaResponse' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ErrorSchemaResponse' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/ErrorSchemaResponse' '406': description: Not Acceptable content: application/json: schema: $ref: '#/components/schemas/ErrorSchemaResponse' '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`' content: application/json: schema: $ref: '#/components/schemas/ErrorSchemaResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' schema_name: ReceivablePaginationResponse security: - HTTPBearer: [] post: tags: - Receivables summary: Create a receivable operationId: post_receivables 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/ReceivableFacadeCreatePayload' required: true responses: '201': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/ReceivableResponse' '405': description: Method Not Allowed content: application/json: schema: $ref: '#/components/schemas/ErrorSchemaResponse' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/ErrorSchemaResponse' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ErrorSchemaResponse' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ErrorSchemaResponse' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/ErrorSchemaResponse' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/ErrorSchemaResponse' '409': description: Business logic error content: application/json: schema: $ref: '#/components/schemas/ErrorSchemaResponse' '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 /receivables/required_fields: get: tags: - Receivables summary: Get required field names for invoice creation description: Get field requirements for invoice creation given the entity and counterpart details. operationId: get_receivables_required_fields parameters: - required: true schema: type: string format: date example: '2023-09-01' name: x-monite-version in: header - required: false schema: type: string format: uuid name: counterpart_id in: query - required: false schema: type: string format: uuid name: counterpart_billing_address_id in: query - required: false schema: $ref: '#/components/schemas/AllowedCountries' name: counterpart_country in: query - required: false schema: $ref: '#/components/schemas/CounterpartType' name: counterpart_type in: query - required: false schema: type: string format: uuid name: entity_vat_id_id in: query - required: false schema: type: string format: uuid name: counterpart_vat_id_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/ReceivableRequiredFields' '405': description: Method Not Allowed content: application/json: schema: $ref: '#/components/schemas/ErrorSchemaResponse' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/ErrorSchemaResponse' '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 /receivables/search: post: tags: - Receivables summary: Search receivables description: This is a POST version of the `GET /receivables` endpoint. Use it to send search and filter parameters in the request body instead of the URL query string in case the query is too long and exceeds the URL length limit of your HTTP client. operationId: post_receivables_search 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/ReceivablesSearchRequest' required: true responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/ReceivablePaginationResponse' '405': description: Method Not Allowed content: application/json: schema: $ref: '#/components/schemas/ErrorSchemaResponse' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/ErrorSchemaResponse' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ErrorSchemaResponse' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/ErrorSchemaResponse' '406': description: Not Acceptable content: application/json: schema: $ref: '#/components/schemas/ErrorSchemaResponse' '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`' content: application/json: schema: $ref: '#/components/schemas/ErrorSchemaResponse' '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 /receivables/variables: get: tags: - Receivables summary: Get email template variables description: Get a list of placeholders that can be used in email templates for customization. operationId: get_receivables_variables 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/ReceivableTemplatesVariablesObjectList' '405': description: Method Not Allowed content: application/json: schema: $ref: '#/components/schemas/ErrorSchemaResponse' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/ErrorSchemaResponse' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/ErrorSchemaResponse' '409': description: Business logic error content: application/json: schema: $ref: '#/components/schemas/ErrorSchemaResponse' '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 /receivables/{receivable_id}: get: tags: - Receivables summary: Get a receivable by ID operationId: get_receivables_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: receivable_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/ReceivableResponse' '405': description: Method Not Allowed content: application/json: schema: $ref: '#/components/schemas/ErrorSchemaResponse' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/ErrorSchemaResponse' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ErrorSchemaResponse' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ErrorSchemaResponse' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/ErrorSchemaResponse' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/ErrorSchemaResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - HTTPBearer: [] patch: tags: - Receivables summary: Update a receivable operationId: patch_receivables_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: receivable_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/ReceivableUpdatePayload' required: true responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/ReceivableResponse' '405': description: Method Not Allowed content: application/json: schema: $ref: '#/components/schemas/ErrorSchemaResponse' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/ErrorSchemaResponse' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ErrorSchemaResponse' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ErrorSchemaResponse' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/ErrorSchemaResponse' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/ErrorSchemaResponse' '409': description: Business logic error content: application/json: schema: $ref: '#/components/schemas/ErrorSchemaResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - HTTPBearer: [] delete: tags: - Receivables summary: Delete a receivable operationId: delete_receivables_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: receivable_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/ErrorSchemaResponse' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/ErrorSchemaResponse' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ErrorSchemaResponse' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ErrorSchemaResponse' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/ErrorSchemaResponse' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/ErrorSchemaResponse' '409': description: Business logic error content: application/json: schema: $ref: '#/components/schemas/ErrorSchemaResponse' '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 /receivables/{receivable_id}/accept: post: tags: - Receivables summary: Accept a quote operationId: post_receivables_id_accept 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: receivable_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/QuoteAcceptRequest' responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/SuccessResult' '405': description: Method Not Allowed content: application/json: schema: $ref: '#/components/schemas/ErrorSchemaResponse' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/ErrorSchemaResponse' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ErrorSchemaResponse' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ErrorSchemaResponse' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/ErrorSchemaResponse' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/ErrorSchemaResponse' '409': description: Business logic error content: application/json: schema: $ref: '#/components/schemas/ErrorSchemaResponse' '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 /receivables/{receivable_id}/cancel: post: tags: - Receivables summary: Cancel an invoice operationId: post_receivables_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: receivable_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/ErrorSchemaResponse' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/ErrorSchemaResponse' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ErrorSchemaResponse' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ErrorSchemaResponse' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/ErrorSchemaResponse' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/ErrorSchemaResponse' '409': description: Business logic error content: application/json: schema: $ref: '#/components/schemas/ErrorSchemaResponse' '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 /receivables/{receivable_id}/clone: post: tags: - Receivables summary: Clone a receivable operationId: post_receivables_id_clone 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: receivable_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: '201': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/ReceivableResponse' '405': description: Method Not Allowed content: application/json: schema: $ref: '#/components/schemas/ErrorSchemaResponse' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/ErrorSchemaResponse' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ErrorSchemaResponse' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ErrorSchemaResponse' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/ErrorSchemaResponse' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/ErrorSchemaResponse' '409': description: Business logic error content: application/json: schema: $ref: '#/components/schemas/ErrorSchemaResponse' '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 /receivables/{receivable_id}/decline: post: tags: - Receivables summary: Decline a quote operationId: post_receivables_id_decline 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: receivable_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/ReceivableDeclinePayload' responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/SuccessResult' '405': description: Method Not Allowed content: application/json: schema: $ref: '#/components/schemas/ErrorSchemaResponse' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/ErrorSchemaResponse' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ErrorSchemaResponse' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ErrorSchemaResponse' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/ErrorSchemaResponse' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/ErrorSchemaResponse' '409': description: Business logic error content: application/json: schema: $ref: '#/components/schemas/ErrorSchemaResponse' '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 /receivables/{receivable_id}/history: get: tags: - Receivables summary: Get a receivable's history description: 'Returns the history of the specified accounts receivable document. The history contains all revisions of the document, status updates, and other events that occurred during the document''s lifecycle. For more information, see Document history. You can filter the history by the date range and event type. Events are sorted from oldest to newest by default.' operationId: get_receivables_id_history parameters: - required: true schema: type: string format: date example: '2023-09-01' name: x-monite-version in: header - description: ID of the accounts receivable document whose history you want to get. required: true schema: type: string format: uuid name: receivable_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/ReceivableHistoryCursorFields' name: sort in: query - description: 'Return only the specified [event types](https://docs.monite.com/accounts-receivable/document-history#event-types). To include multiple types, repeat this parameter for each value: `event_type__in=receivable_updated&event_type__in=status_changed`' required: false schema: items: $ref: '#/components/schemas/ReceivableHistoryEventTypeEnum' 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/ReceivableHistoryPaginationResponse' '405': description: Method Not Allowed content: application/json: schema: $ref: '#/components/schemas/ErrorSchemaResponse' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/ErrorSchemaResponse' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ErrorSchemaResponse' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ErrorSchemaResponse' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/ErrorSchemaResponse' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/ErrorSchemaResponse' '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 /receivables/{receivable_id}/history/{receivable_history_id}: get: tags: - Receivables summary: Get a receivable's history record by ID description: Returns a single record from the change history of the specified accounts receivable document. operationId: get_receivables_id_history_id parameters: - required: true schema: type: string format: date example: '2023-09-01' name: x-monite-version in: header - description: ID of the history record to return. You can get these IDs from `GET /receivables/{receivable_id}/history`. required: true schema: type: string format: uuid name: receivable_history_id in: path - description: ID of the accounts receivable document whose history you want to get. required: true schema: type: string format: uuid name: receivable_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/ReceivableHistoryResponse' '405': description: Method Not Allowed content: application/json: schema: $ref: '#/components/schemas/ErrorSchemaResponse' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/ErrorSchemaResponse' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ErrorSchemaResponse' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ErrorSchemaResponse' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/ErrorSchemaResponse' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/ErrorSchemaResponse' '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 /receivables/{receivable_id}/issue: post: tags: - Receivables summary: Issue a receivable operationId: post_receivables_id_issue 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: receivable_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/ReceivableResponse' '405': description: Method Not Allowed content: application/json: schema: $ref: '#/components/schemas/ErrorSchemaResponse' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/ErrorSchemaResponse' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ErrorSchemaResponse' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ErrorSchemaResponse' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/ErrorSchemaResponse' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/ErrorSchemaResponse' '409': description: Business logic error content: application/json: schema: $ref: '#/components/schemas/ErrorSchemaResponse' '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 /receivables/{receivable_id}/line_items: put: tags: - Receivables summary: Update the line items of a receivable description: Replace all line items of an existing invoice or quote with a new list of line items. operationId: put_receivables_id_line_items 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: receivable_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/UpdateLineItems' required: true responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/LineItemsResponse' '405': description: Method Not Allowed content: application/json: schema: $ref: '#/components/schemas/ErrorSchemaResponse' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/ErrorSchemaResponse' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ErrorSchemaResponse' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ErrorSchemaResponse' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/ErrorSchemaResponse' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/ErrorSchemaResponse' '409': description: Business logic error content: application/json: schema: $ref: '#/components/schemas/ErrorSchemaResponse' '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 /receivables/{receivable_id}/mails: get: tags: - Receivables summary: Get a list of all mails sent by receivable operationId: get_receivables_id_mails 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: receivable_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/ReceivableMailCursorFields' name: sort in: query - required: false schema: $ref: '#/components/schemas/ReceivableMailStatusEnum' name: status in: query - required: false schema: items: $ref: '#/components/schemas/ReceivableMailStatusEnum' type: array name: status__in in: query - required: false schema: type: string format: date-time name: created_at__gt in: query - required: false schema: type: string format: date-time name: created_at__lt in: query - required: false schema: type: string format: date-time name: created_at__gte in: query - required: false schema: type: string format: date-time name: created_at__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/ReceivableMailPaginationResponse' '405': description: Method Not Allowed content: application/json: schema: $ref: '#/components/schemas/ErrorSchemaResponse' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/ErrorSchemaResponse' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ErrorSchemaResponse' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ErrorSchemaResponse' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/ErrorSchemaResponse' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/ErrorSchemaResponse' '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 /receivables/{receivable_id}/mails/{mail_id}: get: tags: - Receivables summary: Get a mail sent by receivable operationId: get_receivables_id_mails_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: receivable_id in: path - required: true schema: type: string format: uuid name: mail_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/ReceivableMailResponse' '405': description: Method Not Allowed content: application/json: schema: $ref: '#/components/schemas/ErrorSchemaResponse' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/ErrorSchemaResponse' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ErrorSchemaResponse' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ErrorSchemaResponse' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/ErrorSchemaResponse' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/ErrorSchemaResponse' '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 /receivables/{receivable_id}/mark_as_paid: post: tags: - Receivables summary: Mark an invoice as paid operationId: post_receivables_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: receivable_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/ReceivablePaidPayload' responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/ReceivableResponse' '405': description: Method Not Allowed content: application/json: schema: $ref: '#/components/schemas/ErrorSchemaResponse' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/ErrorSchemaResponse' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ErrorSchemaResponse' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ErrorSchemaResponse' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/ErrorSchemaResponse' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/ErrorSchemaResponse' '409': description: Business logic error content: application/json: schema: $ref: '#/components/schemas/ErrorSchemaResponse' '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 /receivables/{receivable_id}/mark_as_partially_paid: post: tags: - Receivables summary: Mark an invoice as partially paid description: Deprecated. Use `POST /payment_records` to record an invoice payment. operationId: post_receivables_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: receivable_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/ReceivablePartiallyPaidPayload' required: true responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/ReceivableResponse' '405': description: Method Not Allowed content: application/json: schema: $ref: '#/components/schemas/ErrorSchemaResponse' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/ErrorSchemaResponse' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ErrorSchemaResponse' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ErrorSchemaResponse' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/ErrorSchemaResponse' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/ErrorSchemaResponse' '409': description: Business logic error content: application/json: schema: $ref: '#/components/schemas/ErrorSchemaResponse' '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 /receivables/{receivable_id}/mark_as_uncollectible: post: tags: - Receivables summary: Mark an invoice as uncollectible operationId: post_receivables_id_mark_as_uncollectible 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: receivable_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/ReceivableUncollectiblePayload' responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/ReceivableResponse' '405': description: Method Not Allowed content: application/json: schema: $ref: '#/components/schemas/ErrorSchemaResponse' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/ErrorSchemaResponse' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ErrorSchemaResponse' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ErrorSchemaResponse' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/ErrorSchemaResponse' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/ErrorSchemaResponse' '409': description: Business logic error content: application/json: schema: $ref: '#/components/schemas/ErrorSchemaResponse' '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 /receivables/{receivable_id}/pdf_link: get: tags: - Receivables summary: Get a link to the PDF version of a receivable operationId: get_receivables_id_pdf_link 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: receivable_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/ReceivableFileUrl' '405': description: Method Not Allowed content: application/json: schema: $ref: '#/components/schemas/ErrorSchemaResponse' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/ErrorSchemaResponse' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ErrorSchemaResponse' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ErrorSchemaResponse' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/ErrorSchemaResponse' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/ErrorSchemaResponse' '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 /receivables/{receivable_id}/preview: post: tags: - Receivables summary: Preview a receivable's email message operationId: post_receivables_id_preview 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: receivable_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/ReceivablePreviewRequest' required: true responses: '201': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/ReceivablePreviewResponse' '405': description: Method Not Allowed content: application/json: schema: $ref: '#/components/schemas/ErrorSchemaResponse' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/ErrorSchemaResponse' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ErrorSchemaResponse' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ErrorSchemaResponse' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/ErrorSchemaResponse' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/ErrorSchemaResponse' '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 /receivables/{receivable_id}/send: post: tags: - Receivables summary: Send a receivable via email operationId: post_receivables_id_send 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: receivable_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/ReceivableSendRequest' required: true responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/ReceivableSendResponse' '405': description: Method Not Allowed content: application/json: schema: $ref: '#/components/schemas/ErrorSchemaResponse' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/ErrorSchemaResponse' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ErrorSchemaResponse' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ErrorSchemaResponse' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/ErrorSchemaResponse' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/ErrorSchemaResponse' '409': description: Business logic error content: application/json: schema: $ref: '#/components/schemas/ErrorSchemaResponse' '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 /receivables/{receivable_id}/send_test_reminder: post: tags: - Receivables summary: Send a test reminder operationId: post_receivables_id_send_test_reminder 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: receivable_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/ReceivableSendTestReminderPayload' required: true responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/ReceivablesSendResponse' '405': description: Method Not Allowed content: application/json: schema: $ref: '#/components/schemas/ErrorSchemaResponse' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/ErrorSchemaResponse' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ErrorSchemaResponse' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ErrorSchemaResponse' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/ErrorSchemaResponse' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/ErrorSchemaResponse' '409': description: Business logic error content: application/json: schema: $ref: '#/components/schemas/ErrorSchemaResponse' '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 /receivables/{receivable_id}/verify: post: tags: - Receivables summary: Verify a receivable operationId: post_receivables_id_verify 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: receivable_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/MissingFields' '405': description: Method Not Allowed content: application/json: schema: $ref: '#/components/schemas/ErrorSchemaResponse' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/ErrorSchemaResponse' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ErrorSchemaResponse' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ErrorSchemaResponse' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/ErrorSchemaResponse' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/ErrorSchemaResponse' '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: FieldSchema: properties: description: type: string description: Description of the field required: type: boolean description: Whether the field is required additionalProperties: false type: object required: - description - required ReceivableRequiredFields: properties: counterpart: allOf: - $ref: '#/components/schemas/CounterpartFields' description: Object describing the required fields for counterpart default: tax_id: description: The counterpart's taxpayer identification number or tax ID. For identification purposes, this field may be required for counterparts that are not VAT-registered. required: false vat_id: description: The counterpart's VAT (Value Added Tax) identification number. This field is required for counterparts that are VAT-registered. required: false entity: allOf: - $ref: '#/components/schemas/EntityFields' description: Object describing the required fields for entity default: tax_id: description: The entity's taxpayer identification number or tax ID. This field is required for entities that are non-VAT registered. required: false vat_id: description: The entity's VAT (Value Added Tax) identification number. This field is required for entities that are VAT-registered. required: false line_item: allOf: - $ref: '#/components/schemas/LineItemFields' description: Object describing the required fields for line items default: measure_unit: description: Unit used to measure the quantity of the product (e.g. items, meters, kilograms) required: false tax_rate_value: description: 'Percent minor units. Example: 12.5% is 1250. This field is only required on invoices issued by entities in the US, Pakistan, and other unsupported countries.' required: false vat_rate_id: description: Unique identifier of the vat rate object. This field is required for all entities in supported countries except the US and Pakistan. required: false additionalProperties: false type: object examples: - line_item: vat_rate_id: required: true description: Unique identifier of the vat rate object. This field is required for all entities in supported countries except the US and Pakistan. tax_rate_value: required: false description: 'Percent minor units. Example: 12.5% is 1250. This field is only required on invoices issued by entities in the US, Pakistan, and other unsupported countries.' measure_unit: required: true description: Unit used to measure the quantity of the product (e.g. items, meters, kilograms) entity: tax_id: required: false description: The entity's taxpayer identification number or tax ID. This field is required for entities that are non-VAT registered. vat_id: required: true description: The entity's VAT (Value Added Tax) identification number. This field is required for entities that are VAT-registered. counterpart: tax_id: required: false description: The counterpart's taxpayer identification number or tax ID. For identification purposes, this field may be required for counterparts that are not VAT-registered. vat_id: required: true description: The counterpart's VAT (Value Added Tax) identification number. This field is required for counterparts that are VAT-registered. ReceivableDeclinePayload: properties: comment: type: string description: Field with a comment on why the client declined this Quote example: The quote was declined for some reasons additionalProperties: false type: object description: Payload for decline a Qoute with a comment ReceivablesSearchRequest: properties: amount: type: integer description: Return only receivables with the exact specified total amount. The amount must be specified in the [minor units](https://docs.monite.com/references/currencies#minor-units) of currency. For example, $12.5 is represented as 1250. amount__gt: type: integer description: Return only receivables whose total amount (in minor units) exceeds the specified value. amount__gte: type: integer description: Return only receivables whose total amount (in minor units) is greater than or equal to the specified value. amount__lt: type: integer description: Return only receivables whose total amount (in minor units) is less than the specified value. amount__lte: type: integer description: Return only receivables whose total amount (in minor units) is less than or equal to the specified value. based_on: type: string format: uuid description: 'This parameter accepts a quote ID or an invoice ID. * Specify a quote ID to find invoices created from this quote. * Specify an invoice ID to find credit notes created for this invoice. Valid but nonexistent IDs do not raise errors but produce no results.' counterpart_id: type: string format: uuid description: 'Return only receivables created for the counterpart with the specified ID. Counterparts that have been deleted but have associated receivables will still return results here because the receivables contain a frozen copy of the counterpart data. If the specified counterpart ID does not exist and never existed, no results are returned.' counterpart_name: type: string description: Return only receivables created for counterparts with the specified name (exact match, case-sensitive). For counterparts of `type` = `individual`, the full name is formatted as `first_name last_name`. counterpart_name__contains: type: string description: Return only receivables created for counterparts whose name contains the specified string (case-sensitive). counterpart_name__icontains: type: string description: Return only receivables created for counterparts whose name contains the specified string (case-insensitive). created_at__gt: type: string format: date-time description: Return only receivables created after the specified date and time. The value must be in the ISO 8601 format `YYYY-MM-DDThh:mm[:ss][Z|±hh:mm]`. Milliseconds are ignored. created_at__gte: type: string format: date-time description: Return only receivables created on or after the specified date and time. created_at__lt: type: string format: date-time description: Return only receivables created before the specified date and time. created_at__lte: type: string format: date-time description: Return only receivables created before or on the specified date and time. document_id: type: string description: Return a receivable 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`). document_id__contains: type: string description: Return only receivables whose document number (`document_id`) contains the specified string (case-sensitive). document_id__icontains: type: string description: Return only receivables whose document number (`document_id`) contains the specified string (case-insensitive). due_date__gt: type: string format: date description: 'Return invoices that are due after the specified date (exclusive, `YYYY-MM-DD`). This filter excludes quotes, credit notes, and draft invoices.' due_date__gte: type: string format: date description: 'Return invoices that are due on or after the specified date (`YYYY-MM-DD`). This filter excludes quotes, credit notes, and draft invoices.' due_date__lt: type: string format: date description: 'Return invoices that are due before the specified date (exclusive, `YYYY-MM-DD`). This filter excludes quotes, credit notes, and draft invoices.' due_date__lte: type: string format: date description: 'Return invoices that are due before or on the specified date (`YYYY-MM-DD`). This filter excludes quotes, credit notes, and draft invoices.' entity_user_id: type: string format: uuid description: 'Return only receivables created by the entity user with the specified ID. To query receivables by multiple user IDs at once, use the `entity_user_id__in` parameter instead. If the request is authenticated using an entity user token, this user must have the `receivable.read.allowed` (rather than `allowed_for_own`) permission to be able to query receivables created by other users. IDs of deleted users will still produce results here if those users had associated receivables. Valid but nonexistent user IDs do not raise errors but produce no results.' entity_user_id__in: items: type: string format: uuid type: array has_due_date: type: boolean description: Return only receivables that have a due date set. true=only invoices with due_date, false=only invoices without due_date id__in: items: type: string format: uuid type: array issue_date__gt: type: string format: date-time description: Return only non-draft receivables that were issued after the specified date and time. The value must be in the ISO 8601 format `YYYY-MM-DDThh:mm[:ss][Z|±hh:mm]`. Milliseconds are ignored. issue_date__gte: type: string format: date-time description: Return only non-draft receivables that were issued on or after the specified date and time. issue_date__lt: type: string format: date-time description: Return only non-draft receivables that were issued before the specified date and time. issue_date__lte: type: string format: date-time description: Return only non-draft receivables that were issued before or on the specified date and time. limit: type: integer maximum: 250.0 minimum: 1.0 default: 100 order: allOf: - $ref: '#/components/schemas/OrderEnum' default: asc pagination_token: type: string product_ids: items: type: string format: uuid type: array product_ids__in: items: type: string format: uuid type: array project_id: type: string format: uuid description: Return only receivables assigned to the project with the specified ID. Valid but nonexistent project IDs do not raise errors but return no results. project_id__in: items: type: string format: uuid type: array search_text: type: string description: Case-insensitive and partial match search for the specified text in the `document_id` and `counterpart_name` fields of the receivables. sort: $ref: '#/components/schemas/ReceivableCursorFields2' status: type: string enum: - draft - issuing - issued - failed - accepted - expired - declined - recurring - partially_paid - paid - overdue - uncollectible - canceled description: 'Return only receivables that have the specified status. See the applicable [invoice statuses](https://docs.monite.com/accounts-receivable/invoices/index), [quote statuses](https://docs.monite.com/accounts-receivable/quotes/index), and [credit note statuses](https://docs.monite.com/accounts-receivable/credit-notes#credit-note-lifecycle). To query multiple statuses at once, use the `status__in` parameter instead.' status__in: items: type: string type: array tag_ids: items: type: string format: uuid type: array tag_ids__in: items: type: string format: uuid type: array type: allOf: - $ref: '#/components/schemas/ReceivableType' description: Return only receivables of the specified type. Use this parameter to get only invoices, or only quotes, or only credit notes. additionalProperties: false type: object UpdateQuotePayload: properties: quote: $ref: '#/components/schemas/UpdateQuote' additionalProperties: false type: object required: - quote description: 'Helper class that provides a standard way to create an ABC using inheritance.' ProductServiceTypeEnum: type: string enum: - product - service ReceivablesStatusEnum: type: string enum: - draft - issuing - issued - failed - accepted - expired - declined - recurring - partially_paid - paid - overdue - uncollectible - canceled - deleted description: 'This Enum the results of combining two types of statuses from QuoteStateEnum, CreditNoteStateEnum and InvoiceStateEnum. You shouldn''t use it in your scenarios if only for edge cases in workers, but ideally need to remove this shared Enum.' ReceivablePreviewSchema: 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: - height - url - width description: A preview image generated for a file. TaxStatusEnum: type: string enum: - taxable - exempt - non_taxable LineItemUpdate: properties: discount: allOf: - $ref: '#/components/schemas/Discount' description: The discount for a product. price: type: integer maximum: 9007199254740991.0 minimum: 0.0 description: The actual price of the product in [minor units](https://docs.monite.com/references/currencies#minor-units). quantity: type: number maximum: 2147483647.0 minimum: 0.0 description: The quantity of each of the goods, materials, or services listed in the receivable. tax_rate_name: type: string maxLength: 64 description: Specifies the display name of the tax rate. This field is applicable only when tax_rate_value is also provided. tax_status: allOf: - $ref: '#/components/schemas/TaxStatusEnum' description: 'Tax applicability status of the line item. Possible values: * `taxable` (default) - Standard tax behavior. Requires the tax rate to be specified. * `exempt` - Line item is exempt from taxes. Exempt items are not included in total tax calculations. * `non_taxable` - Line item is outside the tax scope entirely, cannot have tax rates.' vat_rate_id: type: string format: uuid description: Unique identifier of the vat rate object. This field is required for all entities in supported countries except the US and Pakistan. additionalProperties: false type: object ReceivableFacadeCreateQuotePayload: properties: attachments: items: $ref: '#/components/schemas/AttachmentRequest' type: array minItems: 1 description: List of attachments to include with the receivable. Each attachment can be configured for email inclusion. If not provided, no attachments will be associated. commercial_condition_description: type: string counterpart_billing_address: allOf: - $ref: '#/components/schemas/ReceivablesCounterpartAddress' description: Address of invoicing, need to state as a separate fields for some countries if it differs from address of a company. counterpart_business_type: type: string maxLength: 50 description: Different types of companies for different countries, ex. GmbH, SAS, SNC, etc. counterpart_id: type: string format: uuid counterpart_shipping_address: allOf: - $ref: '#/components/schemas/ReceivablesCounterpartAddress' description: Address where goods were shipped / where services were provided. counterpart_vat_id_id: type: string format: uuid description: Counterpart VAT ID id currency: $ref: '#/components/schemas/CurrencyEnum' deduction_amount: type: integer maximum: 9007199254740991.0 minimum: 0.0 description: The amount of tax deducted in minor units deprecated: true deduction_memo: type: string description: A note with additional information about a tax deduction deprecated: true deductions: items: $ref: '#/components/schemas/DeductionItem' type: array maxItems: 10 description: List of deductions applied to the receivable (maximum 10 deductions allowed) discount: allOf: - $ref: '#/components/schemas/Discount' description: The discount for a receivable. document_id: type: string maxLength: 100 minLength: 1 description: The document number of the receivable, which will appear in the PDF document. Can be set manually only in the [non-compliant mode](https://docs.monite.com/accounts-receivable/regulatory-compliance/invoice-compliance). Otherwise (or if omitted), it will be generated automatically based on the entity's [document number customization](https://docs.monite.com/advanced/document-number-customization) settings when the document is issued. examples: - INV-0001 - 2024-027 - CUST/2024/00027 document_rendering: allOf: - $ref: '#/components/schemas/DocumentRenderingSettings' description: Settings for rendering documents in PDF format, including settings for line items and specific document types. entity: $ref: '#/components/schemas/ReceivableEntityBase' entity_bank_account_id: type: string format: uuid description: Entity bank account ID entity_vat_id_id: type: string format: uuid description: Entity VAT ID id expiry_date: type: string format: date description: The date (in ISO 8601 format) until which the quote is valid. footer: type: string description: Optional text displayed below the line items table in the PDF. line_items: items: $ref: '#/components/schemas/LineItem' type: array memo: type: string description: A note with additional information for a receivable partner_metadata: type: object description: Metadata for partner needs project_id: type: string format: uuid description: A project related to current receivable quote_accept_page_url: type: string maxLength: 65536 minLength: 1 format: uri description: Link for custom quote accept page signature_required: type: boolean description: Whether acceptance a quote requires a signature. tag_ids: items: type: string format: uuid type: array description: A list of IDs of user-defined tags (labels) assigned to this receivable. default: [] trade_name: type: string maxLength: 255 description: Trade name of the entity type: type: string enum: - quote description: The type of the document uploaded. vat_exempt: type: boolean description: Indicates whether the goods, materials, or services listed in the receivable are exempt from VAT or not. vat_exemption_rationale: type: string description: The reason for the VAT exemption, if applicable. vat_mode: allOf: - $ref: '#/components/schemas/VatModeEnum' description: Defines whether the prices of products in receivable will already include VAT or not. withholding_tax_rate: type: integer maximum: 10000.0 minimum: 0.0 description: The amount of tax withheld in percent minor units additionalProperties: false type: object required: - counterpart_id - currency - line_items - type UpdateProductForCreditNote: properties: old_price: type: integer maximum: 9007199254740991.0 minimum: 1.0 description: The old price of the line item. Used to choose for which line item new price should be applied price_diff: type: integer maximum: 9007199254740991.0 minimum: 1.0 description: The price diff of the line item, i.e. applied discount quantity: type: number maximum: 2147483647.0 minimum: 1.0 description: The quantity of each of the goods, materials, or services listed in the receivable. additionalProperties: false type: object required: - quantity ReminderTypeEnum: type: string enum: - term_1 - term_2 - term_final - overdue LineItemProductMeasureUnit: properties: id: type: string format: uuid created_at: type: string format: date-time updated_at: type: string format: date-time description: type: string maxLength: 200 name: type: string maxLength: 100 minLength: 1 type: object required: - created_at - updated_at - name ReceivableMailCursorFields: type: string enum: - status - created_at - updated_at VatRateResponse: properties: id: type: string format: uuid description: Unique identifier of the vat rate object. created_at: type: string format: date-time description: Date/time when this rate was recorded in the table. updated_at: type: string format: date-time description: Date/time when this rate was updated in the table. components: items: $ref: '#/components/schemas/VatRateComponent' type: array maxItems: 3 minItems: 1 description: Sub-taxes included in the VAT. 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 created_by: allOf: - $ref: '#/components/schemas/VatRateCreator' description: 'By whom this rate was recorded: monite employee | accounting system.' default: monite deprecated: true status: allOf: - $ref: '#/components/schemas/VatRateStatusEnum' description: 'Status for this vat rate: active | inactive.' valid_from: type: string format: date description: Date starting from when this rate can be used. valid_until: type: string format: date description: Date when this rate was depreciated, after this date rate cannot be used. value: type: integer maximum: 10000.0 minimum: 0.0 description: 'Percent minor units. Example: 12.5% is 1250.' type: object required: - id - created_at - updated_at - country - value ReceivableCursorFields: type: string enum: - counterpart_name - counterpart_id - amount - total_amount - discounted_subtotal - status - due_date - issue_date - document_id - created_at - project_id UpdateIssuedInvoice: properties: attachments: items: $ref: '#/components/schemas/AttachmentRequest' type: array minItems: 1 description: List of attachments to include with the receivable. Each attachment can be configured for email inclusion. If not provided, no attachments will be associated. contact_id: type: string format: uuid description: Unique ID of the counterpart contact. counterpart_id: type: string format: uuid description: Id of a new or updated counterpart counterpart_vat_id_id: type: string format: uuid description: Counterpart VAT ID id document_id: type: string maxLength: 100 minLength: 1 description: The document number of the receivable, which will appear in the PDF document. Can be set manually only in the [non-compliant mode](https://docs.monite.com/accounts-receivable/regulatory-compliance/invoice-compliance). Otherwise (or if omitted), it will be generated automatically based on the entity's [document number customization](https://docs.monite.com/advanced/document-number-customization) settings when the document is issued. examples: - INV-0001 - 2024-027 - CUST/2024/00027 document_rendering: allOf: - $ref: '#/components/schemas/DocumentRenderingSettings' description: Settings for rendering documents in PDF format, including settings for line items and specific document types. due_date: type: string format: date description: The date by which the invoice must be paid. entity: anyOf: - $ref: '#/components/schemas/ReceivableEntityOrganizationRequest' - $ref: '#/components/schemas/ReceivableEntityIndividualRequest' entity_address: $ref: '#/components/schemas/ReceivableEntityAddressSchema' entity_vat_id_id: type: string format: uuid description: Entity VAT ID id footer: type: string description: Optional text displayed below the line items table in the PDF. fulfillment_date: type: string format: date description: 'The date when the goods are shipped or the service is provided. Can be a current, past, or future date. Some countries require the fulfillment date in invoices for regulatory compliance. In this case, if the fulfillment date was not provided by the user, it is automatically set to the invoice issue date once the invoice gets issued. In countries where the fulfillment date is optional, Monite does not auto-assign it if it was omitted by the user.' issue_date: type: string format: date-time description: The datetime when the invoice was issued memo: type: string description: A note with additional information for a receivable overdue_reminder_id: type: string format: uuid partner_metadata: type: object description: Metadata for partner needs payment_reminder_id: type: string format: uuid payment_terms: $ref: '#/components/schemas/InlinePaymentTermsRequestPayload' payment_terms_id: type: string format: uuid project_id: type: string format: uuid description: A project related to current receivable tag_ids: items: type: string format: uuid type: array description: A list of IDs of user-defined tags (labels) assigned to this receivable. default: [] additionalProperties: false type: object MailSentEventData: properties: mail_id: type: string format: uuid description: ID of the email sending operation. Can be used to get the email sending status from `GET /receivables/{receivable_id}/mails/{mail_id}`. examples: - d6185c8d-527c-4586-84c9-95881e7ba19f mail_status: allOf: - $ref: '#/components/schemas/ReceivableMailStatusEnum' description: The overall email sending status across all recipients. recipients: allOf: - $ref: '#/components/schemas/ReceivableMailRecipients' description: Contains a list of email recipients (To, CC, BCC) and the email sending status for each recipient. additionalProperties: false type: object required: - mail_id - mail_status - recipients description: Contains information about a sent email. VatIDTypeEnum: type: string enum: - ae_trn - au_abn - au_arn - bg_uic - br_cnpj - br_cpf - ca_bn - ca_gst_hst - ca_pst_bc - ca_pst_mb - ca_pst_sk - ca_qst - ch_vat - cl_tin - es_cif - eu_oss_vat - eu_vat - gb_vat - ge_vat - hk_br - hu_tin - id_npwp - il_vat - in_gst - is_vat - jp_cn - jp_rn - kr_brn - li_uid - mx_rfc - my_frp - my_itn - my_sst - no_vat - nz_gst - ru_inn - ru_kpp - sa_vat - sg_gst - sg_uen - si_tin - th_vat - tw_vat - ua_vat - us_ein - za_vat - unknown QuoteAcceptRequest: properties: signature: allOf: - $ref: '#/components/schemas/Signature' description: A digital signature, if required for quote acceptance additionalProperties: false type: object ReceivableEntityIndividual: properties: email: type: string format: email description: An email of the entity first_name: type: string description: The first name of the entity issuing the receivable last_name: type: string description: The last name of the entity issuing the receivable logo: type: string maxLength: 2083 minLength: 1 format: uri description: A link to the entity logo phone: type: string description: A phone number of the entity registration_authority: type: string description: The registration authority of the entity registration_number: type: string description: The registration number of the entity tax_id: type: string description: The Tax ID of the entity issuing the receivable type: type: string enum: - individual description: The entity type website: type: string maxLength: 2083 minLength: 1 format: uri description: A website of the entity type: object required: - first_name - last_name - type description: A Response schema for an entity of individual type ReceivableSendResponse: properties: mail_id: type: string format: uuid additionalProperties: false type: object required: - mail_id description: A schema for returning a response an email with a link to receivable document has been sent ReminderMailSentEventData: properties: mail_id: type: string format: uuid description: ID of the email sending operation. Can be used to get the email sending status from `GET /receivables/{receivable_id}/mails/{mail_id}`. examples: - d6185c8d-527c-4586-84c9-95881e7ba19f mail_status: allOf: - $ref: '#/components/schemas/ReceivableMailStatusEnum' description: The overall email sending status across all recipients. recipients: allOf: - $ref: '#/components/schemas/ReceivableMailRecipients' description: Contains a list of email recipients (To, CC, BCC) and the email sending status for each recipient. term: allOf: - $ref: '#/components/schemas/ReminderTypeEnum' description: 'Invoice reminder type: * `term_1` - [payment reminder](https://docs.monite.com/accounts-receivable/invoices/payment-reminders) sent before discount date 1, * `term_2` - payment reminder sent before discount date 2, * `term_final` - payment reminder sent before the invoice due date. * `overdue` - [overdue reminder](https://docs.monite.com/accounts-receivable/invoices/overdue-reminders) sent after the due date.' additionalProperties: false type: object required: - mail_id - mail_status - recipients - term description: Contains information about an invoice reminder sent via email. StatusChangedEventData: properties: new_status: allOf: - $ref: '#/components/schemas/ReceivablesStatusEnum' description: The new status of a document. examples: - issued old_status: allOf: - $ref: '#/components/schemas/ReceivablesStatusEnum' description: The old status of a document. examples: - draft additionalProperties: false type: object required: - new_status - old_status description: 'Contains information about a document''s status change. See the applicable [invoice statuses](https://docs.monite.com/accounts-receivable/invoices/index), [quote statuses](https://docs.monite.com/accounts-receivable/quotes/index), and [credit note statuses](https://docs.monite.com/accounts-receivable/credit-notes#credit-note-lifecycle).' Recipients: properties: bcc: items: type: string format: email type: array cc: items: type: string format: email type: array to: items: type: string format: email type: array additionalProperties: false type: object ReceivableEntityIndividualRequest: properties: email: type: string format: email description: An email of the entity first_name: type: string description: The first name of the entity issuing the receivable last_name: type: string description: The last name of the entity issuing the receivable logo: type: string maxLength: 2083 minLength: 1 format: uri description: A link to the entity logo phone: type: string description: A phone number of the entity registration_authority: type: string description: The registration authority of the entity registration_number: type: string description: The registration number of the entity tax_id: type: string description: The Tax ID of the entity issuing the receivable type: type: string enum: - individual description: The entity type website: type: string maxLength: 2083 minLength: 1 format: uri description: A website of the entity additionalProperties: false type: object required: - first_name - last_name - type description: A Request schema for an entity of individual type InlinePaymentTermsRequestPayload: properties: term_1: allOf: - $ref: '#/components/schemas/InlineTermDiscount' description: The first tier of the payment term. Represents the terms of the first early discount. term_2: allOf: - $ref: '#/components/schemas/InlineTermDiscount' description: The second tier of the payment term. Defines the terms of the second early discount. term_final: allOf: - $ref: '#/components/schemas/InlineTermFinal' description: The final tier of the payment term. Defines the invoice due date. additionalProperties: false type: object required: - term_final EntityFields: properties: tax_id: allOf: - $ref: '#/components/schemas/FieldSchema' description: Object describing the required field `tax_id` of an entity default: description: The entity's taxpayer identification number or tax ID. This field is required for entities that are non-VAT registered. required: false vat_id: allOf: - $ref: '#/components/schemas/FieldSchema' description: Object describing the required field `vat_id` of an entity default: description: The entity's VAT (Value Added Tax) identification number. This field is required for entities that are VAT-registered. required: false additionalProperties: false type: object ReceivablePartiallyPaidPayload: properties: amount_paid: type: integer maximum: 9007199254740991.0 minimum: 1.0 description: How much has been paid on the invoice (in minor units). comment: type: string description: Optional comment explaining how the payment was made. additionalProperties: false type: object required: - amount_paid SuccessResult: properties: success: type: boolean default: true type: object RelatedDocuments: properties: credit_note_ids: items: type: string format: uuid type: array proforma_invoice_id: type: string format: uuid additionalProperties: false type: object ResponseItem: properties: discount: allOf: - $ref: '#/components/schemas/Discount' description: The discount for a product. product: $ref: '#/components/schemas/LineItemProduct' quantity: type: number maximum: 2147483647.0 minimum: 0.0 description: The quantity of each of the goods, materials, or services listed in the receivable. tax_status: allOf: - $ref: '#/components/schemas/TaxStatusEnum' description: 'Tax applicability status of the line item. Possible values: * `taxable` (default) - Standard tax behavior. Requires the tax rate to be specified. * `exempt` - Line item is exempt from taxes. Exempt items are not included in total tax calculations. * `non_taxable` - Line item is outside the tax scope entirely, cannot have tax rates.' default: taxable total_after_vat: type: integer maximum: 9007199254740991.0 description: Total of line_item after VAT with applied line item discount in [minor units](https://docs.monite.com/references/currencies#minor-units). total_before_vat: type: integer maximum: 9007199254740991.0 description: Total of line_item before VAT in [minor units](https://docs.monite.com/references/currencies#minor-units). type: object required: - product - quantity - total_after_vat - total_before_vat 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. ReceivableTemplatesVariable: properties: description: type: string name: type: string additionalProperties: false type: object required: - description - name DeductionItem: properties: amount: type: integer maximum: 9007199254740991.0 minimum: 0.0 description: The amount of the deduction in minor units(https://docs.monite.com/references/currencies#minor-units) memo: type: string maxLength: 1000 description: A note with additional information about this deduction name: type: string maxLength: 100 minLength: 1 description: Name or title of this deduction additionalProperties: false type: object required: - amount - name VatRateComponent: properties: name: type: string maxLength: 64 description: Display name of the Tax. value: type: number maximum: 10000.0 minimum: 0.0 description: 'Percent multiplied by a 100. Example: 12.125% is 1212.5. Will be rounded to 2 decimal places' additionalProperties: false type: object required: - name - value BasedOnTransitionType: type: string enum: - invoice - credit_note ReceivablesRepresentationOfEntityBankAccount: properties: id: type: string format: uuid description: Unique ID of the entity bank account. account_holder_name: type: string description: Account holder's name account_number: type: string description: Account number (required if IBAN is not provided) bank_name: type: string description: The name of the entity's bank account. bic: type: string description: The BIC of the entity's bank account. country: $ref: '#/components/schemas/AllowedCountries' currency: $ref: '#/components/schemas/CurrencyEnum' display_name: type: string iban: type: string description: The IBAN of the entity's bank account. is_default: type: boolean description: Marks if a bank account should be used by default. Only 1 can be True default: false routing_number: type: string description: Routing number (US) sort_code: type: string description: Sort code (GB) was_created_by_user_id: type: string format: uuid type: object QuoteStateEnum: type: string enum: - draft - issued - accepted - expired - declined - deleted OrderEnum: type: string enum: - asc - desc UpdateCreditNotePayload: properties: credit_note: $ref: '#/components/schemas/UpdateCreditNote' additionalProperties: false type: object required: - credit_note description: 'Helper class that provides a standard way to create an ABC using inheritance.' ReceivableMailPaginationResponse: properties: data: items: $ref: '#/components/schemas/ReceivableMailResponse' 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 Price: properties: currency: allOf: - $ref: '#/components/schemas/CurrencyEnum' description: The currency in which the price of the product is set. value: type: integer maximum: 9007199254740991.0 minimum: 0.0 description: The actual price of the product. additionalProperties: false type: object required: - currency - value VariablesType: type: string enum: - quote - invoice - credit_note - discount_reminder - final_reminder - overdue_reminder ReceivablesCounterpartAddress: 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 required: - city - country - line1 - postal_code description: Address information. UpdateInvoicePayload: properties: invoice: $ref: '#/components/schemas/UpdateInvoice' additionalProperties: false type: object required: - invoice description: 'Helper class that provides a standard way to create an ABC using inheritance.' ReceivableMailRecipientState: properties: email: type: string format: email description: An email address of the recipient. error: type: string description: An error message in case the mailing was unsuccessful. is_success: type: boolean description: Whether mail was sent successfully. additionalProperties: false type: object required: - email - is_success InvoiceRenderingSettings: properties: display_entity_bank_account: type: boolean description: If set to `true`, the entity's bank account details will be displayed on the invoice PDF. default: true additionalProperties: false type: object ReceivablePageSchema: 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 - number - size - 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.' ErrorSchema: properties: message: type: string type: object required: - message UpdateLineItems: properties: data: items: $ref: '#/components/schemas/LineItem' type: array additionalProperties: false type: object required: - data ReceivableHistoryEventTypeEnum: type: string enum: - status_changed - receivable_created - receivable_updated - based_on_receivable_created - payment_received - mail_sent - payment_reminder_mail_sent - overdue_reminder_mail_sent UpdateInvoice: properties: attachments: items: $ref: '#/components/schemas/AttachmentRequest' type: array minItems: 1 description: List of attachments to include with the receivable. Each attachment can be configured for email inclusion. If not provided, no attachments will be associated. contact_id: type: string format: uuid description: Unique ID of the counterpart contact. counterpart_billing_address: allOf: - $ref: '#/components/schemas/ReceivablesCounterpartAddress' description: Address of invoicing, need to state as a separate fields for some countries if it differs from address of a company. counterpart_einvoicing_credentials_id: type: string format: uuid description: E-invoicing credentials ID of the counterpart counterpart_id: type: string format: uuid description: Unique ID of the counterpart. counterpart_shipping_address: allOf: - $ref: '#/components/schemas/ReceivablesCounterpartAddress' description: Address where goods were shipped / where services were provided. counterpart_vat_id_id: type: string format: uuid description: Counterpart VAT ID id currency: $ref: '#/components/schemas/CurrencyEnum' deduction_amount: type: integer maximum: 9007199254740991.0 minimum: 0.0 description: The amount of tax deducted in minor units deprecated: true deduction_memo: type: string description: A note with additional information about a tax deduction deprecated: true deductions: items: $ref: '#/components/schemas/DeductionItem' type: array maxItems: 10 description: List of deductions applied to the receivable (maximum 10 deductions allowed) discount: allOf: - $ref: '#/components/schemas/Discount' description: The discount for a receivable. document_id: type: string maxLength: 100 minLength: 1 description: The document number of the receivable, which will appear in the PDF document. Can be set manually only in the [non-compliant mode](https://docs.monite.com/accounts-receivable/regulatory-compliance/invoice-compliance). Otherwise (or if omitted), it will be generated automatically based on the entity's [document number customization](https://docs.monite.com/advanced/document-number-customization) settings when the document is issued. examples: - INV-0001 - 2024-027 - CUST/2024/00027 document_rendering: allOf: - $ref: '#/components/schemas/DocumentRenderingSettings' description: Settings for rendering documents in PDF format, including settings for line items and specific document types. due_date: type: string format: date description: The date by which the invoice must be paid. entity: $ref: '#/components/schemas/ReceivableEntityBase' entity_bank_account_id: type: string format: uuid description: Entity bank account ID entity_vat_id_id: type: string format: uuid description: Entity VAT ID id footer: type: string description: Optional text displayed below the line items table in the PDF. fulfillment_date: type: string format: date description: 'The date when the goods are shipped or the service is provided. Can be a current, past, or future date. Some countries require the fulfillment date in invoices for regulatory compliance. In this case, if the fulfillment date was not provided by the user, it is automatically set to the invoice issue date once the invoice gets issued. In countries where the fulfillment date is optional, Monite does not auto-assign it if it was omitted by the user.' is_einvoice: type: boolean description: Is this Invoice will be sent through E-invoice system line_items: items: $ref: '#/components/schemas/LineItemUpdate' type: array memo: type: string description: A note with additional information for a receivable network_credentials_id: type: string format: uuid description: E-invoicing network credentials ID of the entity overdue_reminder_id: type: string format: uuid partner_metadata: type: object description: Metadata for partner needs payment_page_url: type: string maxLength: 2083 minLength: 1 format: uri description: Link to your invoice's custom payment rails or external payment link. payment_reminder_id: type: string format: uuid payment_terms: $ref: '#/components/schemas/InlinePaymentTermsRequestPayload' payment_terms_id: type: string format: uuid description: Unique ID of the payment terms. project_id: type: string format: uuid description: A project related to current receivable tag_ids: items: type: string format: uuid type: array description: A list of IDs of user-defined tags (labels) assigned to this receivable. trade_name: type: string maxLength: 255 description: Trade name of the entity vat_exempt: type: boolean description: Indicates whether the goods, materials, or services listed in the receivable are exempt from VAT or not. vat_exemption_rationale: type: string description: The reason for the VAT exemption, if applicable. withholding_tax_rate: type: integer maximum: 10000.0 minimum: 0.0 description: The amount of tax withheld in percent minor units additionalProperties: false type: object CreditNoteRenderingSettings: properties: display_entity_bank_account: type: boolean description: If set to `true`, the entity's bank account details will be displayed on the credit note PDF. default: true additionalProperties: false type: object ReceivableFacadeCreateInvoicePayload: properties: attachments: items: $ref: '#/components/schemas/AttachmentRequest' type: array minItems: 1 description: List of attachments to include with the receivable. Each attachment can be configured for email inclusion. If not provided, no attachments will be associated. commercial_condition_description: type: string counterpart_billing_address: allOf: - $ref: '#/components/schemas/ReceivablesCounterpartAddress' description: Address of invoicing, need to state as a separate fields for some countries if it differs from address of a company. counterpart_business_type: type: string maxLength: 50 description: Different types of companies for different countries, ex. GmbH, SAS, SNC, etc. counterpart_einvoicing_credentials_id: type: string format: uuid description: E-invoicing credentials ID of the counterpart counterpart_id: type: string format: uuid counterpart_shipping_address: allOf: - $ref: '#/components/schemas/ReceivablesCounterpartAddress' description: Address where goods were shipped / where services were provided. counterpart_vat_id_id: type: string format: uuid description: Counterpart VAT ID id currency: $ref: '#/components/schemas/CurrencyEnum' deduction_amount: type: integer maximum: 9007199254740991.0 minimum: 0.0 description: The amount of tax deducted in minor units deprecated: true deduction_memo: type: string description: A note with additional information about a tax deduction deprecated: true deductions: items: $ref: '#/components/schemas/DeductionItem' type: array maxItems: 10 description: List of deductions applied to the receivable (maximum 10 deductions allowed) discount: allOf: - $ref: '#/components/schemas/Discount' description: The discount for a receivable. document_id: type: string maxLength: 100 minLength: 1 description: The document number of the receivable, which will appear in the PDF document. Can be set manually only in the [non-compliant mode](https://docs.monite.com/accounts-receivable/regulatory-compliance/invoice-compliance). Otherwise (or if omitted), it will be generated automatically based on the entity's [document number customization](https://docs.monite.com/advanced/document-number-customization) settings when the document is issued. examples: - INV-0001 - 2024-027 - CUST/2024/00027 document_rendering: allOf: - $ref: '#/components/schemas/DocumentRenderingSettings' description: Settings for rendering documents in PDF format, including settings for line items and specific document types. entity: $ref: '#/components/schemas/ReceivableEntityBase' entity_bank_account_id: type: string format: uuid description: Entity bank account ID entity_vat_id_id: type: string format: uuid description: Entity VAT ID id footer: type: string description: Optional text displayed below the line items table in the PDF. fulfillment_date: type: string format: date description: 'The date when the goods are shipped or the service is provided. Can be a current, past, or future date. Some countries require the fulfillment date in invoices for regulatory compliance. In this case, if the fulfillment date was not provided by the user, it is automatically set to the invoice issue date once the invoice gets issued. In countries where the fulfillment date is optional, Monite does not auto-assign it if it was omitted by the user.' is_einvoice: type: boolean description: Is this Invoice will be sent through E-invoice system default: false line_items: items: $ref: '#/components/schemas/LineItem' type: array memo: type: string description: A note with additional information for a receivable network_credentials_id: type: string format: uuid description: E-invoicing credentials ID of the entity overdue_reminder_id: type: string format: uuid partner_metadata: type: object description: Metadata for partner needs payment_page_url: type: string maxLength: 2083 minLength: 1 format: uri description: Link to the invoice's payment page. Either Monite's payment links or your custom payment links. payment_reminder_id: type: string format: uuid payment_terms: $ref: '#/components/schemas/InlinePaymentTermsRequestPayload' payment_terms_id: type: string format: uuid project_id: type: string format: uuid description: A project related to current receivable purchase_order: type: string maxLength: 100 description: Contain purchase order number. tag_ids: items: type: string format: uuid type: array description: A list of IDs of user-defined tags (labels) assigned to this receivable. default: [] trade_name: type: string maxLength: 255 description: Trade name of the entity type: type: string enum: - invoice description: The type of the document uploaded. vat_exempt: type: boolean description: Indicates whether the goods, materials, or services listed in the receivable are exempt from VAT or not. vat_exemption_rationale: type: string description: The reason for the VAT exemption, if applicable. vat_mode: allOf: - $ref: '#/components/schemas/VatModeEnum' description: Defines whether the prices of products in receivable will already include VAT or not. withholding_tax_rate: type: integer maximum: 10000.0 minimum: 0.0 description: The amount of tax withheld in percent minor units additionalProperties: false type: object required: - counterpart_id - currency - line_items - type ReceivableCursorFields2: type: string enum: - counterpart_name - counterpart_id - amount - total_amount - status - due_date - issue_date - document_id - created_at - project_id InvoiceResponsePayload: properties: id: type: string format: uuid created_at: type: string format: date-time description: Time at which the receivable was created. Timestamps follow the ISO 8601 standard. updated_at: type: string format: date-time description: Time at which the receivable was last updated. Timestamps follow the ISO 8601 standard. amount_due: type: integer maximum: 9007199254740991.0 description: How much is left to be paid in [minor units](https://docs.monite.com/references/currencies#minor-units). Equal 0 if the Invoice is fully paid. amount_paid: type: integer maximum: 9007199254740991.0 description: How much has been paid [minor units](https://docs.monite.com/references/currencies#minor-units) amount_to_pay: type: integer maximum: 9007199254740991.0 description: How much is left to be paid in in [minor units](https://docs.monite.com/references/currencies#minor-units), including payment_term discounts. attachments: items: $ref: '#/components/schemas/AttachmentResponse' type: array description: List of attachments to include with the receivable. Each attachment can be configured for email inclusion. If not provided, no attachments will be associated. based_on: type: string format: uuid description: The unique ID of a previous document related to the receivable if applicable. based_on_document_id: type: string description: The unique document ID of a previous document related to the receivable if applicable. comment: type: string description: Field with a comment for pay/partially/uncollectible info on this Invoice commercial_condition_description: type: string description: The commercial terms of the receivable (e.g. The products must be delivered in X days). counterpart_address: $ref: '#/components/schemas/ReceivablesCounterpartAddress' counterpart_billing_address: allOf: - $ref: '#/components/schemas/ReceivablesCounterpartAddress' description: Address of invoicing, need to state as a separate fields for some countries if it differs from address of a company. counterpart_business_type: type: string maxLength: 50 description: Different types of companies for different countries, ex. GmbH, SAS, SNC, etc. counterpart_contact: allOf: - $ref: '#/components/schemas/ReceivableCounterpartContact' description: Additional information about counterpart contacts. counterpart_einvoicing_credentials: allOf: - $ref: '#/components/schemas/EinvoicingCredentials' description: E-invoicing credentials of the counterpart counterpart_external_reference: type: string description: The external reference of the counterpart. counterpart_id: type: string format: uuid description: Unique ID of the counterpart. counterpart_name: type: string description: A legal name of a counterpart it is an organization or first and last name if it is an individual counterpart_shipping_address: allOf: - $ref: '#/components/schemas/ReceivablesCounterpartAddress' description: Address where goods were shipped / where services were provided. counterpart_tax_id: type: string description: The VAT/TAX ID of the counterpart. counterpart_type: allOf: - $ref: '#/components/schemas/CounterpartType' description: The type of the counterpart. counterpart_vat_id: $ref: '#/components/schemas/ReceivableCounterpartVatIDResponse' currency: allOf: - $ref: '#/components/schemas/CurrencyEnum' description: The currency used in the receivable. deduction_amount: type: integer maximum: 9007199254740991.0 minimum: 0.0 description: The amount of tax deducted in minor units deprecated: true deduction_memo: type: string description: A note with additional information about a tax deduction deprecated: true deductions: items: $ref: '#/components/schemas/DeductionItem' type: array maxItems: 10 description: List of deductions applied to the receivable (maximum 10 deductions allowed) discount: allOf: - $ref: '#/components/schemas/DiscountResponse' description: The discount for a receivable. discounted_subtotal: type: integer maximum: 9007199254740991.0 description: Total price of the receivable with discounts before taxes [minor units](https://docs.monite.com/references/currencies#minor-units). document_id: type: string description: The sequential code systematically assigned to invoices. document_rendering: allOf: - $ref: '#/components/schemas/DocumentRenderingSettings' description: Settings for rendering documents in PDF format, including settings for line items and specific document types. due_date: type: string format: date description: Optional field representing date until which invoice should be paid einvoice_error_comment: type: string description: Error that was returned by E-invoicing einvoice_file_url: type: string description: E-invoice XML file that was sent to the counterpart via an e-invoicing network. Available only if `is_einvoice` is `true`. entity: anyOf: - $ref: '#/components/schemas/ReceivableEntityOrganization' - $ref: '#/components/schemas/ReceivableEntityIndividual' entity_address: $ref: '#/components/schemas/ReceivableEntityAddressSchema' entity_bank_account: $ref: '#/components/schemas/ReceivablesRepresentationOfEntityBankAccount' entity_user_id: type: string format: uuid description: The entity user who created this document. entity_vat_id: $ref: '#/components/schemas/ReceivableEntityVatIDResponse' file: $ref: '#/components/schemas/ReceivableFileSchema' file_language: allOf: - $ref: '#/components/schemas/LanguageCodeEnum' description: The language of the customer-facing PDF file (`file_url`). The value matches the counterpart's `language` at the time when this PDF file was generated. file_url: type: string description: The receivable's PDF URL in the counterpart's default language. footer: type: string description: Optional text displayed below the line items table in the PDF. fulfillment_date: type: string format: date description: 'The date when the goods are shipped or the service is provided. Can be a current, past, or future date. Some countries require the fulfillment date in invoices for regulatory compliance. In this case, if the fulfillment date was not provided by the user, it is automatically set to the invoice issue date once the invoice gets issued. In countries where the fulfillment date is optional, Monite does not auto-assign it if it was omitted by the user.' is_einvoice: type: boolean description: Is this Invoice will be sent through E-invoice system default: false issue_date: type: string format: date-time description: Optional field for the issue of the entry. line_items: items: $ref: '#/components/schemas/ResponseItem' type: array memo: type: string description: A note with additional information for a receivable. network_credentials: allOf: - $ref: '#/components/schemas/EinvoicingCredentials' description: E-invoicing credentials of the entity original_file_language: allOf: - $ref: '#/components/schemas/LanguageCodeEnum' description: The language of the entity's copy of the PDF file (`original_file_url`). The value matches the entity's `language` at the time when this PDF file was generated. original_file_url: type: string description: The receivable's PDF URL in the entity's default language. overdue_reminder_id: type: string format: uuid paid_at: type: string format: date-time description: Date and time when the invoice was paid. partner_metadata: type: object description: Metadata for partner needs payment_page_url: type: string maxLength: 2083 minLength: 1 format: uri description: Link to the invoice's payment page. Either Monite's payment links or your custom payment links. payment_reminder_id: type: string format: uuid payment_terms: $ref: '#/components/schemas/PaymentTerms' project_id: type: string format: uuid description: A project related to current receivable purchase_order: type: string maxLength: 100 description: Contain purchase order number. recurrence_id: type: string format: uuid description: Stores an unique ID of a recurrence if the receivable is in a recurring status related_documents: allOf: - $ref: '#/components/schemas/RelatedDocuments' description: Ids of documents that relate to invoice. I.e credit notes, proforma invoices, etc. status: allOf: - $ref: '#/components/schemas/ReceivablesStatusEnum' description: The status of the receivable inside the receivable workflow. subtotal: type: integer maximum: 9007199254740991.0 description: The subtotal (excluding VAT), in [minor units](https://docs.monite.com/references/currencies#minor-units). subtotal_after_vat: type: integer maximum: 9007199254740991.0 description: The subtotal including VAT but without invoice discount, in [minor units](https://docs.monite.com/references/currencies#minor-units). tags: items: $ref: '#/components/schemas/TagReadSchema' type: array description: The list of tags for this receivable. default: [] total_amount: type: integer maximum: 9007199254740991.0 description: Total price of the receivable in [minor units](https://docs.monite.com/references/currencies#minor-units). Calculated as a subtotal + total_vat_amount. default: 0 total_amount_with_credit_notes: type: integer maximum: 9007199254740991.0 description: The total price of the receivable in [minor units](https://docs.monite.com/references/currencies#minor-units), including VAT and excluding all issued credit notes. total_deduction_amount: type: integer maximum: 9007199254740991.0 description: The total deduction amount of all deductions, in [minor units](https://docs.monite.com/references/currencies#minor-units). total_vat_amount: type: integer maximum: 9007199254740991.0 description: The total VAT of all line items, in [minor units](https://docs.monite.com/references/currencies#minor-units). total_vat_amounts: items: $ref: '#/components/schemas/TotalVatAmountItem' type: array description: List of total vat amount for each VAT, presented in receivable total_withholding_tax: type: integer description: Total price of the receivable with tax withheld in minor units trade_name: type: string maxLength: 255 description: Trade name of the entity type: type: string enum: - invoice description: The type of the document uploaded. vat_exempt: type: boolean description: Indicates whether the goods, materials, or services listed in the receivable are exempt from VAT or not. vat_exemption_rationale: type: string description: The reason for the VAT exemption, if applicable. vat_inclusive_discount_mode: allOf: - $ref: '#/components/schemas/VatModeEnum' description: Indicates whether the discount is applied to the VAT-inclusive or VAT-exclusive amount. default: exclusive vat_mode: allOf: - $ref: '#/components/schemas/VatModeEnum' description: Defines whether the prices of products in receivable will already include VAT or not. default: exclusive withholding_tax_rate: type: integer maximum: 10000.0 minimum: 0.0 description: The amount of tax withheld in percent minor units type: object required: - id - created_at - updated_at - amount_due - amount_paid - counterpart_address - counterpart_id - counterpart_type - currency - entity - entity_address - file_language - line_items - original_file_language - related_documents - status - total_amount_with_credit_notes - total_vat_amount - type 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 ReceivablePaidPayload: properties: comment: type: string description: Optional comment explaining how the payment was made. paid_at: type: string format: date-time description: Date and time when the invoice was paid. additionalProperties: false type: object ReceivableFileUrl: properties: file_url: type: string description: The receivable's PDF URL in the counterpart's default language. original_file_url: type: string description: The receivable's PDF URL in the entity's default language. type: object ErrorSchemaResponse: properties: error: $ref: '#/components/schemas/ErrorSchema' type: object required: - error MissingFields: properties: counterpart: items: type: string type: array description: Missing fields of counterpart. entity: items: type: string type: array description: Missing fields of entity. products: items: $ref: '#/components/schemas/MissingLineItemFields' type: array description: Missing fields of line items. receivable: items: type: string type: array description: Missing fields of receivable. vat_rates: items: type: string type: array description: List of invalid vat rates. warnings: allOf: - $ref: '#/components/schemas/ReceivablesRemindersWarningMessage' description: Warning message for payment reminder additionalProperties: false type: object PaymentReceivedEventData: properties: amount_due: type: integer description: The remaining amount due of the invoice, in [minor units](https://docs.monite.com/references/currencies#minor-units) of the currency. For example, $12.5 is represented as 1250. examples: - 0 amount_paid: type: integer description: The payment amount, in minor units of the currency. examples: - 1250 comment: type: string description: A user-defined comment about this payment, or `null` if no comment was provided. Comments are available only for payments recorded via `POST /receivables/{receivable_id}/mark_as_paid` and `POST /receivables/{receivable_id}/mark_as_partially_paid`. additionalProperties: false type: object required: - amount_due - amount_paid description: Contains information about a payment received for an invoice. LineItemsResponse: properties: data: items: $ref: '#/components/schemas/ResponseItem' type: array additionalProperties: false type: object required: - data MissingLineItemFields: properties: line_item_number: type: integer description: Order number of line item. missing_fields: items: type: string type: array description: Missing fields of line item. additionalProperties: false type: object required: - line_item_number - missing_fields ReceivableUpdatedEventData: properties: {} additionalProperties: false type: object TagCategory: type: string enum: - document_type - department - project - cost_center - vendor_type - payment_method - approval_status ReceivableEntityVatIDResponse: properties: id: type: string format: uuid country: $ref: '#/components/schemas/AllowedCountries' entity_id: type: string format: uuid type: allOf: - $ref: '#/components/schemas/VatIDTypeEnum' default: unknown example: eu_vat value: type: string maxLength: 32 example: '123456789' type: object required: - id - country - entity_id - value Signature: properties: email: type: string format: email description: The email of a person who signed a quote full_name: type: string maxLength: 255 minLength: 1 description: The full name of a person who signed a quote signature_image: type: string maxLength: 524288 minLength: 32 contentEncoding: base64 contentMediaType: image/png description: Base64 encoded PNG image of a signature additionalProperties: false type: object required: - email - full_name - signature_image QuoteResponsePayload: properties: id: type: string format: uuid created_at: type: string format: date-time description: Time at which the receivable was created. Timestamps follow the ISO 8601 standard. updated_at: type: string format: date-time description: Time at which the receivable was last updated. Timestamps follow the ISO 8601 standard. attachments: items: $ref: '#/components/schemas/AttachmentResponse' type: array description: List of attachments to include with the receivable. Each attachment can be configured for email inclusion. If not provided, no attachments will be associated. based_on: type: string format: uuid description: The unique ID of a previous document related to the receivable if applicable. based_on_document_id: type: string description: The unique document ID of a previous document related to the receivable if applicable. comment: type: string description: Field with a comment on why the client declined this Quote commercial_condition_description: type: string description: The commercial terms of the receivable (e.g. The products must be delivered in X days). counterpart_address: $ref: '#/components/schemas/ReceivablesCounterpartAddress' counterpart_billing_address: allOf: - $ref: '#/components/schemas/ReceivablesCounterpartAddress' description: Address of invoicing, need to state as a separate fields for some countries if it differs from address of a company. counterpart_business_type: type: string maxLength: 50 description: Different types of companies for different countries, ex. GmbH, SAS, SNC, etc. counterpart_contact: allOf: - $ref: '#/components/schemas/ReceivableCounterpartContact' description: Additional information about counterpart contacts. counterpart_external_reference: type: string description: The external reference of the counterpart. counterpart_id: type: string format: uuid description: Unique ID of the counterpart. counterpart_name: type: string description: A legal name of a counterpart it is an organization or first and last name if it is an individual counterpart_shipping_address: allOf: - $ref: '#/components/schemas/ReceivablesCounterpartAddress' description: Address where goods were shipped / where services were provided. counterpart_tax_id: type: string description: The VAT/TAX ID of the counterpart. counterpart_type: allOf: - $ref: '#/components/schemas/CounterpartType' description: The type of the counterpart. counterpart_vat_id: $ref: '#/components/schemas/ReceivableCounterpartVatIDResponse' currency: allOf: - $ref: '#/components/schemas/CurrencyEnum' description: The currency used in the receivable. deduction_amount: type: integer maximum: 9007199254740991.0 minimum: 0.0 description: The amount of tax deducted in minor units deprecated: true deduction_memo: type: string description: A note with additional information about a tax deduction deprecated: true deductions: items: $ref: '#/components/schemas/DeductionItem' type: array maxItems: 10 description: List of deductions applied to the receivable (maximum 10 deductions allowed) discount: allOf: - $ref: '#/components/schemas/DiscountResponse' description: The discount for a receivable. discounted_subtotal: type: integer maximum: 9007199254740991.0 description: Total price of the receivable with discounts before taxes [minor units](https://docs.monite.com/references/currencies#minor-units). document_id: type: string description: The sequential code systematically assigned to invoices. document_rendering: allOf: - $ref: '#/components/schemas/DocumentRenderingSettings' description: Settings for rendering documents in PDF format, including settings for line items and specific document types. due_date: type: string format: date description: Optional field representing date until which invoice should be paid einvoice_file_url: type: string description: E-invoice XML file that was sent to the counterpart via an e-invoicing network. Available only if `is_einvoice` is `true`. entity: anyOf: - $ref: '#/components/schemas/ReceivableEntityOrganization' - $ref: '#/components/schemas/ReceivableEntityIndividual' entity_address: $ref: '#/components/schemas/ReceivableEntityAddressSchema' entity_bank_account: $ref: '#/components/schemas/ReceivablesRepresentationOfEntityBankAccount' entity_user_id: type: string format: uuid description: The entity user who created this document. entity_vat_id: $ref: '#/components/schemas/ReceivableEntityVatIDResponse' expiry_date: type: string format: date description: The date (in ISO 8601 format) until which the quote is valid. file: $ref: '#/components/schemas/ReceivableFileSchema' file_language: allOf: - $ref: '#/components/schemas/LanguageCodeEnum' description: The language of the customer-facing PDF file (`file_url`). The value matches the counterpart's `language` at the time when this PDF file was generated. file_url: type: string description: The receivable's PDF URL in the counterpart's default language. footer: type: string description: Optional text displayed below the line items table in the PDF. issue_date: type: string format: date-time description: Optional field for the issue of the entry. line_items: items: $ref: '#/components/schemas/ResponseItem' type: array memo: type: string description: A note with additional information for a receivable. original_file_language: allOf: - $ref: '#/components/schemas/LanguageCodeEnum' description: The language of the entity's copy of the PDF file (`original_file_url`). The value matches the entity's `language` at the time when this PDF file was generated. original_file_url: type: string description: The receivable's PDF URL in the entity's default language. partner_metadata: type: object description: Metadata for partner needs project_id: type: string format: uuid description: A project related to current receivable quote_accept_page_url: type: string maxLength: 65536 minLength: 1 format: uri description: Link for custom quote accept page signature_required: type: boolean description: Whether acceptance a quote requires a signature. status: allOf: - $ref: '#/components/schemas/QuoteStateEnum' description: The status of the Quote inside the receivable workflow. subtotal: type: integer maximum: 9007199254740991.0 description: The subtotal (excluding VAT), in [minor units](https://docs.monite.com/references/currencies#minor-units). subtotal_after_vat: type: integer maximum: 9007199254740991.0 description: The subtotal including VAT but without invoice discount, in [minor units](https://docs.monite.com/references/currencies#minor-units). tags: items: $ref: '#/components/schemas/TagReadSchema' type: array description: The list of tags for this receivable. default: [] total_amount: type: integer maximum: 9007199254740991.0 description: Total price of the receivable in [minor units](https://docs.monite.com/references/currencies#minor-units). Calculated as a subtotal + total_vat_amount. default: 0 total_deduction_amount: type: integer maximum: 9007199254740991.0 description: The total deduction amount of all deductions, in [minor units](https://docs.monite.com/references/currencies#minor-units). total_vat_amount: type: integer maximum: 9007199254740991.0 description: The total VAT of all line items, in [minor units](https://docs.monite.com/references/currencies#minor-units). total_vat_amounts: items: $ref: '#/components/schemas/TotalVatAmountItem' type: array description: List of total vat amount for each VAT, presented in receivable total_withholding_tax: type: integer description: Total price of the receivable with tax withheld in minor units trade_name: type: string maxLength: 255 description: Trade name of the entity type: type: string enum: - quote description: The type of the document uploaded. vat_exempt: type: boolean description: Indicates whether the goods, materials, or services listed in the receivable are exempt from VAT or not. vat_exemption_rationale: type: string description: The reason for the VAT exemption, if applicable. vat_inclusive_discount_mode: allOf: - $ref: '#/components/schemas/VatModeEnum' description: Indicates whether the discount is applied to the VAT-inclusive or VAT-exclusive amount. default: exclusive vat_mode: allOf: - $ref: '#/components/schemas/VatModeEnum' description: Defines whether the prices of products in receivable will already include VAT or not. default: exclusive withholding_tax_rate: type: integer maximum: 10000.0 minimum: 0.0 description: The amount of tax withheld in percent minor units type: object required: - id - created_at - updated_at - counterpart_address - counterpart_id - counterpart_type - currency - entity - entity_address - file_language - line_items - original_file_language - status - total_vat_amount - type VatModeEnum: type: string enum: - exclusive - inclusive AttachmentRequest: properties: id: type: string format: uuid description: Unique ID of the file with file_type=attachment from /v1/files. include_in_email: type: boolean description: Indicates whether the file would be included in the email. default: false additionalProperties: false type: object required: - id ReceivableFacadeCreatePayload: anyOf: - $ref: '#/components/schemas/ReceivableFacadeCreateQuotePayload' - $ref: '#/components/schemas/ReceivableFacadeCreateInvoicePayload' - $ref: '#/components/schemas/ReceivableCreateBasedOnPayload' additionalProperties: false LineItemColumnSettings: properties: display: type: boolean default: true label: anyOf: - type: string maxLength: 32 minLength: 1 - type: 'null' description: Line item table column header to override Monite's default. If not set, the Monite's default will be used. additionalProperties: false type: object ReceivableUncollectiblePayload: properties: comment: type: string description: Optional comment explains why the Invoice goes uncollectible. additionalProperties: false type: object DocumentRenderingSettings: properties: credit_note: allOf: - $ref: '#/components/schemas/CreditNoteRenderingSettings' description: Credit note-specific rendering settings for PDF documents. display_entity_bank_account: type: boolean description: If set to `true`, the entity's bank account details will be displayed on the PDF documents. Defaults to `true`. default: true display_line_items: type: boolean description: If set to `true`, the line items table will be displayed on the quote PDF. Defaults to `true`. default: true invoice: allOf: - $ref: '#/components/schemas/InvoiceRenderingSettings' description: Invoice-specific rendering settings for PDF documents. line_items: allOf: - $ref: '#/components/schemas/LineItemsRenderingSettings' description: 'Settings for rendering line items in PDF documents. ' quote: allOf: - $ref: '#/components/schemas/QuoteRenderingSettings' description: Quote-specific rendering settings for PDF documents. type: object description: Settings for rendering documents in PDF format, including settings for line items and specific document types. ReceivableCounterpartVatIDResponse: properties: id: type: string format: uuid counterpart_id: type: string format: uuid country: $ref: '#/components/schemas/AllowedCountries' type: allOf: - $ref: '#/components/schemas/VatIDTypeEnum' default: unknown example: eu_vat value: type: string maxLength: 32 example: '123456789' additionalProperties: false type: object required: - id - counterpart_id - value ReceivableMailRecipients: properties: bcc: items: $ref: '#/components/schemas/ReceivableMailRecipientState' type: array cc: items: $ref: '#/components/schemas/ReceivableMailRecipientState' type: array to: items: $ref: '#/components/schemas/ReceivableMailRecipientState' type: array additionalProperties: false type: object ReceivablesRemindersWarningMessage: properties: payment_reminders: type: string description: Warning message for payment reminder additionalProperties: false type: object LineItem: properties: accounting_tax_rate_id: type: string format: uuid description: ID of the tax rate in the connected accounting system, to be used when pushing the invoice to that accounting system. Use `GET /accounting_tax_rates` to get these IDs. If omitted, Monite will attempt to match the tax rates based on their numeric value. discount: allOf: - $ref: '#/components/schemas/Discount' description: The discount for a product. product: allOf: - $ref: '#/components/schemas/LineItemProductCreate' description: Object of product. Can be used instead of product_id, created in product's catalog product_id: type: string format: uuid description: Unique identifier of the product. quantity: type: number maximum: 2147483647.0 minimum: 0.0 description: The quantity of each of the goods, materials, or services listed in the receivable. tax_rate_name: type: string maxLength: 64 minLength: 1 description: Specifies the display name of the tax rate. This field is applicable only when tax_rate_value is also provided. tax_status: allOf: - $ref: '#/components/schemas/TaxStatusEnum' description: 'Tax applicability status of the line item. Possible values: * `taxable` (default) - Standard tax behavior. Requires the tax rate to be specified. * `exempt` - Line item is exempt from taxes. Exempt items are not included in total tax calculations. * `non_taxable` - Line item is outside the tax scope entirely, cannot have tax rates.' default: taxable vat_rate_id: type: string format: uuid description: Unique identifier of the vat rate object. This field is required for all entities in supported countries except the US and Pakistan. additionalProperties: false type: object required: - quantity - vat_rate_id ReceivableCreatedEventData: properties: {} additionalProperties: false type: object ReceivableCounterpartContact: properties: address: allOf: - $ref: '#/components/schemas/ReceivablesCounterpartAddress' description: The contact address of the counterpart email: type: string format: email description: The contact email of the counterpart. example: marge@example.org first_name: type: string description: The first name of the counterpart contact. example: Marge last_name: type: string description: The last name of the counterpart contact. example: Smith phone: type: string description: The contact phone number of the counterpart. example: '55512378654' title: type: string description: The counterpart contact title (e.g. Dr., Mr., Mrs., Ms., etc). example: Dr. additionalProperties: false type: object required: - address - first_name - last_name ReceivablesSendResponse: properties: mail_ids: items: type: string format: uuid type: array additionalProperties: false type: object required: - mail_ids description: A schema for returning a response with list of ids by which user check sending status ReceivableMailStatusEnum: type: string enum: - pending - processing - sent - partially_sent - failed LanguageCodeEnum: type: string enum: - ab - aa - af - ak - sq - am - ar - an - hy - av - ae - ay - az - bm - ba - eu - be - bn - bi - bs - br - bg - my - ca - ch - ce - ny - zh - cu - cv - kw - co - cr - hr - cs - da - dv - nl - dz - en - eo - et - ee - fo - fj - fi - fr - fy - ff - gd - gl - lg - ka - de - el - kl - gn - gu - ht - ha - he - hz - hi - ho - hu - io - ig - id - ia - ie - iu - ik - ga - it - ja - jv - kn - kr - ks - kk - km - ki - rw - ky - kv - kg - ko - kj - ku - lo - la - lv - li - ln - lt - lu - lb - mk - mg - ms - ml - mt - gv - mi - mr - mh - mn - na - nv - nd - nr - ng - ne - 'no' - nb - nn - ii - oc - oj - om - os - pi - ps - fa - pl - pt - pa - qu - ro - rm - rn - ru - se - sm - sg - sa - sc - sr - sn - sd - si - sk - sl - so - st - es - su - sw - ss - sv - tl - ty - tg - ta - tt - te - th - bo - ti - to - ts - tn - tr - tk - tw - ug - uk - ur - uz - ve - vi - vo - wa - cy - wo - xh - yi - yo - za - zu BasedOnReceivableCreatedEventData: properties: receivable_id: type: string format: uuid description: The ID of the newly created receivable document. examples: - 1531cf6e-52f5-4203-acb2-7cc3a37660c6 type: allOf: - $ref: '#/components/schemas/ReceivableType' description: The type of the receivable document that was created based on the current document. additionalProperties: false type: object required: - receivable_id - type description: 'In invoice history, this object contains information about a credit note created for this invoice. In quote history, it contains information about an invoice created from this quote.' ReceivablePreviewResponse: properties: body_preview: type: string subject_preview: type: string additionalProperties: false type: object required: - body_preview - subject_preview description: A schema for receiving a request for previewing an email with a receivable document CounterpartFields: properties: tax_id: allOf: - $ref: '#/components/schemas/FieldSchema' description: Object describing the required field `tax_id` of an counterpart default: description: The counterpart's taxpayer identification number or tax ID. For identification purposes, this field may be required for counterparts that are not VAT-registered. required: false vat_id: allOf: - $ref: '#/components/schemas/FieldSchema' description: Object describing the required field `vat_id` of an counterpart default: description: The counterpart's VAT (Value Added Tax) identification number. This field is required for counterparts that are VAT-registered. required: false additionalProperties: false type: object UpdateQuote: properties: attachments: items: $ref: '#/components/schemas/AttachmentRequest' type: array minItems: 1 description: List of attachments to include with the receivable. Each attachment can be configured for email inclusion. If not provided, no attachments will be associated. contact_id: type: string format: uuid description: Unique ID of the counterpart contact. counterpart_billing_address: allOf: - $ref: '#/components/schemas/ReceivablesCounterpartAddress' description: Address of invoicing, need to state as a separate fields for some countries if it differs from address of a company. counterpart_id: type: string format: uuid description: Unique ID of the counterpart. counterpart_shipping_address: allOf: - $ref: '#/components/schemas/ReceivablesCounterpartAddress' description: Address where goods were shipped / where services were provided. counterpart_vat_id_id: type: string format: uuid description: Counterpart VAT ID id currency: $ref: '#/components/schemas/CurrencyEnum' deduction_amount: type: integer maximum: 9007199254740991.0 minimum: 0.0 description: The amount of tax deducted in minor units deprecated: true deduction_memo: type: string description: A note with additional information about a tax deduction deprecated: true deductions: items: $ref: '#/components/schemas/DeductionItem' type: array maxItems: 10 description: List of deductions applied to the receivable (maximum 10 deductions allowed) discount: allOf: - $ref: '#/components/schemas/Discount' description: The discount for a receivable. document_id: type: string maxLength: 100 minLength: 1 description: The document number of the receivable, which will appear in the PDF document. Can be set manually only in the [non-compliant mode](https://docs.monite.com/accounts-receivable/regulatory-compliance/invoice-compliance). Otherwise (or if omitted), it will be generated automatically based on the entity's [document number customization](https://docs.monite.com/advanced/document-number-customization) settings when the document is issued. examples: - INV-0001 - 2024-027 - CUST/2024/00027 document_rendering: allOf: - $ref: '#/components/schemas/DocumentRenderingSettings' description: Settings for rendering documents in PDF format, including settings for line items and specific document types. due_date: type: string format: date description: The date by which the invoice must be paid. entity: $ref: '#/components/schemas/ReceivableEntityBase' entity_bank_account_id: type: string format: uuid description: Entity bank account ID entity_vat_id_id: type: string format: uuid description: Entity VAT ID id expiry_date: type: string format: date description: The date (in ISO 8601 format) until which the quote is valid. footer: type: string description: Optional text displayed below the line items table in the PDF. line_items: items: $ref: '#/components/schemas/LineItemUpdate' type: array memo: type: string description: A note with additional information for a receivable partner_metadata: type: object description: Metadata for partner needs payment_terms: $ref: '#/components/schemas/InlinePaymentTermsRequestPayload' payment_terms_id: type: string format: uuid description: Unique ID of the payment terms. project_id: type: string format: uuid description: A project related to current receivable quote_accept_page_url: type: string maxLength: 65536 minLength: 1 format: uri description: Link for custom quote accept page signature_required: type: boolean description: Whether acceptance a quote requires a signature. tag_ids: items: type: string format: uuid type: array description: A list of IDs of user-defined tags (labels) assigned to this receivable. trade_name: type: string maxLength: 255 description: Trade name of the entity vat_exempt: type: boolean description: Indicates whether the goods, materials, or services listed in the receivable are exempt from VAT or not. vat_exemption_rationale: type: string description: The reason for the VAT exemption, if applicable. withholding_tax_rate: type: integer maximum: 10000.0 minimum: 0.0 description: The amount of tax withheld in percent minor units additionalProperties: false type: object ReceivableTemplatesVariablesObjectList: properties: data: items: $ref: '#/components/schemas/ReceivableTemplatesVariablesObject' type: array additionalProperties: false type: object required: - data TotalVatAmountItemComponent: properties: amount: type: integer maximum: 9007199254740991.0 minimum: 0.0 description: The total VAT of all line items, in [minor units](https://docs.monite.com/references/currencies#minor-units). name: type: string value: type: number maximum: 10000.0 minimum: 0.0 description: 'Percent minor units. Example: 12.5% is 1250.' type: object required: - name - value - amount ReceivableMailResponse: properties: id: type: string format: uuid created_at: type: string format: date-time description: The time the mail task was created updated_at: type: string format: date-time description: The time the mail task was updated recipients: $ref: '#/components/schemas/ReceivableMailRecipients' status: allOf: - $ref: '#/components/schemas/ReceivableMailStatusEnum' description: The status of the mail sent by receivable type: object required: - id - created_at - updated_at - status ReceivableEntityOrganization: properties: email: type: string format: email description: An email of the entity logo: type: string maxLength: 2083 minLength: 1 format: uri description: A link to the entity logo name: type: string description: The name of the entity issuing the receivable, when it is an organization. phone: type: string description: A phone number of the entity registration_authority: type: string description: The registration authority of the entity registration_number: type: string description: The registration number of the entity tax_id: type: string description: The Tax ID of the entity issuing the receivable type: type: string enum: - organization description: The entity type vat_id: type: string description: The VAT ID of the entity issuing the receivable, when it is an organization. website: type: string maxLength: 2083 minLength: 1 format: uri description: A website of the entity type: object required: - name - type description: A Response schema for an entity of organization type QuoteRenderingSettings: properties: display_entity_bank_account: type: boolean description: If set to `true`, the entity's bank account details will be displayed on the quote PDF. default: true display_signature: type: boolean description: If set to `true`, the signature field will be displayed on the quote PDF. default: false additionalProperties: false type: object AttachmentResponse: properties: id: type: string format: uuid description: Unique ID of the file with file_type=attachment from /v1/files. include_in_email: type: boolean description: Indicates whether the file would be included in the email. default: false mimetype: type: string description: MIME type of the file (e.g., 'application/pdf'). name: type: string description: Original filename of the attachment. size: type: integer description: File size in bytes. url: type: string description: URL to access the attachment file. type: object required: - id - mimetype - name - size - url UpdateCreditNote: properties: attachments: items: $ref: '#/components/schemas/AttachmentRequest' type: array minItems: 1 description: List of attachments to include with the receivable. Each attachment can be configured for email inclusion. If not provided, no attachments will be associated. counterpart_address: $ref: '#/components/schemas/ReceivablesCounterpartAddress' counterpart_contact: allOf: - $ref: '#/components/schemas/ReceivableCounterpartContact' description: Additional information about counterpart contacts. document_rendering: allOf: - $ref: '#/components/schemas/DocumentRenderingSettings' description: Settings for rendering documents in PDF format, including settings for line items and specific document types. entity: $ref: '#/components/schemas/ReceivableEntityBase' footer: type: string description: Optional text displayed below the line items table in the PDF. line_items: $ref: '#/components/schemas/UpdateLineItemForCreditNote' memo: type: string description: A note with additional information for a receivable partner_metadata: type: object description: Metadata for partner needs project_id: type: string format: uuid description: A project related to current receivable tag_ids: items: type: string format: uuid type: array description: A list of IDs of user-defined tags (labels) assigned to this receivable. additionalProperties: false type: object 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 UpdateLineItemForCreditNote: additionalProperties: $ref: '#/components/schemas/UpdateProductForCreditNote' type: object description: Line item with given product id can be changed only once example: 6639ac63-0622-4bd9-b340-31c25e2096b8: quantity: 5 price_diff: 100 old_price: 400 TotalVatAmountItem: properties: id: type: string format: uuid amount: type: integer maximum: 9007199254740991.0 minimum: 0.0 description: The total VAT of all line items, in [minor units](https://docs.monite.com/references/currencies#minor-units). components: items: $ref: '#/components/schemas/TotalVatAmountItemComponent' type: array minItems: 1 description: Sub-taxes included in the VAT. name: type: string description: Display name of the vat rate. taxable_amount: type: integer minimum: 0.0 description: The amount on which this VAT is calculated, in [minor units](https://docs.monite.com/references/currencies#minor-units). value: type: integer maximum: 10000.0 minimum: 0.0 description: 'Percent minor units. Example: 12.5% is 1250.' type: object required: - amount - taxable_amount - value UpdateIssuedInvoicePayload: properties: issued_invoice: $ref: '#/components/schemas/UpdateIssuedInvoice' additionalProperties: false type: object required: - issued_invoice description: 'Helper class that provides a standard way to create an ABC using inheritance.' ReceivableResponse: anyOf: - $ref: '#/components/schemas/QuoteResponsePayload' - $ref: '#/components/schemas/InvoiceResponsePayload' - $ref: '#/components/schemas/CreditNoteResponsePayload' LineItemFields: properties: measure_unit: allOf: - $ref: '#/components/schemas/FieldSchema' description: Object describing the required field `measure_unit` of a line item's product default: description: Unit used to measure the quantity of the product (e.g. items, meters, kilograms) required: false tax_rate_value: allOf: - $ref: '#/components/schemas/FieldSchema' description: Object describing the required field `tax_rate_value` of a line item default: description: 'Percent minor units. Example: 12.5% is 1250. This field is only required on invoices issued by entities in the US, Pakistan, and other unsupported countries.' required: false vat_rate_id: allOf: - $ref: '#/components/schemas/FieldSchema' description: Object describing the required field `vat_rate_id` of a line item default: description: Unique identifier of the vat rate object. This field is required for all entities in supported countries except the US and Pakistan. required: false additionalProperties: false type: object LineItemsRenderingSettings: properties: discount: $ref: '#/components/schemas/LineItemColumnSettings' description: Settings for the discount column in the line items table. measure_unit: $ref: '#/components/schemas/LineItemColumnSettings' description: Settings for the measure unit column in the line items table. name: $ref: '#/components/schemas/LineItemColumnSettings' description: Settings for the name column in the line items table. price: $ref: '#/components/schemas/LineItemNumericColumnSettings' description: Settings for the price column in the line items table. price_after_vat: $ref: '#/components/schemas/LineItemNumericColumnSettings' description: Settings for the price after VAT column in the line items table. quantity: $ref: '#/components/schemas/LineItemColumnSettings' description: Settings for the quantity column in the line items table. total_price: $ref: '#/components/schemas/LineItemNumericColumnSettings' description: Settings for the total price column in the line items table. total_price_after_vat: $ref: '#/components/schemas/LineItemNumericColumnSettings' description: Settings for the total price after VAT column in the line items table. vat_amount: $ref: '#/components/schemas/LineItemNumericColumnSettings' description: Settings for the VAT amount column in the line items table. vat_rate: $ref: '#/components/schemas/LineItemNumericColumnSettings' description: Settings for the VAT rate column in the line items table. additionalProperties: false type: object ReceivableTemplatesVariablesObject: properties: object_subtype: $ref: '#/components/schemas/VariablesType' object_type: type: string variables: items: $ref: '#/components/schemas/ReceivableTemplatesVariable' type: array additionalProperties: false type: object required: - object_subtype - object_type - variables CreditNoteResponsePayload: properties: id: type: string format: uuid created_at: type: string format: date-time description: Time at which the receivable was created. Timestamps follow the ISO 8601 standard. updated_at: type: string format: date-time description: Time at which the receivable was last updated. Timestamps follow the ISO 8601 standard. attachments: items: $ref: '#/components/schemas/AttachmentResponse' type: array description: List of attachments to include with the receivable. Each attachment can be configured for email inclusion. If not provided, no attachments will be associated. based_on: type: string format: uuid description: The unique ID of a previous document related to the receivable if applicable. based_on_document_id: type: string description: The unique document ID of a previous document related to the receivable if applicable. commercial_condition_description: type: string description: The commercial terms of the receivable (e.g. The products must be delivered in X days). counterpart_address: $ref: '#/components/schemas/ReceivablesCounterpartAddress' counterpart_billing_address: allOf: - $ref: '#/components/schemas/ReceivablesCounterpartAddress' description: Address of invoicing, need to state as a separate fields for some countries if it differs from address of a company. counterpart_business_type: type: string maxLength: 50 description: Different types of companies for different countries, ex. GmbH, SAS, SNC, etc. counterpart_contact: allOf: - $ref: '#/components/schemas/ReceivableCounterpartContact' description: Additional information about counterpart contacts. counterpart_einvoicing_credentials: allOf: - $ref: '#/components/schemas/EinvoicingCredentials' description: E-invoicing credentials of the counterpart counterpart_external_reference: type: string description: The external reference of the counterpart. counterpart_id: type: string format: uuid description: Unique ID of the counterpart. counterpart_name: type: string description: A legal name of a counterpart it is an organization or first and last name if it is an individual counterpart_shipping_address: allOf: - $ref: '#/components/schemas/ReceivablesCounterpartAddress' description: Address where goods were shipped / where services were provided. counterpart_tax_id: type: string description: The VAT/TAX ID of the counterpart. counterpart_type: allOf: - $ref: '#/components/schemas/CounterpartType' description: The type of the counterpart. counterpart_vat_id: $ref: '#/components/schemas/ReceivableCounterpartVatIDResponse' currency: allOf: - $ref: '#/components/schemas/CurrencyEnum' description: The currency used in the receivable. deduction_amount: type: integer maximum: 9007199254740991.0 minimum: 0.0 description: The amount of tax deducted in minor units deprecated: true deduction_memo: type: string description: A note with additional information about a tax deduction deprecated: true deductions: items: $ref: '#/components/schemas/DeductionItem' type: array maxItems: 10 description: List of deductions applied to the receivable (maximum 10 deductions allowed) discount: allOf: - $ref: '#/components/schemas/DiscountResponse' description: The discount for a receivable. discounted_subtotal: type: integer maximum: 9007199254740991.0 description: Total price of the receivable with discounts before taxes [minor units](https://docs.monite.com/references/currencies#minor-units). document_id: type: string description: The sequential code systematically assigned to invoices. document_rendering: allOf: - $ref: '#/components/schemas/DocumentRenderingSettings' description: Settings for rendering documents in PDF format, including settings for line items and specific document types. due_date: type: string format: date description: Optional field representing date until which invoice should be paid einvoice_error_comment: type: string description: Error that was returned by E-invoicing einvoice_file_url: type: string description: E-invoice XML file that was sent to the counterpart via an e-invoicing network. Available only if `is_einvoice` is `true`. entity: anyOf: - $ref: '#/components/schemas/ReceivableEntityOrganization' - $ref: '#/components/schemas/ReceivableEntityIndividual' entity_address: $ref: '#/components/schemas/ReceivableEntityAddressSchema' entity_bank_account: $ref: '#/components/schemas/ReceivablesRepresentationOfEntityBankAccount' entity_user_id: type: string format: uuid description: The entity user who created this document. entity_vat_id: $ref: '#/components/schemas/ReceivableEntityVatIDResponse' file: $ref: '#/components/schemas/ReceivableFileSchema' file_language: allOf: - $ref: '#/components/schemas/LanguageCodeEnum' description: The language of the customer-facing PDF file (`file_url`). The value matches the counterpart's `language` at the time when this PDF file was generated. file_url: type: string description: The receivable's PDF URL in the counterpart's default language. footer: type: string description: Optional text displayed below the line items table in the PDF. is_einvoice: type: boolean description: If `true`, the credit note will be sent through an e-invoicing network. The value is inherited from the invoice for which the credit note was created, and cannot be changed. default: false issue_date: type: string format: date-time description: Optional field for the issue of the entry. line_items: items: $ref: '#/components/schemas/ResponseItem' type: array memo: type: string description: A note with additional information for a receivable. network_credentials: allOf: - $ref: '#/components/schemas/EinvoicingCredentials' description: E-invoicing credentials of the entity original_file_language: allOf: - $ref: '#/components/schemas/LanguageCodeEnum' description: The language of the entity's copy of the PDF file (`original_file_url`). The value matches the entity's `language` at the time when this PDF file was generated. original_file_url: type: string description: The receivable's PDF URL in the entity's default language. partner_metadata: type: object description: Metadata for partner needs project_id: type: string format: uuid description: A project related to current receivable purchase_order: type: string maxLength: 100 description: Contain purchase order number. status: allOf: - $ref: '#/components/schemas/CreditNoteStateEnum' description: The status of the Credit Note inside the receivable workflow. subtotal: type: integer maximum: 9007199254740991.0 description: The subtotal (excluding VAT), in [minor units](https://docs.monite.com/references/currencies#minor-units). subtotal_after_vat: type: integer maximum: 9007199254740991.0 description: The subtotal including VAT but without invoice discount, in [minor units](https://docs.monite.com/references/currencies#minor-units). tags: items: $ref: '#/components/schemas/TagReadSchema' type: array description: The list of tags for this receivable. default: [] total_amount: type: integer maximum: 9007199254740991.0 description: Total price of the receivable in [minor units](https://docs.monite.com/references/currencies#minor-units). Calculated as a subtotal + total_vat_amount. default: 0 total_deduction_amount: type: integer maximum: 9007199254740991.0 description: The total deduction amount of all deductions, in [minor units](https://docs.monite.com/references/currencies#minor-units). total_vat_amount: type: integer maximum: 9007199254740991.0 description: The total VAT of all line items, in [minor units](https://docs.monite.com/references/currencies#minor-units). total_vat_amounts: items: $ref: '#/components/schemas/TotalVatAmountItem' type: array description: List of total vat amount for each VAT, presented in receivable total_withholding_tax: type: integer description: Total price of the receivable with tax withheld in minor units trade_name: type: string maxLength: 255 description: Trade name of the entity type: type: string enum: - credit_note description: The type of the receivable vat_exempt: type: boolean description: Indicates whether the goods, materials, or services listed in the receivable are exempt from VAT or not. vat_exemption_rationale: type: string description: The reason for the VAT exemption, if applicable. vat_inclusive_discount_mode: allOf: - $ref: '#/components/schemas/VatModeEnum' description: Indicates whether the discount is applied to the VAT-inclusive or VAT-exclusive amount. default: exclusive vat_mode: allOf: - $ref: '#/components/schemas/VatModeEnum' description: Defines whether the prices of products in receivable will already include VAT or not. default: exclusive withholding_tax_rate: type: integer maximum: 10000.0 minimum: 0.0 description: The amount of tax withheld in percent minor units type: object required: - id - created_at - updated_at - counterpart_address - counterpart_id - counterpart_type - currency - entity - entity_address - file_language - line_items - original_file_language - status - total_vat_amount - type LineItemProduct: properties: id: type: string format: uuid description: Unique ID of the product. created_at: type: string format: date-time description: Time at which the product was created. Timestamps follow the ISO 8601 standard. updated_at: type: string format: date-time description: Time at which the product was last updated. Timestamps follow the ISO 8601 standard. accounting_tax_rate_id: type: string format: uuid description: Unique identifier of the accounting tax rate object. description: type: string description: Description of the product. entity_id: type: string format: uuid entity_user_id: type: string format: uuid external_reference: type: string maxLength: 255 minLength: 1 description: A user-defined identifier of the product. For example, an internal product code or SKU (stock keeping unit). Client applications can use this field to map the products in Monite to an external product catalog. examples: - HT-1234-S-BL - SERVICE-67890 is_inline: type: boolean description: Indicates whether the product is inline default: false ledger_account_id: type: string format: uuid measure_unit: $ref: '#/components/schemas/LineItemProductMeasureUnit' measure_unit_id: type: string format: uuid description: The unique ID reference of the unit used to measure the quantity of this product (e.g. items, meters, kilograms). name: type: string description: Name of the product. price: $ref: '#/components/schemas/Price' price_after_vat: $ref: '#/components/schemas/Price' smallest_amount: type: number maximum: 2147483647.0 minimum: 0.0 description: The smallest amount allowed for this product. type: allOf: - $ref: '#/components/schemas/ProductServiceTypeEnum' description: Specifies whether this offering is a product or service. This may affect the applicable tax rates. default: product vat_rate: $ref: '#/components/schemas/VatRateResponse' type: object required: - id - created_at - updated_at - entity_id - name - price - price_after_vat - vat_rate CreditNoteStateEnum: type: string enum: - draft - issuing - issued - failed - deleted PaymentTerms: properties: id: type: string format: uuid description: type: string description: Description of the payment term. name: type: string term_1: allOf: - $ref: '#/components/schemas/InlineTermDiscount' description: The first tier of the payment term. Represents the terms of the first early discount. term_2: allOf: - $ref: '#/components/schemas/InlineTermDiscount' description: The second tier of the payment term. Defines the terms of the second early discount. term_final: allOf: - $ref: '#/components/schemas/InlineTermFinal' description: The final tier of the payment term. Defines the invoice due date. type: object required: - term_final ReceivablePaginationResponse: properties: data: items: $ref: '#/components/schemas/ReceivableResponse' 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 receivables ReceivableEntityBase: properties: email: type: string format: email description: An email of the entity logo: type: string maxLength: 2083 minLength: 1 format: uri description: A link to the entity logo phone: type: string description: A phone number of the entity registration_authority: type: string description: The registration authority of the entity registration_number: type: string description: The registration number of the entity website: type: string maxLength: 2083 minLength: 1 format: uri description: A website of the entity additionalProperties: false type: object description: A base schemas for an entity Discount: properties: amount: type: integer maximum: 9007199254740991.0 minimum: 0.0 description: The actual discount of the product in [minor units](https://docs.monite.com/references/currencies#minor-units) if type field equals amount, else in percent minor units type: allOf: - $ref: '#/components/schemas/DiscountType' description: The field specifies whether to use product currency or %. additionalProperties: false type: object required: - amount - type LineItemNumericColumnSettings: properties: display: type: boolean default: true label: anyOf: - type: string maxLength: 32 minLength: 1 - type: 'null' description: Line item table column header to override Monite's default. If not set, the Monite's default will be used. precision: anyOf: - type: integer maximum: 4.0 minimum: 2.0 - type: 'null' description: Number of decimal places to display for numeric values in this column. additionalProperties: false type: object description: Extended settings for numeric columns in line items. ReceivableHistoryResponse: properties: id: type: string format: uuid description: A unique ID of the history record. examples: - cd58435b-1c79-4b17-9f79-f898c93e5f97 current_pdf_url: type: string maxLength: 65536 minLength: 1 format: uri description: 'A URL of the PDF file that shows the document state after the change. Available only for the following event types: `receivable_created`, `receivable_updated`, `status_changed`, and `payment_received`. In other event types the `current_pdf_url` value is `null`. In `payment_received` events, the `current_pdf_url` value is available only in case of full payments and only if the entity setting `generate_paid_invoice_pdf` is `true`. Note that Monite generates PDFs asynchronously. This means that the initial value of `current_pdf_url` for the abovementioned events right after they occurred is usually `null` and the value gets populated later after the PDF document has been generated.' examples: - https://monite-file-saver.example.com/12345/67890.pdf 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/StatusChangedEventData' - $ref: '#/components/schemas/ReceivableUpdatedEventData' - $ref: '#/components/schemas/ReceivableCreatedEventData' - $ref: '#/components/schemas/BasedOnReceivableCreatedEventData' - $ref: '#/components/schemas/PaymentReceivedEventData' - $ref: '#/components/schemas/MailSentEventData' - $ref: '#/components/schemas/ReminderMailSentEventData' description: An object containing additional information about the event or change. The object structure varies based on the `event_type`. In `receivable_created` and `receivable_updated` events, `event_data` is an empty object `{}`. event_type: allOf: - $ref: '#/components/schemas/ReceivableHistoryEventTypeEnum' description: The type of the event or change. See [Event types](https://docs.monite.com/accounts-receivable/document-history#event-types). receivable_id: type: string format: uuid description: ID of the receivable 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 - receivable_id - timestamp description: Represents an entry in the change history of an accounts receivable document. ReceivableSendRequest: properties: body_text: type: string minLength: 1 description: Body text of the content language: type: string minLength: 1 description: Lowercase ISO code of language deprecated: true recipients: $ref: '#/components/schemas/Recipients' subject_text: type: string minLength: 1 description: Subject text of the content additionalProperties: false type: object required: - body_text - subject_text description: A schema for receiving a request for sending a receivable DiscountType: type: string enum: - amount - percentage VatRateCreator: type: string enum: - monite - accounting LineItemProductCreate: properties: description: type: string maxLength: 2000 description: Description of the product. external_reference: type: string maxLength: 255 minLength: 1 description: A user-defined identifier of the product. For example, an internal product code or SKU (stock keeping unit). Client applications can use this field to map the products in Monite to an external product catalog. examples: - HT-1234-S-BL - SERVICE-67890 ledger_account_id: type: string format: uuid measure_unit: $ref: '#/components/schemas/UnitRequest' name: type: string maxLength: 100 minLength: 1 description: Name of the product. price: $ref: '#/components/schemas/Price' smallest_amount: type: number maximum: 2147483647.0 minimum: 0.0 description: The smallest amount allowed for this product. type: allOf: - $ref: '#/components/schemas/ProductServiceTypeEnum' description: Specifies whether this offering is a product or service. This may affect the applicable tax rates. default: product type: object required: - name - price InlineTermFinal: properties: end_date: type: string format: date number_of_days: type: integer maximum: 10000.0 minimum: 0.0 description: The amount of days after the invoice issue date. additionalProperties: false type: object InlineTermDiscount: properties: discount: type: integer maximum: 10000.0 minimum: 0.0 description: The discount percentage in minor units. E.g., 200 means 2%. 1050 means 10.5%. end_date: type: string format: date number_of_days: type: integer maximum: 10000.0 minimum: 0.0 description: The amount of days after the invoice issue date. additionalProperties: false type: object required: - discount ReceivableSendTestReminderPayload: properties: recipients: $ref: '#/components/schemas/Recipients' reminder_type: allOf: - $ref: '#/components/schemas/ReminderTypeEnum' description: The type of the reminder to be sent. additionalProperties: false type: object required: - reminder_type description: Payload for sending a test reminder email ReceivableHistoryCursorFields: type: string enum: - timestamp EinvoicingCredentials: properties: id: type: string format: uuid network_identifier: type: string network_schema: type: string type: object required: - id - network_identifier - network_schema ReceivableFileSchema: 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/ReceivablePageSchema' 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/ReceivablePreviewSchema' 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 - md5 - mimetype - name - region - size - url description: Represents a file (such as a PDF invoice) that was uploaded to Monite. ReceivableCreateBasedOnPayload: properties: based_on: type: string format: uuid description: The unique ID of a previous document related to the receivable if applicable. tag_ids: items: type: string format: uuid type: array description: A list of IDs of user-defined tags (labels) assigned to this receivable. default: [] type: allOf: - $ref: '#/components/schemas/BasedOnTransitionType' description: The type of a created receivable. Currently supported transitions:quote -> invoice; invoice -> credit_note additionalProperties: false type: object required: - based_on - type ReceivableType: type: string enum: - quote - invoice - credit_note ReceivableEntityOrganizationRequest: properties: email: type: string format: email description: An email of the entity logo: type: string maxLength: 2083 minLength: 1 format: uri description: A link to the entity logo name: type: string description: The name of the entity issuing the receivable, when it is an organization. phone: type: string description: A phone number of the entity registration_authority: type: string description: The registration authority of the entity registration_number: type: string description: The registration number of the entity tax_id: type: string description: The Tax ID of the entity issuing the receivable type: type: string enum: - organization description: The entity type website: type: string maxLength: 2083 minLength: 1 format: uri description: A website of the entity additionalProperties: false type: object required: - name - type description: A Request schema for an entity of organization type UnitRequest: properties: description: type: string maxLength: 200 name: type: string maxLength: 100 minLength: 1 type: object required: - name ReceivablesPreviewTypeEnum: type: string enum: - receivable - discount_reminder - final_reminder ReceivablePreviewRequest: properties: body_text: type: string minLength: 1 description: Body text of the content language: allOf: - $ref: '#/components/schemas/LanguageCodeEnum' description: Language code for localization purposes default: en subject_text: type: string minLength: 1 description: Subject text of the content type: allOf: - $ref: '#/components/schemas/ReceivablesPreviewTypeEnum' description: The type of the preview document. default: receivable additionalProperties: false type: object required: - body_text - subject_text description: A schema for receiving a request for previewing an email with a receivable document DiscountResponse: properties: amount: type: integer maximum: 9007199254740991.0 minimum: 0.0 description: The actual discount of the product in [minor units](https://docs.monite.com/references/currencies#minor-units) if type field equals amount, else in percent minor units type: allOf: - $ref: '#/components/schemas/DiscountType' description: The field specifies whether to use product currency or %. value: type: integer maximum: 9007199254740991.0 minimum: 0.0 description: The monetary amount of the discount, in [minor units](https://docs.monite.com/references/currencies#minor-units). If the discount `type` is `amount`, this value is the same as the `amount` value. If `type` is `percentage`, the value is the calculated discount amount. additionalProperties: false type: object required: - amount - type HTTPValidationError: properties: detail: items: $ref: '#/components/schemas/ValidationError' type: array type: object ValidationError: properties: loc: items: anyOf: - type: string - type: integer type: array msg: type: string type: type: string type: object required: - loc - msg - type ReceivableHistoryPaginationResponse: properties: data: items: $ref: '#/components/schemas/ReceivableHistoryResponse' 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. ReceivableUpdatePayload: anyOf: - $ref: '#/components/schemas/UpdateQuotePayload' - $ref: '#/components/schemas/UpdateInvoicePayload' - $ref: '#/components/schemas/UpdateCreditNotePayload' - $ref: '#/components/schemas/UpdateIssuedInvoicePayload' additionalProperties: false CounterpartType: type: string enum: - individual - organization ReceivableEntityAddressSchema: properties: city: type: string maxLength: 255 description: A city (a full name) where the entity is registered country: allOf: - $ref: '#/components/schemas/AllowedCountries' description: 'A country name (as ISO code) where the entity is registered ' default: DE example: DE line1: type: string maxLength: 255 description: A street where the entity is registered line2: type: string maxLength: 100 description: An alternative street used by the entity postal_code: type: string maxLength: 10 description: A postal code of the address where the entity is registered state: type: string description: A state in a country where the entity is registered additionalProperties: false type: object required: - city - line1 - postal_code description: A schema represents address info of the entity VatRateStatusEnum: type: string enum: - active - inactive ReceivablesSearchRequest_2: properties: based_on: type: string format: uuid description: 'This parameter accepts a quote ID or an invoice ID. * Specify a quote ID to find invoices created from this quote. * Specify an invoice ID to find credit notes created for this invoice. Valid but nonexistent IDs do not raise errors but produce no results.' counterpart_id: type: string format: uuid description: 'Return only receivables created for the counterpart with the specified ID. Counterparts that have been deleted but have associated receivables will still return results here because the receivables contain a frozen copy of the counterpart data. If the specified counterpart ID does not exist and never existed, no results are returned.' counterpart_name: type: string description: Return only receivables created for counterparts with the specified name (exact match, case-sensitive). For counterparts of `type` = `individual`, the full name is formatted as `first_name last_name`. counterpart_name__contains: type: string description: Return only receivables created for counterparts whose name contains the specified string (case-sensitive). counterpart_name__icontains: type: string description: Return only receivables created for counterparts whose name contains the specified string (case-insensitive). created_at__gt: type: string format: date-time description: Return only receivables created after the specified date and time. The value must be in the ISO 8601 format `YYYY-MM-DDThh:mm[:ss][Z|±hh:mm]`. Milliseconds are ignored. created_at__gte: type: string format: date-time description: Return only receivables created on or after the specified date and time. created_at__lt: type: string format: date-time description: Return only receivables created before the specified date and time. created_at__lte: type: string format: date-time description: Return only receivables created before or on the specified date and time. discounted_subtotal: type: integer description: Return only receivables with the exact specified discounted subtotal. The amount must be specified in the [minor units](https://docs.monite.com/references/currencies#minor-units) of currency. For example, $12.5 is represented as 1250. discounted_subtotal__gt: type: integer description: Return only receivables whose discounted subtotal (in minor units) is greater than the specified value. discounted_subtotal__gte: type: integer description: Return only receivables whose discounted subtotal (in minor units) is greater than or equal to the specified value. discounted_subtotal__lt: type: integer description: Return only receivables whose discounted subtotal (in minor units) is less than the specified value. discounted_subtotal__lte: type: integer description: Return only receivables whose discounted subtotal (in minor units) is less than or equal to the specified value. document_id: type: string description: Return a receivable 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`). document_id__contains: type: string description: Return only receivables whose document number (`document_id`) contains the specified string (case-sensitive). document_id__icontains: type: string description: Return only receivables whose document number (`document_id`) contains the specified string (case-insensitive). due_date__gt: type: string format: date description: 'Return invoices that are due after the specified date (exclusive, `YYYY-MM-DD`). This filter excludes quotes, credit notes, and draft invoices.' due_date__gte: type: string format: date description: 'Return invoices that are due on or after the specified date (`YYYY-MM-DD`). This filter excludes quotes, credit notes, and draft invoices.' due_date__lt: type: string format: date description: 'Return invoices that are due before the specified date (exclusive, `YYYY-MM-DD`). This filter excludes quotes, credit notes, and draft invoices.' due_date__lte: type: string format: date description: 'Return invoices that are due before or on the specified date (`YYYY-MM-DD`). This filter excludes quotes, credit notes, and draft invoices.' entity_user_id: type: string format: uuid description: 'Return only receivables created by the entity user with the specified ID. To query receivables by multiple user IDs at once, use the `entity_user_id__in` parameter instead. If the request is authenticated using an entity user token, this user must have the `receivable.read.allowed` (rather than `allowed_for_own`) permission to be able to query receivables created by other users. IDs of deleted users will still produce results here if those users had associated receivables. Valid but nonexistent user IDs do not raise errors but produce no results.' entity_user_id__in: items: type: string format: uuid type: array has_due_date: type: boolean description: Return only receivables that have a due date set. true=only invoices with due_date, false=only invoices without due_date id__in: items: type: string format: uuid type: array issue_date__gt: type: string format: date-time description: Return only non-draft receivables that were issued after the specified date and time. The value must be in the ISO 8601 format `YYYY-MM-DDThh:mm[:ss][Z|±hh:mm]`. Milliseconds are ignored. issue_date__gte: type: string format: date-time description: Return only non-draft receivables that were issued on or after the specified date and time. issue_date__lt: type: string format: date-time description: Return only non-draft receivables that were issued before the specified date and time. issue_date__lte: type: string format: date-time description: Return only non-draft receivables that were issued before or on the specified date and time. limit: type: integer maximum: 250.0 minimum: 1.0 default: 100 order: allOf: - $ref: '#/components/schemas/OrderEnum' default: asc pagination_token: type: string product_ids: items: type: string format: uuid type: array product_ids__in: items: type: string format: uuid type: array project_id: type: string format: uuid description: Return only receivables assigned to the project with the specified ID. Valid but nonexistent project IDs do not raise errors but return no results. project_id__in: items: type: string format: uuid type: array search_text: type: string description: Case-insensitive and partial match search for the specified text in the `document_id` and `counterpart_name` fields of the receivables. sort: $ref: '#/components/schemas/ReceivableCursorFields2' status: type: string enum: - draft - issuing - issued - failed - accepted - expired - declined - recurring - partially_paid - paid - overdue - uncollectible - canceled description: 'Return only receivables that have the specified status. See the applicable [invoice statuses](https://docs.monite.com/accounts-receivable/invoices/index), [quote statuses](https://docs.monite.com/accounts-receivable/quotes/index), and [credit note statuses](https://docs.monite.com/accounts-receivable/credit-notes#credit-note-lifecycle). To query multiple statuses at once, use the `status__in` parameter instead.' status__in: items: type: string type: array tag_ids: items: type: string format: uuid type: array tag_ids__in: items: type: string format: uuid type: array total_amount: type: integer description: Return only receivables with the exact specified total amount. The amount must be specified in the [minor units](https://docs.monite.com/references/currencies#minor-units) of currency. For example, $12.5 is represented as 1250. total_amount__gt: type: integer description: Return only receivables whose total amount (in minor units) exceeds the specified value. total_amount__gte: type: integer description: Return only receivables whose total amount (in minor units) is greater than or equal to the specified value. total_amount__lt: type: integer description: Return only receivables whose total amount (in minor units) is less than the specified value. total_amount__lte: type: integer description: Return only receivables whose total amount (in minor units) is less than or equal to the specified value. type: allOf: - $ref: '#/components/schemas/ReceivableType' description: Return only receivables of the specified type. Use this parameter to get only invoices, or only quotes, or only credit notes. additionalProperties: false type: object LineItemUpdate_2: properties: custom_vat_rate_id: type: string format: uuid description: Unique identifier of the user-defined vat rate object. discount: allOf: - $ref: '#/components/schemas/Discount' description: The discount for a product. price: type: integer maximum: 9007199254740991.0 minimum: 0.0 description: The actual price of the product in [minor units](https://docs.monite.com/references/currencies#minor-units). quantity: type: number maximum: 2147483647.0 minimum: 0.0 description: The quantity of each of the goods, materials, or services listed in the receivable. tax_rate_name: type: string maxLength: 64 description: Specifies the display name of the tax rate. This field is applicable only when tax_rate_value is also provided. tax_rate_value: type: integer maximum: 10000.0 minimum: 0.0 description: 'Percent minor units. Example: 12.5% is 1250. This field is only required on invoices issued by entities in the US, Pakistan, and other unsupported countries.' tax_status: allOf: - $ref: '#/components/schemas/TaxStatusEnum' description: 'Tax applicability status of the line item. Possible values: * `taxable` (default) - Standard tax behavior. Requires the tax rate to be specified. * `exempt` - Line item is exempt from taxes. Exempt items are not included in total tax calculations. * `non_taxable` - Line item is outside the tax scope entirely, cannot have tax rates.' vat_rate_id: type: string format: uuid description: Unique identifier of the vat rate object. This field is required for all entities in supported countries except the US and Pakistan. additionalProperties: false type: object ReceivableFacadeCreateQuotePayload_2: properties: attachments: items: $ref: '#/components/schemas/AttachmentRequest' type: array minItems: 1 description: List of attachments to include with the receivable. Each attachment can be configured for email inclusion. If not provided, no attachments will be associated. commercial_condition_description: type: string counterpart_billing_address_id: type: string format: uuid description: Address of invoicing, need to state as a separate fields for some countries if it differs from address of a company. counterpart_business_type: type: string maxLength: 50 description: Different types of companies for different countries, ex. GmbH, SAS, SNC, etc. counterpart_id: type: string format: uuid counterpart_shipping_address_id: type: string format: uuid description: Address where goods were shipped / where services were provided. counterpart_vat_id_id: type: string format: uuid description: Counterpart VAT ID id currency: $ref: '#/components/schemas/CurrencyEnum' deduction_amount: type: integer maximum: 9007199254740991.0 minimum: 0.0 description: The amount of tax deducted in minor units deprecated: true deduction_memo: type: string description: A note with additional information about a tax deduction deprecated: true deductions: items: $ref: '#/components/schemas/DeductionItem' type: array maxItems: 10 description: List of deductions applied to the receivable (maximum 10 deductions allowed) discount: allOf: - $ref: '#/components/schemas/Discount' description: The discount for a receivable. document_id: type: string maxLength: 100 minLength: 1 description: The document number of the receivable, which will appear in the PDF document. Can be set manually only in the [non-compliant mode](https://docs.monite.com/accounts-receivable/regulatory-compliance/invoice-compliance). Otherwise (or if omitted), it will be generated automatically based on the entity's [document number customization](https://docs.monite.com/advanced/document-number-customization) settings when the document is issued. examples: - INV-0001 - 2024-027 - CUST/2024/00027 document_rendering: allOf: - $ref: '#/components/schemas/DocumentRenderingSettings' description: Settings for rendering documents in PDF format, including settings for line items and specific document types. entity: $ref: '#/components/schemas/ReceivableEntityBase' entity_bank_account_id: type: string format: uuid description: Entity bank account ID entity_vat_id_id: type: string format: uuid description: Entity VAT ID id expiry_date: type: string format: date description: The date (in ISO 8601 format) until which the quote is valid. footer: type: string description: Optional text displayed below the line items table in the PDF. line_items: items: $ref: '#/components/schemas/LineItem_2' type: array memo: type: string description: A note with additional information for a receivable partner_metadata: type: object description: Metadata for partner needs project_id: type: string format: uuid description: A project related to current receivable quote_accept_page_url: type: string maxLength: 65536 minLength: 1 format: uri description: Link for custom quote accept page signature_required: type: boolean description: Whether acceptance a quote requires a signature. tag_ids: items: type: string format: uuid type: array description: A list of IDs of user-defined tags (labels) assigned to this receivable. default: [] trade_name: type: string maxLength: 255 description: Trade name of the entity type: type: string enum: - quote description: The type of the document uploaded. vat_exempt: type: boolean description: Indicates whether the goods, materials, or services listed in the receivable are exempt from VAT or not. vat_exemption_rationale: type: string description: The reason for the VAT exemption, if applicable. vat_mode: allOf: - $ref: '#/components/schemas/VatModeEnum' description: Defines whether the prices of products in receivable will already include VAT or not. withholding_tax_rate: type: integer maximum: 10000.0 minimum: 0.0 description: The amount of tax withheld in percent minor units additionalProperties: false type: object required: - counterpart_billing_address_id - counterpart_id - currency - line_items - type ReceivablesVerifyResponse: properties: errors: allOf: - $ref: '#/components/schemas/MissingFields_2' description: Missing fields of receivable warnings: allOf: - $ref: '#/components/schemas/ReceivablesRemindersWarningMessage' description: Warning message for payment reminder additionalProperties: false type: object description: A schema for returning a response with validation results LineItemProductMeasureUnit_2: properties: id: type: string format: uuid description: type: string maxLength: 200 name: type: string maxLength: 100 minLength: 1 type: object required: - name ReceivablesRepresentationOfEntityBankAccount_2: properties: id: type: string format: uuid description: Unique ID of the entity bank account. account_holder_name: type: string description: Account holder's name account_number: type: string description: Account number (required if IBAN is not provided) bank_name: type: string description: The name of the entity's bank account. bic: type: string description: The BIC of the entity's bank account. iban: type: string description: The IBAN of the entity's bank account. routing_number: type: string description: Routing number (US) sort_code: type: string description: Sort code (GB) type: object UpdateInvoice_2: properties: attachments: items: $ref: '#/components/schemas/AttachmentRequest' type: array minItems: 1 description: List of attachments to include with the receivable. Each attachment can be configured for email inclusion. If not provided, no attachments will be associated. contact_id: type: string format: uuid description: Unique ID of the counterpart contact. counterpart_billing_address_id: type: string format: uuid description: Address of invoicing, need to state as a separate fields for some countries if it differs from address of a company. counterpart_einvoicing_credentials_id: type: string format: uuid description: E-invoicing credentials ID of the counterpart counterpart_id: type: string format: uuid description: Unique ID of the counterpart. counterpart_shipping_address_id: type: string format: uuid description: Address where goods were shipped / where services were provided. counterpart_vat_id_id: type: string format: uuid description: Counterpart VAT ID id currency: $ref: '#/components/schemas/CurrencyEnum' deduction_amount: type: integer maximum: 9007199254740991.0 minimum: 0.0 description: The amount of tax deducted in minor units deprecated: true deduction_memo: type: string description: A note with additional information about a tax deduction deprecated: true deductions: items: $ref: '#/components/schemas/DeductionItem' type: array maxItems: 10 description: List of deductions applied to the receivable (maximum 10 deductions allowed) discount: allOf: - $ref: '#/components/schemas/Discount' description: The discount for a receivable. document_id: type: string maxLength: 100 minLength: 1 description: The document number of the receivable, which will appear in the PDF document. Can be set manually only in the [non-compliant mode](https://docs.monite.com/accounts-receivable/regulatory-compliance/invoice-compliance). Otherwise (or if omitted), it will be generated automatically based on the entity's [document number customization](https://docs.monite.com/advanced/document-number-customization) settings when the document is issued. examples: - INV-0001 - 2024-027 - CUST/2024/00027 document_rendering: allOf: - $ref: '#/components/schemas/DocumentRenderingSettings' description: Settings for rendering documents in PDF format, including settings for line items and specific document types. due_date: type: string format: date description: The date by which the invoice must be paid. entity: $ref: '#/components/schemas/ReceivableEntityBase' entity_bank_account_id: type: string format: uuid description: Entity bank account ID entity_vat_id_id: type: string format: uuid description: Entity VAT ID id footer: type: string description: Optional text displayed below the line items table in the PDF. fulfillment_date: type: string format: date description: 'The date when the goods are shipped or the service is provided. Can be a current, past, or future date. Some countries require the fulfillment date in invoices for regulatory compliance. In this case, if the fulfillment date was not provided by the user, it is automatically set to the invoice issue date once the invoice gets issued. In countries where the fulfillment date is optional, Monite does not auto-assign it if it was omitted by the user.' is_einvoice: type: boolean description: Is this Invoice will be sent through E-invoice system line_items: items: $ref: '#/components/schemas/LineItemUpdate_2' type: array memo: type: string description: A note with additional information for a receivable network_credentials_id: type: string format: uuid description: E-invoicing network credentials ID of the entity overdue_reminder_id: type: string format: uuid partner_metadata: type: object description: Metadata for partner needs payment_page_url: type: string maxLength: 2083 minLength: 1 format: uri description: Link to your invoice's custom payment rails or external payment link. payment_reminder_id: type: string format: uuid payment_terms: $ref: '#/components/schemas/InlinePaymentTermsRequestPayload' payment_terms_id: type: string format: uuid description: Unique ID of the payment terms. project_id: type: string format: uuid description: A project related to current receivable tag_ids: items: type: string format: uuid type: array description: A list of IDs of user-defined tags (labels) assigned to this receivable. trade_name: type: string maxLength: 255 description: Trade name of the entity vat_exempt: type: boolean description: Indicates whether the goods, materials, or services listed in the receivable are exempt from VAT or not. vat_exemption_rationale: type: string description: The reason for the VAT exemption, if applicable. withholding_tax_rate: type: integer maximum: 10000.0 minimum: 0.0 description: The amount of tax withheld in percent minor units additionalProperties: false type: object ReceivableFacadeCreateInvoicePayload_2: properties: attachments: items: $ref: '#/components/schemas/AttachmentRequest' type: array minItems: 1 description: List of attachments to include with the receivable. Each attachment can be configured for email inclusion. If not provided, no attachments will be associated. commercial_condition_description: type: string counterpart_billing_address_id: type: string format: uuid description: Address of invoicing, need to state as a separate fields for some countries if it differs from address of a company. counterpart_business_type: type: string maxLength: 50 description: Different types of companies for different countries, ex. GmbH, SAS, SNC, etc. counterpart_einvoicing_credentials_id: type: string format: uuid description: E-invoicing credentials ID of the counterpart counterpart_id: type: string format: uuid counterpart_shipping_address_id: type: string format: uuid description: Address where goods were shipped / where services were provided. counterpart_vat_id_id: type: string format: uuid description: Counterpart VAT ID id currency: $ref: '#/components/schemas/CurrencyEnum' deduction_amount: type: integer maximum: 9007199254740991.0 minimum: 0.0 description: The amount of tax deducted in minor units deprecated: true deduction_memo: type: string description: A note with additional information about a tax deduction deprecated: true deductions: items: $ref: '#/components/schemas/DeductionItem' type: array maxItems: 10 description: List of deductions applied to the receivable (maximum 10 deductions allowed) discount: allOf: - $ref: '#/components/schemas/Discount' description: The discount for a receivable. document_id: type: string maxLength: 100 minLength: 1 description: The document number of the receivable, which will appear in the PDF document. Can be set manually only in the [non-compliant mode](https://docs.monite.com/accounts-receivable/regulatory-compliance/invoice-compliance). Otherwise (or if omitted), it will be generated automatically based on the entity's [document number customization](https://docs.monite.com/advanced/document-number-customization) settings when the document is issued. examples: - INV-0001 - 2024-027 - CUST/2024/00027 document_rendering: allOf: - $ref: '#/components/schemas/DocumentRenderingSettings' description: Settings for rendering documents in PDF format, including settings for line items and specific document types. entity: $ref: '#/components/schemas/ReceivableEntityBase' entity_bank_account_id: type: string format: uuid description: Entity bank account ID entity_vat_id_id: type: string format: uuid description: Entity VAT ID id footer: type: string description: Optional text displayed below the line items table in the PDF. fulfillment_date: type: string format: date description: 'The date when the goods are shipped or the service is provided. Can be a current, past, or future date. Some countries require the fulfillment date in invoices for regulatory compliance. In this case, if the fulfillment date was not provided by the user, it is automatically set to the invoice issue date once the invoice gets issued. In countries where the fulfillment date is optional, Monite does not auto-assign it if it was omitted by the user.' is_einvoice: type: boolean description: Is this Invoice will be sent through E-invoice system default: false line_items: items: $ref: '#/components/schemas/LineItem_2' type: array memo: type: string description: A note with additional information for a receivable network_credentials_id: type: string format: uuid description: E-invoicing credentials ID of the entity overdue_reminder_id: type: string format: uuid partner_metadata: type: object description: Metadata for partner needs payment_page_url: type: string maxLength: 2083 minLength: 1 format: uri description: Link to the invoice's payment page. Either Monite's payment links or your custom payment links. payment_reminder_id: type: string format: uuid payment_terms: $ref: '#/components/schemas/InlinePaymentTermsRequestPayload' payment_terms_id: type: string format: uuid project_id: type: string format: uuid description: A project related to current receivable purchase_order: type: string maxLength: 100 description: Contain purchase order number. tag_ids: items: type: string format: uuid type: array description: A list of IDs of user-defined tags (labels) assigned to this receivable. default: [] trade_name: type: string maxLength: 255 description: Trade name of the entity type: type: string enum: - invoice description: The type of the document uploaded. vat_exempt: type: boolean description: Indicates whether the goods, materials, or services listed in the receivable are exempt from VAT or not. vat_exemption_rationale: type: string description: The reason for the VAT exemption, if applicable. vat_mode: allOf: - $ref: '#/components/schemas/VatModeEnum' description: Defines whether the prices of products in receivable will already include VAT or not. withholding_tax_rate: type: integer maximum: 10000.0 minimum: 0.0 description: The amount of tax withheld in percent minor units additionalProperties: false type: object required: - counterpart_billing_address_id - counterpart_id - currency - line_items - type InvoiceResponsePayload_2: properties: id: type: string format: uuid created_at: type: string format: date-time description: Time at which the receivable was created. Timestamps follow the ISO 8601 standard. updated_at: type: string format: date-time description: Time at which the receivable was last updated. Timestamps follow the ISO 8601 standard. amount_due: type: integer maximum: 9007199254740991.0 description: How much is left to be paid in [minor units](https://docs.monite.com/references/currencies#minor-units). Equal 0 if the Invoice is fully paid. amount_paid: type: integer maximum: 9007199254740991.0 description: How much has been paid [minor units](https://docs.monite.com/references/currencies#minor-units) amount_to_pay: type: integer maximum: 9007199254740991.0 description: How much is left to be paid in in [minor units](https://docs.monite.com/references/currencies#minor-units), including payment_term discounts. attachments: items: $ref: '#/components/schemas/AttachmentResponse' type: array description: List of attachments to include with the receivable. Each attachment can be configured for email inclusion. If not provided, no attachments will be associated. based_on: type: string format: uuid description: The unique ID of a previous document related to the receivable if applicable. based_on_document_id: type: string description: The unique document ID of a previous document related to the receivable if applicable. comment: type: string description: Field with a comment for pay/partially/uncollectible info on this Invoice commercial_condition_description: type: string description: The commercial terms of the receivable (e.g. The products must be delivered in X days). counterpart_billing_address: allOf: - $ref: '#/components/schemas/ReceivablesRepresentationOfCounterpartAddress' description: Address of invoicing, need to state as a separate fields for some countries if it differs from address of a company. counterpart_business_type: type: string maxLength: 50 description: Different types of companies for different countries, ex. GmbH, SAS, SNC, etc. counterpart_contact: allOf: - $ref: '#/components/schemas/ReceivableCounterpartContact_2' description: Additional information about counterpart contacts. counterpart_einvoicing_credentials: allOf: - $ref: '#/components/schemas/EinvoicingCredentials' description: E-invoicing credentials of the counterpart counterpart_external_reference: type: string description: The external reference of the counterpart. counterpart_id: type: string format: uuid description: Unique ID of the counterpart. counterpart_name: type: string description: A legal name of a counterpart it is an organization or first and last name if it is an individual counterpart_shipping_address: allOf: - $ref: '#/components/schemas/ReceivablesRepresentationOfCounterpartAddress' description: Address where goods were shipped / where services were provided. counterpart_tax_id: type: string description: The VAT/TAX ID of the counterpart. counterpart_type: allOf: - $ref: '#/components/schemas/CounterpartType' description: The type of the counterpart. counterpart_vat_id: $ref: '#/components/schemas/ReceivableCounterpartVatIDResponse' currency: allOf: - $ref: '#/components/schemas/CurrencyEnum' description: The currency used in the receivable. deduction_amount: type: integer maximum: 9007199254740991.0 minimum: 0.0 description: The amount of tax deducted in minor units deprecated: true deduction_memo: type: string description: A note with additional information about a tax deduction deprecated: true deductions: items: $ref: '#/components/schemas/DeductionItem' type: array maxItems: 10 description: List of deductions applied to the receivable (maximum 10 deductions allowed) discount: allOf: - $ref: '#/components/schemas/DiscountResponse' description: The discount for a receivable. discounted_subtotal: type: integer maximum: 9007199254740991.0 description: Total price of the receivable with discounts before taxes [minor units](https://docs.monite.com/references/currencies#minor-units). document_id: type: string description: The sequential code systematically assigned to invoices. document_rendering: allOf: - $ref: '#/components/schemas/DocumentRenderingSettings' description: Settings for rendering documents in PDF format, including settings for line items and specific document types. due_date: type: string format: date description: Optional field representing date until which invoice should be paid einvoice_error_comment: type: string description: Error that was returned by E-invoicing einvoice_file_url: type: string description: E-invoice XML file that was sent to the counterpart via an e-invoicing network. Available only if `is_einvoice` is `true`. entity: anyOf: - $ref: '#/components/schemas/ReceivableEntityOrganization' - $ref: '#/components/schemas/ReceivableEntityIndividual' entity_address: $ref: '#/components/schemas/ReceivableEntityAddressSchema' entity_bank_account: $ref: '#/components/schemas/ReceivablesRepresentationOfEntityBankAccount_2' entity_user_id: type: string format: uuid description: The entity user who created this document. entity_vat_id: $ref: '#/components/schemas/ReceivableEntityVatIDResponse' file_language: allOf: - $ref: '#/components/schemas/LanguageCodeEnum' description: The language of the customer-facing PDF file (`file_url`). The value matches the counterpart's `language` at the time when this PDF file was generated. file_url: type: string description: The receivable's PDF URL in the counterpart's default language. footer: type: string description: Optional text displayed below the line items table in the PDF. fulfillment_date: type: string format: date description: 'The date when the goods are shipped or the service is provided. Can be a current, past, or future date. Some countries require the fulfillment date in invoices for regulatory compliance. In this case, if the fulfillment date was not provided by the user, it is automatically set to the invoice issue date once the invoice gets issued. In countries where the fulfillment date is optional, Monite does not auto-assign it if it was omitted by the user.' is_einvoice: type: boolean description: Is this Invoice will be sent through E-invoice system default: false issue_date: type: string format: date-time description: Optional field for the issue of the entry. line_items: items: $ref: '#/components/schemas/ResponseItem' type: array memo: type: string description: A note with additional information for a receivable. network_credentials: allOf: - $ref: '#/components/schemas/EinvoicingCredentials' description: E-invoicing credentials of the entity original_file_language: allOf: - $ref: '#/components/schemas/LanguageCodeEnum' description: The language of the entity's copy of the PDF file (`original_file_url`). The value matches the entity's `language` at the time when this PDF file was generated. original_file_url: type: string description: The receivable's PDF URL in the entity's default language. overdue_reminder_id: type: string format: uuid paid_at: type: string format: date-time description: Date and time when the invoice was paid. partner_metadata: type: object description: Metadata for partner needs payment_page_url: type: string maxLength: 2083 minLength: 1 format: uri description: Link to the invoice's payment page. Either Monite's payment links or your custom payment links. payment_reminder_id: type: string format: uuid payment_terms: $ref: '#/components/schemas/PaymentTerms' project_id: type: string format: uuid description: A project related to current receivable purchase_order: type: string maxLength: 100 description: Contain purchase order number. recurrence_id: type: string format: uuid description: Stores an unique ID of a recurrence if the receivable is in a recurring status related_documents: allOf: - $ref: '#/components/schemas/RelatedDocuments' description: Ids of documents that relate to invoice. I.e credit notes, proforma invoices, etc. status: allOf: - $ref: '#/components/schemas/ReceivablesStatusEnum' description: The status of the receivable inside the receivable workflow. subtotal: type: integer maximum: 9007199254740991.0 description: The subtotal (excluding VAT), in [minor units](https://docs.monite.com/references/currencies#minor-units). subtotal_after_vat: type: integer maximum: 9007199254740991.0 description: The subtotal including VAT but without invoice discount, in [minor units](https://docs.monite.com/references/currencies#minor-units). tags: items: $ref: '#/components/schemas/TagReadSchema' type: array description: The list of tags for this receivable. default: [] total_amount: type: integer maximum: 9007199254740991.0 description: Total price of the receivable in [minor units](https://docs.monite.com/references/currencies#minor-units). Calculated as a subtotal + total_vat_amount. default: 0 total_amount_with_credit_notes: type: integer maximum: 9007199254740991.0 description: The total price of the receivable in [minor units](https://docs.monite.com/references/currencies#minor-units), including VAT and excluding all issued credit notes. total_deduction_amount: type: integer maximum: 9007199254740991.0 description: The total deduction amount of all deductions, in [minor units](https://docs.monite.com/references/currencies#minor-units). total_vat_amount: type: integer maximum: 9007199254740991.0 description: The total VAT of all line items, in [minor units](https://docs.monite.com/references/currencies#minor-units). total_vat_amounts: items: $ref: '#/components/schemas/TotalVatAmountItem' type: array description: List of total vat amount for each VAT, presented in receivable total_withholding_tax: type: integer description: Total price of the receivable with tax withheld in minor units trade_name: type: string maxLength: 255 description: Trade name of the entity type: type: string enum: - invoice description: The type of the document uploaded. vat_exempt: type: boolean description: Indicates whether the goods, materials, or services listed in the receivable are exempt from VAT or not. vat_exemption_rationale: type: string description: The reason for the VAT exemption, if applicable. vat_inclusive_discount_mode: allOf: - $ref: '#/components/schemas/VatModeEnum' description: Indicates whether the discount is applied to the VAT-inclusive or VAT-exclusive amount. default: exclusive vat_mode: allOf: - $ref: '#/components/schemas/VatModeEnum' description: Defines whether the prices of products in receivable will already include VAT or not. default: exclusive withholding_tax_rate: type: integer maximum: 10000.0 minimum: 0.0 description: The amount of tax withheld in percent minor units type: object required: - id - created_at - updated_at - amount_due - amount_paid - counterpart_id - counterpart_type - currency - entity - entity_address - file_language - line_items - original_file_language - related_documents - status - total_amount_with_credit_notes - total_vat_amount - type MissingFields_2: properties: counterpart: items: type: string type: array description: Missing fields of counterpart. entity: items: type: string type: array description: Missing fields of entity. products: items: $ref: '#/components/schemas/MissingLineItemFields' type: array description: Missing fields of line items. receivable: items: type: string type: array description: Missing fields of receivable. vat_rates: items: type: string type: array description: List of invalid vat rates. additionalProperties: false type: object QuoteResponsePayload_2: properties: id: type: string format: uuid created_at: type: string format: date-time description: Time at which the receivable was created. Timestamps follow the ISO 8601 standard. updated_at: type: string format: date-time description: Time at which the receivable was last updated. Timestamps follow the ISO 8601 standard. attachments: items: $ref: '#/components/schemas/AttachmentResponse' type: array description: List of attachments to include with the receivable. Each attachment can be configured for email inclusion. If not provided, no attachments will be associated. based_on: type: string format: uuid description: The unique ID of a previous document related to the receivable if applicable. based_on_document_id: type: string description: The unique document ID of a previous document related to the receivable if applicable. comment: type: string description: Field with a comment on why the client declined this Quote commercial_condition_description: type: string description: The commercial terms of the receivable (e.g. The products must be delivered in X days). counterpart_billing_address: allOf: - $ref: '#/components/schemas/ReceivablesRepresentationOfCounterpartAddress' description: Address of invoicing, need to state as a separate fields for some countries if it differs from address of a company. counterpart_business_type: type: string maxLength: 50 description: Different types of companies for different countries, ex. GmbH, SAS, SNC, etc. counterpart_contact: allOf: - $ref: '#/components/schemas/ReceivableCounterpartContact_2' description: Additional information about counterpart contacts. counterpart_external_reference: type: string description: The external reference of the counterpart. counterpart_id: type: string format: uuid description: Unique ID of the counterpart. counterpart_name: type: string description: A legal name of a counterpart it is an organization or first and last name if it is an individual counterpart_shipping_address: allOf: - $ref: '#/components/schemas/ReceivablesRepresentationOfCounterpartAddress' description: Address where goods were shipped / where services were provided. counterpart_tax_id: type: string description: The VAT/TAX ID of the counterpart. counterpart_type: allOf: - $ref: '#/components/schemas/CounterpartType' description: The type of the counterpart. counterpart_vat_id: $ref: '#/components/schemas/ReceivableCounterpartVatIDResponse' currency: allOf: - $ref: '#/components/schemas/CurrencyEnum' description: The currency used in the receivable. deduction_amount: type: integer maximum: 9007199254740991.0 minimum: 0.0 description: The amount of tax deducted in minor units deprecated: true deduction_memo: type: string description: A note with additional information about a tax deduction deprecated: true deductions: items: $ref: '#/components/schemas/DeductionItem' type: array maxItems: 10 description: List of deductions applied to the receivable (maximum 10 deductions allowed) discount: allOf: - $ref: '#/components/schemas/DiscountResponse' description: The discount for a receivable. discounted_subtotal: type: integer maximum: 9007199254740991.0 description: Total price of the receivable with discounts before taxes [minor units](https://docs.monite.com/references/currencies#minor-units). document_id: type: string description: The sequential code systematically assigned to invoices. document_rendering: allOf: - $ref: '#/components/schemas/DocumentRenderingSettings' description: Settings for rendering documents in PDF format, including settings for line items and specific document types. due_date: type: string format: date description: Optional field representing date until which invoice should be paid einvoice_file_url: type: string description: E-invoice XML file that was sent to the counterpart via an e-invoicing network. Available only if `is_einvoice` is `true`. entity: anyOf: - $ref: '#/components/schemas/ReceivableEntityOrganization' - $ref: '#/components/schemas/ReceivableEntityIndividual' entity_address: $ref: '#/components/schemas/ReceivableEntityAddressSchema' entity_bank_account: $ref: '#/components/schemas/ReceivablesRepresentationOfEntityBankAccount_2' entity_user_id: type: string format: uuid description: The entity user who created this document. entity_vat_id: $ref: '#/components/schemas/ReceivableEntityVatIDResponse' expiry_date: type: string format: date description: The date (in ISO 8601 format) until which the quote is valid. file_language: allOf: - $ref: '#/components/schemas/LanguageCodeEnum' description: The language of the customer-facing PDF file (`file_url`). The value matches the counterpart's `language` at the time when this PDF file was generated. file_url: type: string description: The receivable's PDF URL in the counterpart's default language. footer: type: string description: Optional text displayed below the line items table in the PDF. issue_date: type: string format: date-time description: Optional field for the issue of the entry. line_items: items: $ref: '#/components/schemas/ResponseItem' type: array memo: type: string description: A note with additional information for a receivable. original_file_language: allOf: - $ref: '#/components/schemas/LanguageCodeEnum' description: The language of the entity's copy of the PDF file (`original_file_url`). The value matches the entity's `language` at the time when this PDF file was generated. original_file_url: type: string description: The receivable's PDF URL in the entity's default language. partner_metadata: type: object description: Metadata for partner needs project_id: type: string format: uuid description: A project related to current receivable quote_accept_page_url: type: string maxLength: 65536 minLength: 1 format: uri description: Link for custom quote accept page signature_required: type: boolean description: Whether acceptance a quote requires a signature. status: allOf: - $ref: '#/components/schemas/QuoteStateEnum' description: The status of the Quote inside the receivable workflow. subtotal: type: integer maximum: 9007199254740991.0 description: The subtotal (excluding VAT), in [minor units](https://docs.monite.com/references/currencies#minor-units). subtotal_after_vat: type: integer maximum: 9007199254740991.0 description: The subtotal including VAT but without invoice discount, in [minor units](https://docs.monite.com/references/currencies#minor-units). tags: items: $ref: '#/components/schemas/TagReadSchema' type: array description: The list of tags for this receivable. default: [] total_amount: type: integer maximum: 9007199254740991.0 description: Total price of the receivable in [minor units](https://docs.monite.com/references/currencies#minor-units). Calculated as a subtotal + total_vat_amount. default: 0 total_deduction_amount: type: integer maximum: 9007199254740991.0 description: The total deduction amount of all deductions, in [minor units](https://docs.monite.com/references/currencies#minor-units). total_vat_amount: type: integer maximum: 9007199254740991.0 description: The total VAT of all line items, in [minor units](https://docs.monite.com/references/currencies#minor-units). total_vat_amounts: items: $ref: '#/components/schemas/TotalVatAmountItem' type: array description: List of total vat amount for each VAT, presented in receivable total_withholding_tax: type: integer description: Total price of the receivable with tax withheld in minor units trade_name: type: string maxLength: 255 description: Trade name of the entity type: type: string enum: - quote description: The type of the document uploaded. vat_exempt: type: boolean description: Indicates whether the goods, materials, or services listed in the receivable are exempt from VAT or not. vat_exemption_rationale: type: string description: The reason for the VAT exemption, if applicable. vat_inclusive_discount_mode: allOf: - $ref: '#/components/schemas/VatModeEnum' description: Indicates whether the discount is applied to the VAT-inclusive or VAT-exclusive amount. default: exclusive vat_mode: allOf: - $ref: '#/components/schemas/VatModeEnum' description: Defines whether the prices of products in receivable will already include VAT or not. default: exclusive withholding_tax_rate: type: integer maximum: 10000.0 minimum: 0.0 description: The amount of tax withheld in percent minor units type: object required: - id - created_at - updated_at - counterpart_id - counterpart_type - currency - entity - entity_address - file_language - line_items - original_file_language - status - total_vat_amount - type LineItem_2: properties: accounting_tax_rate_id: type: string format: uuid description: ID of the tax rate in the connected accounting system, to be used when pushing the invoice to that accounting system. Use `GET /accounting_tax_rates` to get these IDs. If omitted, Monite will attempt to match the tax rates based on their numeric value. custom_vat_rate_id: type: string format: uuid description: Unique identifier of the user-defined vat rate object. discount: allOf: - $ref: '#/components/schemas/Discount' description: The discount for a product. product: allOf: - $ref: '#/components/schemas/LineItemProductCreate' description: Object of product. Can be used instead of product_id, created in product's catalog product_id: type: string format: uuid description: Unique identifier of the product. quantity: type: number maximum: 2147483647.0 minimum: 0.0 description: The quantity of each of the goods, materials, or services listed in the receivable. tax_rate_name: type: string maxLength: 64 minLength: 1 description: Specifies the display name of the tax rate. This field is applicable only when tax_rate_value is also provided. tax_rate_value: type: integer maximum: 10000.0 minimum: 0.0 description: 'Percent minor units. Example: 12.5% is 1250. This field is only required on invoices issued by entities in the US, Pakistan, and other unsupported countries.' tax_status: allOf: - $ref: '#/components/schemas/TaxStatusEnum' description: 'Tax applicability status of the line item. Possible values: * `taxable` (default) - Standard tax behavior. Requires the tax rate to be specified. * `exempt` - Line item is exempt from taxes. Exempt items are not included in total tax calculations. * `non_taxable` - Line item is outside the tax scope entirely, cannot have tax rates.' default: taxable vat_rate_id: type: string format: uuid description: Unique identifier of the vat rate object. This field is required for all entities in supported countries except the US and Pakistan. additionalProperties: false type: object required: - quantity ReceivableCounterpartContact_2: properties: address: allOf: - $ref: '#/components/schemas/ReceivablesRepresentationOfCounterpartAddress' description: The contact address of the counterpart email: type: string format: email description: The contact email of the counterpart. example: marge@example.org first_name: type: string description: The first name of the counterpart contact. example: Marge last_name: type: string description: The last name of the counterpart contact. example: Smith phone: type: string description: The contact phone number of the counterpart. example: '55512378654' title: type: string description: The counterpart contact title (e.g. Dr., Mr., Mrs., Ms., etc). example: Dr. additionalProperties: false type: object required: - address - first_name - last_name UpdateQuote_2: properties: attachments: items: $ref: '#/components/schemas/AttachmentRequest' type: array minItems: 1 description: List of attachments to include with the receivable. Each attachment can be configured for email inclusion. If not provided, no attachments will be associated. contact_id: type: string format: uuid description: Unique ID of the counterpart contact. counterpart_billing_address_id: type: string format: uuid description: Address of invoicing, need to state as a separate fields for some countries if it differs from address of a company. counterpart_id: type: string format: uuid description: Unique ID of the counterpart. counterpart_shipping_address_id: type: string format: uuid description: Address where goods were shipped / where services were provided. counterpart_vat_id_id: type: string format: uuid description: Counterpart VAT ID id currency: $ref: '#/components/schemas/CurrencyEnum' deduction_amount: type: integer maximum: 9007199254740991.0 minimum: 0.0 description: The amount of tax deducted in minor units deprecated: true deduction_memo: type: string description: A note with additional information about a tax deduction deprecated: true deductions: items: $ref: '#/components/schemas/DeductionItem' type: array maxItems: 10 description: List of deductions applied to the receivable (maximum 10 deductions allowed) discount: allOf: - $ref: '#/components/schemas/Discount' description: The discount for a receivable. document_id: type: string maxLength: 100 minLength: 1 description: The document number of the receivable, which will appear in the PDF document. Can be set manually only in the [non-compliant mode](https://docs.monite.com/accounts-receivable/regulatory-compliance/invoice-compliance). Otherwise (or if omitted), it will be generated automatically based on the entity's [document number customization](https://docs.monite.com/advanced/document-number-customization) settings when the document is issued. examples: - INV-0001 - 2024-027 - CUST/2024/00027 document_rendering: allOf: - $ref: '#/components/schemas/DocumentRenderingSettings' description: Settings for rendering documents in PDF format, including settings for line items and specific document types. due_date: type: string format: date description: The date by which the invoice must be paid. entity: $ref: '#/components/schemas/ReceivableEntityBase' entity_bank_account_id: type: string format: uuid description: Entity bank account ID entity_vat_id_id: type: string format: uuid description: Entity VAT ID id expiry_date: type: string format: date description: The date (in ISO 8601 format) until which the quote is valid. footer: type: string description: Optional text displayed below the line items table in the PDF. line_items: items: $ref: '#/components/schemas/LineItemUpdate_2' type: array memo: type: string description: A note with additional information for a receivable partner_metadata: type: object description: Metadata for partner needs payment_terms: $ref: '#/components/schemas/InlinePaymentTermsRequestPayload' payment_terms_id: type: string format: uuid description: Unique ID of the payment terms. project_id: type: string format: uuid description: A project related to current receivable quote_accept_page_url: type: string maxLength: 65536 minLength: 1 format: uri description: Link for custom quote accept page signature_required: type: boolean description: Whether acceptance a quote requires a signature. tag_ids: items: type: string format: uuid type: array description: A list of IDs of user-defined tags (labels) assigned to this receivable. trade_name: type: string maxLength: 255 description: Trade name of the entity vat_exempt: type: boolean description: Indicates whether the goods, materials, or services listed in the receivable are exempt from VAT or not. vat_exemption_rationale: type: string description: The reason for the VAT exemption, if applicable. withholding_tax_rate: type: integer maximum: 10000.0 minimum: 0.0 description: The amount of tax withheld in percent minor units additionalProperties: false type: object UpdateCreditNote_2: properties: attachments: items: $ref: '#/components/schemas/AttachmentRequest' type: array minItems: 1 description: List of attachments to include with the receivable. Each attachment can be configured for email inclusion. If not provided, no attachments will be associated. counterpart_billing_address_id: type: string format: uuid description: Address of invoicing, need to state as a separate fields for some countries if it differs from address of a company. counterpart_contact: allOf: - $ref: '#/components/schemas/ReceivableCounterpartContact_2' description: Additional information about counterpart contacts. counterpart_shipping_address_id: type: string format: uuid description: Address where goods were shipped / where services were provided. document_rendering: allOf: - $ref: '#/components/schemas/DocumentRenderingSettings' description: Settings for rendering documents in PDF format, including settings for line items and specific document types. entity: $ref: '#/components/schemas/ReceivableEntityBase' footer: type: string description: Optional text displayed below the line items table in the PDF. line_items: $ref: '#/components/schemas/UpdateLineItemForCreditNote' memo: type: string description: A note with additional information for a receivable partner_metadata: type: object description: Metadata for partner needs project_id: type: string format: uuid description: A project related to current receivable tag_ids: items: type: string format: uuid type: array description: A list of IDs of user-defined tags (labels) assigned to this receivable. additionalProperties: false type: object LineItemProductVatRate: properties: id: type: string format: uuid description: Unique identifier of the vat rate object. components: items: $ref: '#/components/schemas/VatRateComponent' type: array minItems: 1 description: Sub-taxes included in the VAT. 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 is_custom: type: boolean description: Indicates whether this vat rate is defined by user. default: false name: type: string description: Display name of the vat rate. value: type: integer maximum: 10000.0 minimum: 0.0 description: 'Percent minor units. Example: 12.5% is 1250.' type: object required: - country - value CreditNoteResponsePayload_2: properties: id: type: string format: uuid created_at: type: string format: date-time description: Time at which the receivable was created. Timestamps follow the ISO 8601 standard. updated_at: type: string format: date-time description: Time at which the receivable was last updated. Timestamps follow the ISO 8601 standard. attachments: items: $ref: '#/components/schemas/AttachmentResponse' type: array description: List of attachments to include with the receivable. Each attachment can be configured for email inclusion. If not provided, no attachments will be associated. based_on: type: string format: uuid description: The unique ID of a previous document related to the receivable if applicable. based_on_document_id: type: string description: The unique document ID of a previous document related to the receivable if applicable. commercial_condition_description: type: string description: The commercial terms of the receivable (e.g. The products must be delivered in X days). counterpart_billing_address: allOf: - $ref: '#/components/schemas/ReceivablesRepresentationOfCounterpartAddress' description: Address of invoicing, need to state as a separate fields for some countries if it differs from address of a company. counterpart_business_type: type: string maxLength: 50 description: Different types of companies for different countries, ex. GmbH, SAS, SNC, etc. counterpart_contact: allOf: - $ref: '#/components/schemas/ReceivableCounterpartContact_2' description: Additional information about counterpart contacts. counterpart_einvoicing_credentials: allOf: - $ref: '#/components/schemas/EinvoicingCredentials' description: E-invoicing credentials of the counterpart counterpart_external_reference: type: string description: The external reference of the counterpart. counterpart_id: type: string format: uuid description: Unique ID of the counterpart. counterpart_name: type: string description: A legal name of a counterpart it is an organization or first and last name if it is an individual counterpart_shipping_address: allOf: - $ref: '#/components/schemas/ReceivablesRepresentationOfCounterpartAddress' description: Address where goods were shipped / where services were provided. counterpart_tax_id: type: string description: The VAT/TAX ID of the counterpart. counterpart_type: allOf: - $ref: '#/components/schemas/CounterpartType' description: The type of the counterpart. counterpart_vat_id: $ref: '#/components/schemas/ReceivableCounterpartVatIDResponse' currency: allOf: - $ref: '#/components/schemas/CurrencyEnum' description: The currency used in the receivable. deduction_amount: type: integer maximum: 9007199254740991.0 minimum: 0.0 description: The amount of tax deducted in minor units deprecated: true deduction_memo: type: string description: A note with additional information about a tax deduction deprecated: true deductions: items: $ref: '#/components/schemas/DeductionItem' type: array maxItems: 10 description: List of deductions applied to the receivable (maximum 10 deductions allowed) discount: allOf: - $ref: '#/components/schemas/DiscountResponse' description: The discount for a receivable. discounted_subtotal: type: integer maximum: 9007199254740991.0 description: Total price of the receivable with discounts before taxes [minor units](https://docs.monite.com/references/currencies#minor-units). document_id: type: string description: The sequential code systematically assigned to invoices. document_rendering: allOf: - $ref: '#/components/schemas/DocumentRenderingSettings' description: Settings for rendering documents in PDF format, including settings for line items and specific document types. due_date: type: string format: date description: Optional field representing date until which invoice should be paid einvoice_error_comment: type: string description: Error that was returned by E-invoicing einvoice_file_url: type: string description: E-invoice XML file that was sent to the counterpart via an e-invoicing network. Available only if `is_einvoice` is `true`. entity: anyOf: - $ref: '#/components/schemas/ReceivableEntityOrganization' - $ref: '#/components/schemas/ReceivableEntityIndividual' entity_address: $ref: '#/components/schemas/ReceivableEntityAddressSchema' entity_bank_account: $ref: '#/components/schemas/ReceivablesRepresentationOfEntityBankAccount_2' entity_user_id: type: string format: uuid description: The entity user who created this document. entity_vat_id: $ref: '#/components/schemas/ReceivableEntityVatIDResponse' file_language: allOf: - $ref: '#/components/schemas/LanguageCodeEnum' description: The language of the customer-facing PDF file (`file_url`). The value matches the counterpart's `language` at the time when this PDF file was generated. file_url: type: string description: The receivable's PDF URL in the counterpart's default language. footer: type: string description: Optional text displayed below the line items table in the PDF. is_einvoice: type: boolean description: If `true`, the credit note will be sent through an e-invoicing network. The value is inherited from the invoice for which the credit note was created, and cannot be changed. default: false issue_date: type: string format: date-time description: Optional field for the issue of the entry. line_items: items: $ref: '#/components/schemas/ResponseItem' type: array memo: type: string description: A note with additional information for a receivable. network_credentials: allOf: - $ref: '#/components/schemas/EinvoicingCredentials' description: E-invoicing credentials of the entity original_file_language: allOf: - $ref: '#/components/schemas/LanguageCodeEnum' description: The language of the entity's copy of the PDF file (`original_file_url`). The value matches the entity's `language` at the time when this PDF file was generated. original_file_url: type: string description: The receivable's PDF URL in the entity's default language. partner_metadata: type: object description: Metadata for partner needs project_id: type: string format: uuid description: A project related to current receivable purchase_order: type: string maxLength: 100 description: Contain purchase order number. status: allOf: - $ref: '#/components/schemas/CreditNoteStateEnum' description: The status of the Credit Note inside the receivable workflow. subtotal: type: integer maximum: 9007199254740991.0 description: The subtotal (excluding VAT), in [minor units](https://docs.monite.com/references/currencies#minor-units). subtotal_after_vat: type: integer maximum: 9007199254740991.0 description: The subtotal including VAT but without invoice discount, in [minor units](https://docs.monite.com/references/currencies#minor-units). tags: items: $ref: '#/components/schemas/TagReadSchema' type: array description: The list of tags for this receivable. default: [] total_amount: type: integer maximum: 9007199254740991.0 description: Total price of the receivable in [minor units](https://docs.monite.com/references/currencies#minor-units). Calculated as a subtotal + total_vat_amount. default: 0 total_deduction_amount: type: integer maximum: 9007199254740991.0 description: The total deduction amount of all deductions, in [minor units](https://docs.monite.com/references/currencies#minor-units). total_vat_amount: type: integer maximum: 9007199254740991.0 description: The total VAT of all line items, in [minor units](https://docs.monite.com/references/currencies#minor-units). total_vat_amounts: items: $ref: '#/components/schemas/TotalVatAmountItem' type: array description: List of total vat amount for each VAT, presented in receivable total_withholding_tax: type: integer description: Total price of the receivable with tax withheld in minor units trade_name: type: string maxLength: 255 description: Trade name of the entity type: type: string enum: - credit_note description: The type of the receivable vat_exempt: type: boolean description: Indicates whether the goods, materials, or services listed in the receivable are exempt from VAT or not. vat_exemption_rationale: type: string description: The reason for the VAT exemption, if applicable. vat_inclusive_discount_mode: allOf: - $ref: '#/components/schemas/VatModeEnum' description: Indicates whether the discount is applied to the VAT-inclusive or VAT-exclusive amount. default: exclusive vat_mode: allOf: - $ref: '#/components/schemas/VatModeEnum' description: Defines whether the prices of products in receivable will already include VAT or not. default: exclusive withholding_tax_rate: type: integer maximum: 10000.0 minimum: 0.0 description: The amount of tax withheld in percent minor units type: object required: - id - created_at - updated_at - counterpart_id - counterpart_type - currency - entity - entity_address - file_language - line_items - original_file_language - status - total_vat_amount - type LineItemProduct_2: properties: id: type: string format: uuid description: Unique ID of the product. accounting_tax_rate_id: type: string format: uuid description: Unique identifier of the accounting tax rate object. description: type: string description: Description of the product. external_reference: type: string maxLength: 255 minLength: 1 description: A user-defined identifier of the product. For example, an internal product code or SKU (stock keeping unit). Client applications can use this field to map the products in Monite to an external product catalog. examples: - HT-1234-S-BL - SERVICE-67890 is_inline: type: boolean description: Indicates whether the product is inline default: false ledger_account_id: type: string format: uuid measure_unit: $ref: '#/components/schemas/LineItemProductMeasureUnit_2' name: type: string description: Name of the product. price: $ref: '#/components/schemas/Price' price_after_vat: $ref: '#/components/schemas/Price' smallest_amount: type: number maximum: 2147483647.0 minimum: 0.0 description: The smallest amount allowed for this product. type: allOf: - $ref: '#/components/schemas/ProductServiceTypeEnum' description: Specifies whether this offering is a product or service. This may affect the applicable tax rates. default: product vat_rate: $ref: '#/components/schemas/LineItemProductVatRate' type: object required: - id - name - price - price_after_vat - vat_rate ReceivablesRepresentationOfCounterpartAddress: properties: id: type: string format: uuid description: Unique ID of the address in the system 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 required: - city - country - line1 - postal_code ReceivableSendRequest_2: properties: body_text: type: string minLength: 1 description: Body text of the content recipients: $ref: '#/components/schemas/Recipients' subject_text: type: string minLength: 1 description: Subject text of the content additionalProperties: false type: object required: - body_text - subject_text description: A schema for receiving a request for sending a receivable ReceivablesSearchRequest_3: properties: based_on: type: string format: uuid description: 'This parameter accepts a quote ID or an invoice ID. * Specify a quote ID to find invoices created from this quote. * Specify an invoice ID to find credit notes created for this invoice. Valid but nonexistent IDs do not raise errors but produce no results.' counterpart_id: type: string format: uuid description: 'Return only receivables created for the counterpart with the specified ID. Counterparts that have been deleted but have associated receivables will still return results here because the receivables contain a frozen copy of the counterpart data. If the specified counterpart ID does not exist and never existed, no results are returned.' counterpart_name: type: string description: Return only receivables created for counterparts with the specified name (exact match, case-sensitive). For counterparts of `type` = `individual`, the full name is formatted as `first_name last_name`. counterpart_name__contains: type: string description: Return only receivables created for counterparts whose name contains the specified string (case-sensitive). counterpart_name__icontains: type: string description: Return only receivables created for counterparts whose name contains the specified string (case-insensitive). created_at__gt: type: string format: date-time description: Return only receivables created after the specified date and time. The value must be in the ISO 8601 format `YYYY-MM-DDThh:mm[:ss][Z|±hh:mm]`. Milliseconds are ignored. created_at__gte: type: string format: date-time description: Return only receivables created on or after the specified date and time. created_at__lt: type: string format: date-time description: Return only receivables created before the specified date and time. created_at__lte: type: string format: date-time description: Return only receivables created before or on the specified date and time. discounted_subtotal: type: integer description: Return only receivables with the exact specified discounted subtotal. The amount must be specified in the [minor units](https://docs.monite.com/references/currencies#minor-units) of currency. For example, $12.5 is represented as 1250. discounted_subtotal__gt: type: integer description: Return only receivables whose discounted subtotal (in minor units) is greater than the specified value. discounted_subtotal__gte: type: integer description: Return only receivables whose discounted subtotal (in minor units) is greater than or equal to the specified value. discounted_subtotal__lt: type: integer description: Return only receivables whose discounted subtotal (in minor units) is less than the specified value. discounted_subtotal__lte: type: integer description: Return only receivables whose discounted subtotal (in minor units) is less than or equal to the specified value. document_id: type: string description: Return a receivable 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`). document_id__contains: type: string description: Return only receivables whose document number (`document_id`) contains the specified string (case-sensitive). document_id__icontains: type: string description: Return only receivables whose document number (`document_id`) contains the specified string (case-insensitive). due_date__gt: type: string format: date description: 'Return invoices that are due after the specified date (exclusive, `YYYY-MM-DD`). This filter excludes quotes, credit notes, and draft invoices.' due_date__gte: type: string format: date description: 'Return invoices that are due on or after the specified date (`YYYY-MM-DD`). This filter excludes quotes, credit notes, and draft invoices.' due_date__lt: type: string format: date description: 'Return invoices that are due before the specified date (exclusive, `YYYY-MM-DD`). This filter excludes quotes, credit notes, and draft invoices.' due_date__lte: type: string format: date description: 'Return invoices that are due before or on the specified date (`YYYY-MM-DD`). This filter excludes quotes, credit notes, and draft invoices.' entity_user_id: type: string format: uuid description: 'Return only receivables created by the entity user with the specified ID. To query receivables by multiple user IDs at once, use the `entity_user_id__in` parameter instead. If the request is authenticated using an entity user token, this user must have the `receivable.read.allowed` (rather than `allowed_for_own`) permission to be able to query receivables created by other users. IDs of deleted users will still produce results here if those users had associated receivables. Valid but nonexistent user IDs do not raise errors but produce no results.' entity_user_id__in: items: type: string format: uuid type: array has_due_date: type: boolean description: Return only receivables that have a due date set. true=only invoices with due_date, false=only invoices without due_date id__in: items: type: string format: uuid type: array issue_date__gt: type: string format: date-time description: Return only non-draft receivables that were issued after the specified date and time. The value must be in the ISO 8601 format `YYYY-MM-DDThh:mm[:ss][Z|±hh:mm]`. Milliseconds are ignored. issue_date__gte: type: string format: date-time description: Return only non-draft receivables that were issued on or after the specified date and time. issue_date__lt: type: string format: date-time description: Return only non-draft receivables that were issued before the specified date and time. issue_date__lte: type: string format: date-time description: Return only non-draft receivables that were issued before or on the specified date and time. limit: type: integer maximum: 250.0 minimum: 1.0 default: 100 order: allOf: - $ref: '#/components/schemas/OrderEnum' default: asc pagination_token: type: string product_ids: items: type: string format: uuid type: array product_ids__in: items: type: string format: uuid type: array project_id: type: string format: uuid description: Return only receivables assigned to the project with the specified ID. Valid but nonexistent project IDs do not raise errors but return no results. project_id__in: items: type: string format: uuid type: array search_text: type: string description: Case-insensitive and partial match search for the specified text in the `document_id` and `counterpart_name` fields of the receivables. sort: $ref: '#/components/schemas/ReceivableCursorFields2' status: type: string enum: - draft - issuing - issued - failed - accepted - expired - declined - recurring - partially_paid - paid - overdue - uncollectible - canceled description: 'Return only receivables that have the specified status. See the applicable [invoice statuses](https://docs.monite.com/accounts-receivable/invoices/index), [quote statuses](https://docs.monite.com/accounts-receivable/quotes/index), and [credit note statuses](https://docs.monite.com/accounts-receivable/credit-notes#credit-note-lifecycle). To query multiple statuses at once, use the `status__in` parameter instead.' status__in: items: type: string type: array tag_ids: items: type: string format: uuid type: array tag_ids__in: items: type: string format: uuid type: array total_amount: type: integer description: Return only receivables with the exact specified total amount. The amount must be specified in the [minor units](https://docs.monite.com/references/currencies#minor-units) of currency. For example, $12.5 is represented as 1250. total_amount__gt: type: integer description: Return only receivables whose total amount (in minor units) exceeds the specified value. total_amount__gte: type: integer description: Return only receivables whose total amount (in minor units) is greater than or equal to the specified value. total_amount__lt: type: integer description: Return only receivables whose total amount (in minor units) is less than the specified value. total_amount__lte: type: integer description: Return only receivables whose total amount (in minor units) is less than or equal to the specified value. type: allOf: - $ref: '#/components/schemas/ReceivableType' description: Return only receivables of the specified type. Use this parameter to get only invoices, or only quotes, or only credit notes. additionalProperties: false type: object LineItemUpdate_3: properties: custom_vat_rate_id: type: string format: uuid description: Unique identifier of the user-defined vat rate object. discount: allOf: - $ref: '#/components/schemas/Discount' description: The discount for a product. price: type: integer maximum: 9007199254740991.0 minimum: 0.0 description: The actual price of the product in [minor units](https://docs.monite.com/references/currencies#minor-units). quantity: type: number maximum: 2147483647.0 minimum: 0.0 description: The quantity of each of the goods, materials, or services listed in the receivable. tax_rate_name: type: string maxLength: 64 description: Specifies the display name of the tax rate. This field is applicable only when tax_rate_value is also provided. tax_rate_value: type: integer maximum: 10000.0 minimum: 0.0 description: 'Percent minor units. Example: 12.5% is 1250. This field is only required on invoices issued by entities in the US, Pakistan, and other unsupported countries.' tax_status: allOf: - $ref: '#/components/schemas/TaxStatusEnum' description: 'Tax applicability status of the line item. Possible values: * `taxable` (default) - Standard tax behavior. Requires the tax rate to be specified. * `exempt` - Line item is exempt from taxes. Exempt items are not included in total tax calculations. * `non_taxable` - Line item is outside the tax scope entirely, cannot have tax rates.' vat_rate_id: type: string format: uuid description: Unique identifier of the vat rate object. This field is required for all entities in supported countries except the US and Pakistan. additionalProperties: false type: object ReceivableFacadeCreateQuotePayload_3: properties: attachments: items: $ref: '#/components/schemas/AttachmentRequest' type: array minItems: 1 description: List of attachments to include with the receivable. Each attachment can be configured for email inclusion. If not provided, no attachments will be associated. commercial_condition_description: type: string counterpart_billing_address_id: type: string format: uuid description: Address of invoicing, need to state as a separate fields for some countries if it differs from address of a company. counterpart_business_type: type: string maxLength: 50 description: Different types of companies for different countries, ex. GmbH, SAS, SNC, etc. counterpart_id: type: string format: uuid counterpart_shipping_address_id: type: string format: uuid description: Address where goods were shipped / where services were provided. counterpart_vat_id_id: type: string format: uuid description: Counterpart VAT ID id currency: $ref: '#/components/schemas/CurrencyEnum' deduction_amount: type: integer maximum: 9007199254740991.0 minimum: 0.0 description: The amount of tax deducted in minor units deprecated: true deduction_memo: type: string description: A note with additional information about a tax deduction deprecated: true deductions: items: $ref: '#/components/schemas/DeductionItem' type: array maxItems: 10 description: List of deductions applied to the receivable (maximum 10 deductions allowed) discount: allOf: - $ref: '#/components/schemas/Discount' description: The discount for a receivable. document_id: type: string maxLength: 100 minLength: 1 description: The document number of the receivable, which will appear in the PDF document. Can be set manually only in the [non-compliant mode](https://docs.monite.com/accounts-receivable/regulatory-compliance/invoice-compliance). Otherwise (or if omitted), it will be generated automatically based on the entity's [document number customization](https://docs.monite.com/advanced/document-number-customization) settings when the document is issued. examples: - INV-0001 - 2024-027 - CUST/2024/00027 document_rendering: allOf: - $ref: '#/components/schemas/DocumentRenderingSettings' description: Settings for rendering documents in PDF format, including settings for line items and specific document types. entity: $ref: '#/components/schemas/ReceivableEntityBase' entity_bank_account_id: type: string format: uuid description: Entity bank account ID entity_vat_id_id: type: string format: uuid description: Entity VAT ID id expiry_date: type: string format: date description: The date (in ISO 8601 format) until which the quote is valid. footer: type: string description: Optional text displayed below the line items table in the PDF. line_items: items: $ref: '#/components/schemas/LineItem_3' type: array memo: type: string description: A note with additional information for a receivable partner_metadata: type: object description: Metadata for partner needs project_id: type: string format: uuid description: A project related to current receivable quote_accept_page_url: type: string maxLength: 65536 minLength: 1 format: uri description: Link for custom quote accept page signature_required: type: boolean description: Whether acceptance a quote requires a signature. tag_ids: items: type: string format: uuid type: array description: A list of IDs of user-defined tags (labels) assigned to this receivable. default: [] trade_name: type: string maxLength: 255 description: Trade name of the entity type: type: string enum: - quote description: The type of the document uploaded. vat_exempt: type: boolean description: Indicates whether the goods, materials, or services listed in the receivable are exempt from VAT or not. vat_exemption_rationale: type: string description: The reason for the VAT exemption, if applicable. vat_mode: allOf: - $ref: '#/components/schemas/VatModeEnum' description: Defines whether the prices of products in receivable will already include VAT or not. withholding_tax_rate: type: integer maximum: 10000.0 minimum: 0.0 description: The amount of tax withheld in percent minor units additionalProperties: false type: object required: - counterpart_billing_address_id - counterpart_id - currency - line_items - type ReceivablesVerifyResponse_2: properties: errors: allOf: - $ref: '#/components/schemas/MissingFields_3' description: Missing fields of receivable warnings: allOf: - $ref: '#/components/schemas/ReceivablesRemindersWarningMessage' description: Warning message for payment reminder additionalProperties: false type: object description: A schema for returning a response with validation results LineItemProductMeasureUnit_3: properties: id: type: string format: uuid description: type: string maxLength: 200 name: type: string maxLength: 100 minLength: 1 type: object required: - name ReceivablesRepresentationOfEntityBankAccount_3: properties: id: type: string format: uuid description: Unique ID of the entity bank account. account_holder_name: type: string description: Account holder's name account_number: type: string description: Account number (required if IBAN is not provided) bank_name: type: string description: The name of the entity's bank account. bic: type: string description: The BIC of the entity's bank account. iban: type: string description: The IBAN of the entity's bank account. routing_number: type: string description: Routing number (US) sort_code: type: string description: Sort code (GB) type: object UpdateInvoice_3: properties: attachments: items: $ref: '#/components/schemas/AttachmentRequest' type: array minItems: 1 description: List of attachments to include with the receivable. Each attachment can be configured for email inclusion. If not provided, no attachments will be associated. contact_id: type: string format: uuid description: Unique ID of the counterpart contact. counterpart_billing_address_id: type: string format: uuid description: Address of invoicing, need to state as a separate fields for some countries if it differs from address of a company. counterpart_einvoicing_credentials_id: type: string format: uuid description: E-invoicing credentials ID of the counterpart counterpart_id: type: string format: uuid description: Unique ID of the counterpart. counterpart_shipping_address_id: type: string format: uuid description: Address where goods were shipped / where services were provided. counterpart_vat_id_id: type: string format: uuid description: Counterpart VAT ID id currency: $ref: '#/components/schemas/CurrencyEnum' deduction_amount: type: integer maximum: 9007199254740991.0 minimum: 0.0 description: The amount of tax deducted in minor units deprecated: true deduction_memo: type: string description: A note with additional information about a tax deduction deprecated: true deductions: items: $ref: '#/components/schemas/DeductionItem' type: array maxItems: 10 description: List of deductions applied to the receivable (maximum 10 deductions allowed) discount: allOf: - $ref: '#/components/schemas/Discount' description: The discount for a receivable. document_id: type: string maxLength: 100 minLength: 1 description: The document number of the receivable, which will appear in the PDF document. Can be set manually only in the [non-compliant mode](https://docs.monite.com/accounts-receivable/regulatory-compliance/invoice-compliance). Otherwise (or if omitted), it will be generated automatically based on the entity's [document number customization](https://docs.monite.com/advanced/document-number-customization) settings when the document is issued. examples: - INV-0001 - 2024-027 - CUST/2024/00027 document_rendering: allOf: - $ref: '#/components/schemas/DocumentRenderingSettings' description: Settings for rendering documents in PDF format, including settings for line items and specific document types. due_date: type: string format: date description: The date by which the invoice must be paid. entity: $ref: '#/components/schemas/ReceivableEntityBase' entity_bank_account_id: type: string format: uuid description: Entity bank account ID entity_vat_id_id: type: string format: uuid description: Entity VAT ID id footer: type: string description: Optional text displayed below the line items table in the PDF. fulfillment_date: type: string format: date description: 'The date when the goods are shipped or the service is provided. Can be a current, past, or future date. Some countries require the fulfillment date in invoices for regulatory compliance. In this case, if the fulfillment date was not provided by the user, it is automatically set to the invoice issue date once the invoice gets issued. In countries where the fulfillment date is optional, Monite does not auto-assign it if it was omitted by the user.' is_einvoice: type: boolean description: Is this Invoice will be sent through E-invoice system line_items: items: $ref: '#/components/schemas/LineItemUpdate_3' type: array memo: type: string description: A note with additional information for a receivable network_credentials_id: type: string format: uuid description: E-invoicing network credentials ID of the entity overdue_reminder_id: type: string format: uuid partner_metadata: type: object description: Metadata for partner needs payment_page_url: type: string maxLength: 2083 minLength: 1 format: uri description: Link to your invoice's custom payment rails or external payment link. payment_reminder_id: type: string format: uuid payment_terms: $ref: '#/components/schemas/InlinePaymentTermsRequestPayload' payment_terms_id: type: string format: uuid description: Unique ID of the payment terms. project_id: type: string format: uuid description: A project related to current receivable tag_ids: items: type: string format: uuid type: array description: A list of IDs of user-defined tags (labels) assigned to this receivable. trade_name: type: string maxLength: 255 description: Trade name of the entity vat_exempt: type: boolean description: Indicates whether the goods, materials, or services listed in the receivable are exempt from VAT or not. vat_exemption_rationale: type: string description: The reason for the VAT exemption, if applicable. withholding_tax_rate: type: integer maximum: 10000.0 minimum: 0.0 description: The amount of tax withheld in percent minor units additionalProperties: false type: object ReceivableFacadeCreateInvoicePayload_3: properties: attachments: items: $ref: '#/components/schemas/AttachmentRequest' type: array minItems: 1 description: List of attachments to include with the receivable. Each attachment can be configured for email inclusion. If not provided, no attachments will be associated. commercial_condition_description: type: string counterpart_billing_address_id: type: string format: uuid description: Address of invoicing, need to state as a separate fields for some countries if it differs from address of a company. counterpart_business_type: type: string maxLength: 50 description: Different types of companies for different countries, ex. GmbH, SAS, SNC, etc. counterpart_einvoicing_credentials_id: type: string format: uuid description: E-invoicing credentials ID of the counterpart counterpart_id: type: string format: uuid counterpart_shipping_address_id: type: string format: uuid description: Address where goods were shipped / where services were provided. counterpart_vat_id_id: type: string format: uuid description: Counterpart VAT ID id currency: $ref: '#/components/schemas/CurrencyEnum' deduction_amount: type: integer maximum: 9007199254740991.0 minimum: 0.0 description: The amount of tax deducted in minor units deprecated: true deduction_memo: type: string description: A note with additional information about a tax deduction deprecated: true deductions: items: $ref: '#/components/schemas/DeductionItem' type: array maxItems: 10 description: List of deductions applied to the receivable (maximum 10 deductions allowed) discount: allOf: - $ref: '#/components/schemas/Discount' description: The discount for a receivable. document_id: type: string maxLength: 100 minLength: 1 description: The document number of the receivable, which will appear in the PDF document. Can be set manually only in the [non-compliant mode](https://docs.monite.com/accounts-receivable/regulatory-compliance/invoice-compliance). Otherwise (or if omitted), it will be generated automatically based on the entity's [document number customization](https://docs.monite.com/advanced/document-number-customization) settings when the document is issued. examples: - INV-0001 - 2024-027 - CUST/2024/00027 document_rendering: allOf: - $ref: '#/components/schemas/DocumentRenderingSettings' description: Settings for rendering documents in PDF format, including settings for line items and specific document types. entity: $ref: '#/components/schemas/ReceivableEntityBase' entity_bank_account_id: type: string format: uuid description: Entity bank account ID entity_vat_id_id: type: string format: uuid description: Entity VAT ID id footer: type: string description: Optional text displayed below the line items table in the PDF. fulfillment_date: type: string format: date description: 'The date when the goods are shipped or the service is provided. Can be a current, past, or future date. Some countries require the fulfillment date in invoices for regulatory compliance. In this case, if the fulfillment date was not provided by the user, it is automatically set to the invoice issue date once the invoice gets issued. In countries where the fulfillment date is optional, Monite does not auto-assign it if it was omitted by the user.' is_einvoice: type: boolean description: Is this Invoice will be sent through E-invoice system default: false line_items: items: $ref: '#/components/schemas/LineItem_3' type: array memo: type: string description: A note with additional information for a receivable network_credentials_id: type: string format: uuid description: E-invoicing credentials ID of the entity overdue_reminder_id: type: string format: uuid partner_metadata: type: object description: Metadata for partner needs payment_page_url: type: string maxLength: 2083 minLength: 1 format: uri description: Link to the invoice's payment page. Either Monite's payment links or your custom payment links. payment_reminder_id: type: string format: uuid payment_terms: $ref: '#/components/schemas/InlinePaymentTermsRequestPayload' payment_terms_id: type: string format: uuid project_id: type: string format: uuid description: A project related to current receivable purchase_order: type: string maxLength: 100 description: Contain purchase order number. tag_ids: items: type: string format: uuid type: array description: A list of IDs of user-defined tags (labels) assigned to this receivable. default: [] trade_name: type: string maxLength: 255 description: Trade name of the entity type: type: string enum: - invoice description: The type of the document uploaded. vat_exempt: type: boolean description: Indicates whether the goods, materials, or services listed in the receivable are exempt from VAT or not. vat_exemption_rationale: type: string description: The reason for the VAT exemption, if applicable. vat_mode: allOf: - $ref: '#/components/schemas/VatModeEnum' description: Defines whether the prices of products in receivable will already include VAT or not. withholding_tax_rate: type: integer maximum: 10000.0 minimum: 0.0 description: The amount of tax withheld in percent minor units additionalProperties: false type: object required: - counterpart_billing_address_id - counterpart_id - currency - line_items - type InvoiceResponsePayload_3: properties: id: type: string format: uuid created_at: type: string format: date-time description: Time at which the receivable was created. Timestamps follow the ISO 8601 standard. updated_at: type: string format: date-time description: Time at which the receivable was last updated. Timestamps follow the ISO 8601 standard. amount_due: type: integer maximum: 9007199254740991.0 description: How much is left to be paid in [minor units](https://docs.monite.com/references/currencies#minor-units). Equal 0 if the Invoice is fully paid. amount_paid: type: integer maximum: 9007199254740991.0 description: How much has been paid [minor units](https://docs.monite.com/references/currencies#minor-units) amount_to_pay: type: integer maximum: 9007199254740991.0 description: How much is left to be paid in in [minor units](https://docs.monite.com/references/currencies#minor-units), including payment_term discounts. attachments: items: $ref: '#/components/schemas/AttachmentResponse' type: array description: List of attachments to include with the receivable. Each attachment can be configured for email inclusion. If not provided, no attachments will be associated. based_on: type: string format: uuid description: The unique ID of a previous document related to the receivable if applicable. based_on_document_id: type: string description: The unique document ID of a previous document related to the receivable if applicable. comment: type: string description: Field with a comment for pay/partially/uncollectible info on this Invoice commercial_condition_description: type: string description: The commercial terms of the receivable (e.g. The products must be delivered in X days). counterpart_billing_address: allOf: - $ref: '#/components/schemas/ReceivablesRepresentationOfCounterpartAddress' description: Address of invoicing, need to state as a separate fields for some countries if it differs from address of a company. counterpart_business_type: type: string maxLength: 50 description: Different types of companies for different countries, ex. GmbH, SAS, SNC, etc. counterpart_contact: allOf: - $ref: '#/components/schemas/ReceivableCounterpartContact_3' description: Additional information about counterpart contacts. counterpart_einvoicing_credentials: allOf: - $ref: '#/components/schemas/EinvoicingCredentials' description: E-invoicing credentials of the counterpart counterpart_external_reference: type: string description: The external reference of the counterpart. counterpart_id: type: string format: uuid description: Unique ID of the counterpart. counterpart_name: type: string description: A legal name of a counterpart it is an organization or first and last name if it is an individual counterpart_shipping_address: allOf: - $ref: '#/components/schemas/ReceivablesRepresentationOfCounterpartAddress' description: Address where goods were shipped / where services were provided. counterpart_tax_id: type: string description: The VAT/TAX ID of the counterpart. counterpart_type: allOf: - $ref: '#/components/schemas/CounterpartType' description: The type of the counterpart. counterpart_vat_id: $ref: '#/components/schemas/ReceivableCounterpartVatIDResponse' currency: allOf: - $ref: '#/components/schemas/CurrencyEnum' description: The currency used in the receivable. deduction_amount: type: integer maximum: 9007199254740991.0 minimum: 0.0 description: The amount of tax deducted in minor units deprecated: true deduction_memo: type: string description: A note with additional information about a tax deduction deprecated: true deductions: items: $ref: '#/components/schemas/DeductionItem' type: array maxItems: 10 description: List of deductions applied to the receivable (maximum 10 deductions allowed) discount: allOf: - $ref: '#/components/schemas/DiscountResponse' description: The discount for a receivable. discounted_subtotal: type: integer maximum: 9007199254740991.0 description: Total price of the receivable with discounts before taxes [minor units](https://docs.monite.com/references/currencies#minor-units). document_id: type: string description: The sequential code systematically assigned to invoices. document_rendering: allOf: - $ref: '#/components/schemas/DocumentRenderingSettings' description: Settings for rendering documents in PDF format, including settings for line items and specific document types. due_date: type: string format: date description: Optional field representing date until which invoice should be paid einvoice_error_comment: type: string description: Error that was returned by E-invoicing einvoice_file_url: type: string description: E-invoice XML file that was sent to the counterpart via an e-invoicing network. Available only if `is_einvoice` is `true`. entity: anyOf: - $ref: '#/components/schemas/ReceivableEntityOrganization' - $ref: '#/components/schemas/ReceivableEntityIndividual' entity_address: $ref: '#/components/schemas/ReceivableEntityAddressSchema' entity_bank_account: $ref: '#/components/schemas/ReceivablesRepresentationOfEntityBankAccount_3' entity_user_id: type: string format: uuid description: The entity user who created this document. entity_vat_id: $ref: '#/components/schemas/ReceivableEntityVatIDResponse' file_language: allOf: - $ref: '#/components/schemas/LanguageCodeEnum' description: The language of the customer-facing PDF file (`file_url`). The value matches the counterpart's `language` at the time when this PDF file was generated. file_url: type: string description: The receivable's PDF URL in the counterpart's default language. footer: type: string description: Optional text displayed below the line items table in the PDF. fulfillment_date: type: string format: date description: 'The date when the goods are shipped or the service is provided. Can be a current, past, or future date. Some countries require the fulfillment date in invoices for regulatory compliance. In this case, if the fulfillment date was not provided by the user, it is automatically set to the invoice issue date once the invoice gets issued. In countries where the fulfillment date is optional, Monite does not auto-assign it if it was omitted by the user.' is_einvoice: type: boolean description: Is this Invoice will be sent through E-invoice system default: false issue_date: type: string format: date-time description: Optional field for the issue of the entry. line_items: items: $ref: '#/components/schemas/ResponseItem' type: array memo: type: string description: A note with additional information for a receivable. network_credentials: allOf: - $ref: '#/components/schemas/EinvoicingCredentials' description: E-invoicing credentials of the entity original_file_language: allOf: - $ref: '#/components/schemas/LanguageCodeEnum' description: The language of the entity's copy of the PDF file (`original_file_url`). The value matches the entity's `language` at the time when this PDF file was generated. original_file_url: type: string description: The receivable's PDF URL in the entity's default language. overdue_reminder_id: type: string format: uuid paid_at: type: string format: date-time description: Date and time when the invoice was paid. partner_metadata: type: object description: Metadata for partner needs payment_page_url: type: string maxLength: 2083 minLength: 1 format: uri description: Link to the invoice's payment page. Either Monite's payment links or your custom payment links. payment_reminder_id: type: string format: uuid payment_terms: $ref: '#/components/schemas/PaymentTerms' project_id: type: string format: uuid description: A project related to current receivable purchase_order: type: string maxLength: 100 description: Contain purchase order number. recurrence_id: type: string format: uuid description: Stores an unique ID of a recurrence if the receivable is in a recurring status related_documents: allOf: - $ref: '#/components/schemas/RelatedDocuments' description: Ids of documents that relate to invoice. I.e credit notes, proforma invoices, etc. status: allOf: - $ref: '#/components/schemas/ReceivablesStatusEnum' description: The status of the receivable inside the receivable workflow. subtotal: type: integer maximum: 9007199254740991.0 description: The subtotal (excluding VAT), in [minor units](https://docs.monite.com/references/currencies#minor-units). subtotal_after_vat: type: integer maximum: 9007199254740991.0 description: The subtotal including VAT but without invoice discount, in [minor units](https://docs.monite.com/references/currencies#minor-units). tags: items: $ref: '#/components/schemas/TagReadSchema' type: array description: The list of tags for this receivable. default: [] total_amount: type: integer maximum: 9007199254740991.0 description: Total price of the receivable in [minor units](https://docs.monite.com/references/currencies#minor-units). Calculated as a subtotal + total_vat_amount. default: 0 total_amount_with_credit_notes: type: integer maximum: 9007199254740991.0 description: The total price of the receivable in [minor units](https://docs.monite.com/references/currencies#minor-units), including VAT and excluding all issued credit notes. total_deduction_amount: type: integer maximum: 9007199254740991.0 description: The total deduction amount of all deductions, in [minor units](https://docs.monite.com/references/currencies#minor-units). total_vat_amount: type: integer maximum: 9007199254740991.0 description: The total VAT of all line items, in [minor units](https://docs.monite.com/references/currencies#minor-units). total_vat_amounts: items: $ref: '#/components/schemas/TotalVatAmountItem' type: array description: List of total vat amount for each VAT, presented in receivable total_withholding_tax: type: integer description: Total price of the receivable with tax withheld in minor units trade_name: type: string maxLength: 255 description: Trade name of the entity type: type: string enum: - invoice description: The type of the document uploaded. vat_exempt: type: boolean description: Indicates whether the goods, materials, or services listed in the receivable are exempt from VAT or not. vat_exemption_rationale: type: string description: The reason for the VAT exemption, if applicable. vat_inclusive_discount_mode: allOf: - $ref: '#/components/schemas/VatModeEnum' description: Indicates whether the discount is applied to the VAT-inclusive or VAT-exclusive amount. default: exclusive vat_mode: allOf: - $ref: '#/components/schemas/VatModeEnum' description: Defines whether the prices of products in receivable will already include VAT or not. default: exclusive withholding_tax_rate: type: integer maximum: 10000.0 minimum: 0.0 description: The amount of tax withheld in percent minor units type: object required: - id - created_at - updated_at - amount_due - amount_paid - counterpart_id - counterpart_type - currency - entity - entity_address - file_language - line_items - original_file_language - related_documents - status - total_amount_with_credit_notes - total_vat_amount - type MissingFields_3: properties: counterpart: items: type: string type: array description: Missing fields of counterpart. entity: items: type: string type: array description: Missing fields of entity. products: items: $ref: '#/components/schemas/MissingLineItemFields' type: array description: Missing fields of line items. receivable: items: type: string type: array description: Missing fields of receivable. vat_rates: items: type: string type: array description: List of invalid vat rates. additionalProperties: false type: object QuoteResponsePayload_3: properties: id: type: string format: uuid created_at: type: string format: date-time description: Time at which the receivable was created. Timestamps follow the ISO 8601 standard. updated_at: type: string format: date-time description: Time at which the receivable was last updated. Timestamps follow the ISO 8601 standard. attachments: items: $ref: '#/components/schemas/AttachmentResponse' type: array description: List of attachments to include with the receivable. Each attachment can be configured for email inclusion. If not provided, no attachments will be associated. based_on: type: string format: uuid description: The unique ID of a previous document related to the receivable if applicable. based_on_document_id: type: string description: The unique document ID of a previous document related to the receivable if applicable. comment: type: string description: Field with a comment on why the client declined this Quote commercial_condition_description: type: string description: The commercial terms of the receivable (e.g. The products must be delivered in X days). counterpart_billing_address: allOf: - $ref: '#/components/schemas/ReceivablesRepresentationOfCounterpartAddress' description: Address of invoicing, need to state as a separate fields for some countries if it differs from address of a company. counterpart_business_type: type: string maxLength: 50 description: Different types of companies for different countries, ex. GmbH, SAS, SNC, etc. counterpart_contact: allOf: - $ref: '#/components/schemas/ReceivableCounterpartContact_3' description: Additional information about counterpart contacts. counterpart_external_reference: type: string description: The external reference of the counterpart. counterpart_id: type: string format: uuid description: Unique ID of the counterpart. counterpart_name: type: string description: A legal name of a counterpart it is an organization or first and last name if it is an individual counterpart_shipping_address: allOf: - $ref: '#/components/schemas/ReceivablesRepresentationOfCounterpartAddress' description: Address where goods were shipped / where services were provided. counterpart_tax_id: type: string description: The VAT/TAX ID of the counterpart. counterpart_type: allOf: - $ref: '#/components/schemas/CounterpartType' description: The type of the counterpart. counterpart_vat_id: $ref: '#/components/schemas/ReceivableCounterpartVatIDResponse' currency: allOf: - $ref: '#/components/schemas/CurrencyEnum' description: The currency used in the receivable. deduction_amount: type: integer maximum: 9007199254740991.0 minimum: 0.0 description: The amount of tax deducted in minor units deprecated: true deduction_memo: type: string description: A note with additional information about a tax deduction deprecated: true deductions: items: $ref: '#/components/schemas/DeductionItem' type: array maxItems: 10 description: List of deductions applied to the receivable (maximum 10 deductions allowed) discount: allOf: - $ref: '#/components/schemas/DiscountResponse' description: The discount for a receivable. discounted_subtotal: type: integer maximum: 9007199254740991.0 description: Total price of the receivable with discounts before taxes [minor units](https://docs.monite.com/references/currencies#minor-units). document_id: type: string description: The sequential code systematically assigned to invoices. document_rendering: allOf: - $ref: '#/components/schemas/DocumentRenderingSettings' description: Settings for rendering documents in PDF format, including settings for line items and specific document types. due_date: type: string format: date description: Optional field representing date until which invoice should be paid einvoice_file_url: type: string description: E-invoice XML file that was sent to the counterpart via an e-invoicing network. Available only if `is_einvoice` is `true`. entity: anyOf: - $ref: '#/components/schemas/ReceivableEntityOrganization' - $ref: '#/components/schemas/ReceivableEntityIndividual' entity_address: $ref: '#/components/schemas/ReceivableEntityAddressSchema' entity_bank_account: $ref: '#/components/schemas/ReceivablesRepresentationOfEntityBankAccount_3' entity_user_id: type: string format: uuid description: The entity user who created this document. entity_vat_id: $ref: '#/components/schemas/ReceivableEntityVatIDResponse' expiry_date: type: string format: date description: The date (in ISO 8601 format) until which the quote is valid. file_language: allOf: - $ref: '#/components/schemas/LanguageCodeEnum' description: The language of the customer-facing PDF file (`file_url`). The value matches the counterpart's `language` at the time when this PDF file was generated. file_url: type: string description: The receivable's PDF URL in the counterpart's default language. footer: type: string description: Optional text displayed below the line items table in the PDF. issue_date: type: string format: date-time description: Optional field for the issue of the entry. line_items: items: $ref: '#/components/schemas/ResponseItem' type: array memo: type: string description: A note with additional information for a receivable. original_file_language: allOf: - $ref: '#/components/schemas/LanguageCodeEnum' description: The language of the entity's copy of the PDF file (`original_file_url`). The value matches the entity's `language` at the time when this PDF file was generated. original_file_url: type: string description: The receivable's PDF URL in the entity's default language. partner_metadata: type: object description: Metadata for partner needs project_id: type: string format: uuid description: A project related to current receivable quote_accept_page_url: type: string maxLength: 65536 minLength: 1 format: uri description: Link for custom quote accept page signature_required: type: boolean description: Whether acceptance a quote requires a signature. status: allOf: - $ref: '#/components/schemas/QuoteStateEnum' description: The status of the Quote inside the receivable workflow. subtotal: type: integer maximum: 9007199254740991.0 description: The subtotal (excluding VAT), in [minor units](https://docs.monite.com/references/currencies#minor-units). subtotal_after_vat: type: integer maximum: 9007199254740991.0 description: The subtotal including VAT but without invoice discount, in [minor units](https://docs.monite.com/references/currencies#minor-units). tags: items: $ref: '#/components/schemas/TagReadSchema' type: array description: The list of tags for this receivable. default: [] total_amount: type: integer maximum: 9007199254740991.0 description: Total price of the receivable in [minor units](https://docs.monite.com/references/currencies#minor-units). Calculated as a subtotal + total_vat_amount. default: 0 total_deduction_amount: type: integer maximum: 9007199254740991.0 description: The total deduction amount of all deductions, in [minor units](https://docs.monite.com/references/currencies#minor-units). total_vat_amount: type: integer maximum: 9007199254740991.0 description: The total VAT of all line items, in [minor units](https://docs.monite.com/references/currencies#minor-units). total_vat_amounts: items: $ref: '#/components/schemas/TotalVatAmountItem' type: array description: List of total vat amount for each VAT, presented in receivable total_withholding_tax: type: integer description: Total price of the receivable with tax withheld in minor units trade_name: type: string maxLength: 255 description: Trade name of the entity type: type: string enum: - quote description: The type of the document uploaded. vat_exempt: type: boolean description: Indicates whether the goods, materials, or services listed in the receivable are exempt from VAT or not. vat_exemption_rationale: type: string description: The reason for the VAT exemption, if applicable. vat_inclusive_discount_mode: allOf: - $ref: '#/components/schemas/VatModeEnum' description: Indicates whether the discount is applied to the VAT-inclusive or VAT-exclusive amount. default: exclusive vat_mode: allOf: - $ref: '#/components/schemas/VatModeEnum' description: Defines whether the prices of products in receivable will already include VAT or not. default: exclusive withholding_tax_rate: type: integer maximum: 10000.0 minimum: 0.0 description: The amount of tax withheld in percent minor units type: object required: - id - created_at - updated_at - counterpart_id - counterpart_type - currency - entity - entity_address - file_language - line_items - original_file_language - status - total_vat_amount - type LineItem_3: properties: accounting_tax_rate_id: type: string format: uuid description: ID of the tax rate in the connected accounting system, to be used when pushing the invoice to that accounting system. Use `GET /accounting_tax_rates` to get these IDs. If omitted, Monite will attempt to match the tax rates based on their numeric value. custom_vat_rate_id: type: string format: uuid description: Unique identifier of the user-defined vat rate object. discount: allOf: - $ref: '#/components/schemas/Discount' description: The discount for a product. product: allOf: - $ref: '#/components/schemas/LineItemProductCreate' description: Object of product. Can be used instead of product_id, created in product's catalog product_id: type: string format: uuid description: Unique identifier of the product. quantity: type: number maximum: 2147483647.0 minimum: 0.0 description: The quantity of each of the goods, materials, or services listed in the receivable. tax_rate_name: type: string maxLength: 64 minLength: 1 description: Specifies the display name of the tax rate. This field is applicable only when tax_rate_value is also provided. tax_rate_value: type: integer maximum: 10000.0 minimum: 0.0 description: 'Percent minor units. Example: 12.5% is 1250. This field is only required on invoices issued by entities in the US, Pakistan, and other unsupported countries.' tax_status: allOf: - $ref: '#/components/schemas/TaxStatusEnum' description: 'Tax applicability status of the line item. Possible values: * `taxable` (default) - Standard tax behavior. Requires the tax rate to be specified. * `exempt` - Line item is exempt from taxes. Exempt items are not included in total tax calculations. * `non_taxable` - Line item is outside the tax scope entirely, cannot have tax rates.' default: taxable vat_rate_id: type: string format: uuid description: Unique identifier of the vat rate object. This field is required for all entities in supported countries except the US and Pakistan. additionalProperties: false type: object required: - quantity ReceivableCounterpartContact_3: properties: address: allOf: - $ref: '#/components/schemas/ReceivablesRepresentationOfCounterpartAddress' description: The contact address of the counterpart email: type: string format: email description: The contact email of the counterpart. example: marge@example.org first_name: type: string description: The first name of the counterpart contact. example: Marge last_name: type: string description: The last name of the counterpart contact. example: Smith phone: type: string description: The contact phone number of the counterpart. example: '55512378654' title: type: string description: The counterpart contact title (e.g. Dr., Mr., Mrs., Ms., etc). example: Dr. additionalProperties: false type: object required: - address - first_name - last_name UpdateQuote_3: properties: attachments: items: $ref: '#/components/schemas/AttachmentRequest' type: array minItems: 1 description: List of attachments to include with the receivable. Each attachment can be configured for email inclusion. If not provided, no attachments will be associated. contact_id: type: string format: uuid description: Unique ID of the counterpart contact. counterpart_billing_address_id: type: string format: uuid description: Address of invoicing, need to state as a separate fields for some countries if it differs from address of a company. counterpart_id: type: string format: uuid description: Unique ID of the counterpart. counterpart_shipping_address_id: type: string format: uuid description: Address where goods were shipped / where services were provided. counterpart_vat_id_id: type: string format: uuid description: Counterpart VAT ID id currency: $ref: '#/components/schemas/CurrencyEnum' deduction_amount: type: integer maximum: 9007199254740991.0 minimum: 0.0 description: The amount of tax deducted in minor units deprecated: true deduction_memo: type: string description: A note with additional information about a tax deduction deprecated: true deductions: items: $ref: '#/components/schemas/DeductionItem' type: array maxItems: 10 description: List of deductions applied to the receivable (maximum 10 deductions allowed) discount: allOf: - $ref: '#/components/schemas/Discount' description: The discount for a receivable. document_id: type: string maxLength: 100 minLength: 1 description: The document number of the receivable, which will appear in the PDF document. Can be set manually only in the [non-compliant mode](https://docs.monite.com/accounts-receivable/regulatory-compliance/invoice-compliance). Otherwise (or if omitted), it will be generated automatically based on the entity's [document number customization](https://docs.monite.com/advanced/document-number-customization) settings when the document is issued. examples: - INV-0001 - 2024-027 - CUST/2024/00027 document_rendering: allOf: - $ref: '#/components/schemas/DocumentRenderingSettings' description: Settings for rendering documents in PDF format, including settings for line items and specific document types. due_date: type: string format: date description: The date by which the invoice must be paid. entity: $ref: '#/components/schemas/ReceivableEntityBase' entity_bank_account_id: type: string format: uuid description: Entity bank account ID entity_vat_id_id: type: string format: uuid description: Entity VAT ID id expiry_date: type: string format: date description: The date (in ISO 8601 format) until which the quote is valid. footer: type: string description: Optional text displayed below the line items table in the PDF. line_items: items: $ref: '#/components/schemas/LineItemUpdate_3' type: array memo: type: string description: A note with additional information for a receivable partner_metadata: type: object description: Metadata for partner needs payment_terms: $ref: '#/components/schemas/InlinePaymentTermsRequestPayload' payment_terms_id: type: string format: uuid description: Unique ID of the payment terms. project_id: type: string format: uuid description: A project related to current receivable quote_accept_page_url: type: string maxLength: 65536 minLength: 1 format: uri description: Link for custom quote accept page signature_required: type: boolean description: Whether acceptance a quote requires a signature. tag_ids: items: type: string format: uuid type: array description: A list of IDs of user-defined tags (labels) assigned to this receivable. trade_name: type: string maxLength: 255 description: Trade name of the entity vat_exempt: type: boolean description: Indicates whether the goods, materials, or services listed in the receivable are exempt from VAT or not. vat_exemption_rationale: type: string description: The reason for the VAT exemption, if applicable. withholding_tax_rate: type: integer maximum: 10000.0 minimum: 0.0 description: The amount of tax withheld in percent minor units additionalProperties: false type: object UpdateCreditNote_3: properties: attachments: items: $ref: '#/components/schemas/AttachmentRequest' type: array minItems: 1 description: List of attachments to include with the receivable. Each attachment can be configured for email inclusion. If not provided, no attachments will be associated. counterpart_billing_address_id: type: string format: uuid description: Address of invoicing, need to state as a separate fields for some countries if it differs from address of a company. counterpart_contact: allOf: - $ref: '#/components/schemas/ReceivableCounterpartContact_3' description: Additional information about counterpart contacts. counterpart_shipping_address_id: type: string format: uuid description: Address where goods were shipped / where services were provided. document_rendering: allOf: - $ref: '#/components/schemas/DocumentRenderingSettings' description: Settings for rendering documents in PDF format, including settings for line items and specific document types. entity: $ref: '#/components/schemas/ReceivableEntityBase' footer: type: string description: Optional text displayed below the line items table in the PDF. line_items: $ref: '#/components/schemas/UpdateLineItemForCreditNote' memo: type: string description: A note with additional information for a receivable partner_metadata: type: object description: Metadata for partner needs project_id: type: string format: uuid description: A project related to current receivable tag_ids: items: type: string format: uuid type: array description: A list of IDs of user-defined tags (labels) assigned to this receivable. additionalProperties: false type: object CreditNoteResponsePayload_3: properties: id: type: string format: uuid created_at: type: string format: date-time description: Time at which the receivable was created. Timestamps follow the ISO 8601 standard. updated_at: type: string format: date-time description: Time at which the receivable was last updated. Timestamps follow the ISO 8601 standard. attachments: items: $ref: '#/components/schemas/AttachmentResponse' type: array description: List of attachments to include with the receivable. Each attachment can be configured for email inclusion. If not provided, no attachments will be associated. based_on: type: string format: uuid description: The unique ID of a previous document related to the receivable if applicable. based_on_document_id: type: string description: The unique document ID of a previous document related to the receivable if applicable. commercial_condition_description: type: string description: The commercial terms of the receivable (e.g. The products must be delivered in X days). counterpart_billing_address: allOf: - $ref: '#/components/schemas/ReceivablesRepresentationOfCounterpartAddress' description: Address of invoicing, need to state as a separate fields for some countries if it differs from address of a company. counterpart_business_type: type: string maxLength: 50 description: Different types of companies for different countries, ex. GmbH, SAS, SNC, etc. counterpart_contact: allOf: - $ref: '#/components/schemas/ReceivableCounterpartContact_3' description: Additional information about counterpart contacts. counterpart_einvoicing_credentials: allOf: - $ref: '#/components/schemas/EinvoicingCredentials' description: E-invoicing credentials of the counterpart counterpart_external_reference: type: string description: The external reference of the counterpart. counterpart_id: type: string format: uuid description: Unique ID of the counterpart. counterpart_name: type: string description: A legal name of a counterpart it is an organization or first and last name if it is an individual counterpart_shipping_address: allOf: - $ref: '#/components/schemas/ReceivablesRepresentationOfCounterpartAddress' description: Address where goods were shipped / where services were provided. counterpart_tax_id: type: string description: The VAT/TAX ID of the counterpart. counterpart_type: allOf: - $ref: '#/components/schemas/CounterpartType' description: The type of the counterpart. counterpart_vat_id: $ref: '#/components/schemas/ReceivableCounterpartVatIDResponse' currency: allOf: - $ref: '#/components/schemas/CurrencyEnum' description: The currency used in the receivable. deduction_amount: type: integer maximum: 9007199254740991.0 minimum: 0.0 description: The amount of tax deducted in minor units deprecated: true deduction_memo: type: string description: A note with additional information about a tax deduction deprecated: true deductions: items: $ref: '#/components/schemas/DeductionItem' type: array maxItems: 10 description: List of deductions applied to the receivable (maximum 10 deductions allowed) discount: allOf: - $ref: '#/components/schemas/DiscountResponse' description: The discount for a receivable. discounted_subtotal: type: integer maximum: 9007199254740991.0 description: Total price of the receivable with discounts before taxes [minor units](https://docs.monite.com/references/currencies#minor-units). document_id: type: string description: The sequential code systematically assigned to invoices. document_rendering: allOf: - $ref: '#/components/schemas/DocumentRenderingSettings' description: Settings for rendering documents in PDF format, including settings for line items and specific document types. due_date: type: string format: date description: Optional field representing date until which invoice should be paid einvoice_error_comment: type: string description: Error that was returned by E-invoicing einvoice_file_url: type: string description: E-invoice XML file that was sent to the counterpart via an e-invoicing network. Available only if `is_einvoice` is `true`. entity: anyOf: - $ref: '#/components/schemas/ReceivableEntityOrganization' - $ref: '#/components/schemas/ReceivableEntityIndividual' entity_address: $ref: '#/components/schemas/ReceivableEntityAddressSchema' entity_bank_account: $ref: '#/components/schemas/ReceivablesRepresentationOfEntityBankAccount_3' entity_user_id: type: string format: uuid description: The entity user who created this document. entity_vat_id: $ref: '#/components/schemas/ReceivableEntityVatIDResponse' file_language: allOf: - $ref: '#/components/schemas/LanguageCodeEnum' description: The language of the customer-facing PDF file (`file_url`). The value matches the counterpart's `language` at the time when this PDF file was generated. file_url: type: string description: The receivable's PDF URL in the counterpart's default language. footer: type: string description: Optional text displayed below the line items table in the PDF. is_einvoice: type: boolean description: If `true`, the credit note will be sent through an e-invoicing network. The value is inherited from the invoice for which the credit note was created, and cannot be changed. default: false issue_date: type: string format: date-time description: Optional field for the issue of the entry. line_items: items: $ref: '#/components/schemas/ResponseItem' type: array memo: type: string description: A note with additional information for a receivable. network_credentials: allOf: - $ref: '#/components/schemas/EinvoicingCredentials' description: E-invoicing credentials of the entity original_file_language: allOf: - $ref: '#/components/schemas/LanguageCodeEnum' description: The language of the entity's copy of the PDF file (`original_file_url`). The value matches the entity's `language` at the time when this PDF file was generated. original_file_url: type: string description: The receivable's PDF URL in the entity's default language. partner_metadata: type: object description: Metadata for partner needs project_id: type: string format: uuid description: A project related to current receivable purchase_order: type: string maxLength: 100 description: Contain purchase order number. status: allOf: - $ref: '#/components/schemas/CreditNoteStateEnum' description: The status of the Credit Note inside the receivable workflow. subtotal: type: integer maximum: 9007199254740991.0 description: The subtotal (excluding VAT), in [minor units](https://docs.monite.com/references/currencies#minor-units). subtotal_after_vat: type: integer maximum: 9007199254740991.0 description: The subtotal including VAT but without invoice discount, in [minor units](https://docs.monite.com/references/currencies#minor-units). tags: items: $ref: '#/components/schemas/TagReadSchema' type: array description: The list of tags for this receivable. default: [] total_amount: type: integer maximum: 9007199254740991.0 description: Total price of the receivable in [minor units](https://docs.monite.com/references/currencies#minor-units). Calculated as a subtotal + total_vat_amount. default: 0 total_deduction_amount: type: integer maximum: 9007199254740991.0 description: The total deduction amount of all deductions, in [minor units](https://docs.monite.com/references/currencies#minor-units). total_vat_amount: type: integer maximum: 9007199254740991.0 description: The total VAT of all line items, in [minor units](https://docs.monite.com/references/currencies#minor-units). total_vat_amounts: items: $ref: '#/components/schemas/TotalVatAmountItem' type: array description: List of total vat amount for each VAT, presented in receivable total_withholding_tax: type: integer description: Total price of the receivable with tax withheld in minor units trade_name: type: string maxLength: 255 description: Trade name of the entity type: type: string enum: - credit_note description: The type of the receivable vat_exempt: type: boolean description: Indicates whether the goods, materials, or services listed in the receivable are exempt from VAT or not. vat_exemption_rationale: type: string description: The reason for the VAT exemption, if applicable. vat_inclusive_discount_mode: allOf: - $ref: '#/components/schemas/VatModeEnum' description: Indicates whether the discount is applied to the VAT-inclusive or VAT-exclusive amount. default: exclusive vat_mode: allOf: - $ref: '#/components/schemas/VatModeEnum' description: Defines whether the prices of products in receivable will already include VAT or not. default: exclusive withholding_tax_rate: type: integer maximum: 10000.0 minimum: 0.0 description: The amount of tax withheld in percent minor units type: object required: - id - created_at - updated_at - counterpart_id - counterpart_type - currency - entity - entity_address - file_language - line_items - original_file_language - status - total_vat_amount - type LineItemProduct_3: properties: id: type: string format: uuid description: Unique ID of the product. accounting_tax_rate_id: type: string format: uuid description: Unique identifier of the accounting tax rate object. description: type: string description: Description of the product. external_reference: type: string maxLength: 255 minLength: 1 description: A user-defined identifier of the product. For example, an internal product code or SKU (stock keeping unit). Client applications can use this field to map the products in Monite to an external product catalog. examples: - HT-1234-S-BL - SERVICE-67890 is_inline: type: boolean description: Indicates whether the product is inline default: false ledger_account_id: type: string format: uuid measure_unit: $ref: '#/components/schemas/LineItemProductMeasureUnit_3' name: type: string description: Name of the product. price: $ref: '#/components/schemas/Price' price_after_vat: $ref: '#/components/schemas/Price' smallest_amount: type: number maximum: 2147483647.0 minimum: 0.0 description: The smallest amount allowed for this product. type: allOf: - $ref: '#/components/schemas/ProductServiceTypeEnum' description: Specifies whether this offering is a product or service. This may affect the applicable tax rates. default: product vat_rate: $ref: '#/components/schemas/LineItemProductVatRate' type: object required: - id - name - price - price_after_vat - vat_rate ReceivableSendRequest_3: properties: body_text: type: string minLength: 1 description: Body text of the content recipients: $ref: '#/components/schemas/Recipients' subject_text: type: string minLength: 1 description: Subject text of the content additionalProperties: false type: object required: - body_text - subject_text description: A schema for receiving a request for sending a receivable securitySchemes: HTTPBearer: type: http scheme: bearer x-refined-from: - monite-openapi-2023-09-01.json - monite-openapi-2024-05-25.json - monite-openapi.yml