openapi: 3.2.0
info:
  title: Monite Receipts 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 Receipts 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: Receipts
paths:
  /receipts:
    get:
      tags:
      - Receipts
      summary: Get receipts
      operationId: get_receipts
      parameters:
      - required: true
        schema:
          type: string
          format: date
        example: '2023-09-01'
        name: x-monite-version
        in: header
      - description: Sort order (ascending by default). Typically used together with the `sort` parameter.
        required: false
        schema:
          allOf:
          - $ref: '#/components/schemas/OrderEnum'
          default: asc
        name: order
        in: query
      - description: The number of items (0 .. 100) to return in a single page of the response. The response may contain fewer items if it is the last or only page.
        required: false
        schema:
          type: integer
          maximum: 100.0
          minimum: 1.0
          default: 100
        name: limit
        in: query
      - description: 'A pagination token obtained from a previous call to this endpoint. Use it to get the next or previous page of results for your initial query. If `pagination_token` is specified, all other query parameters are ignored and inferred from the initial query.


          If not specified, the first page of results will be returned.'
        required: false
        schema:
          type: string
        name: pagination_token
        in: query
      - description: The field to sort the results by. Typically used together with the `order` parameter.
        required: false
        schema:
          allOf:
          - $ref: '#/components/schemas/ReceiptCursorFields'
        name: sort
        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:
          items:
            type: string
            format: uuid
          type: array
        name: id__in
        in: query
      - required: false
        schema:
          $ref: '#/components/schemas/CurrencyEnum'
        name: currency
        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: integer
          minimum: 0.0
        name: total_amount__gt
        in: query
      - required: false
        schema:
          type: integer
          minimum: 0.0
        name: total_amount__lt
        in: query
      - required: false
        schema:
          type: integer
          minimum: 0.0
        name: total_amount__gte
        in: query
      - required: false
        schema:
          type: integer
          minimum: 0.0
        name: total_amount__lte
        in: query
      - required: false
        schema:
          type: boolean
        name: has_file
        in: query
      - required: false
        schema:
          type: boolean
        name: has_transaction
        in: query
      - required: false
        schema:
          type: string
          format: uuid
        name: transaction_id
        in: query
      - required: false
        schema:
          items:
            type: string
            format: uuid
          type: array
        name: transaction_id__in
        in: query
      - required: false
        schema:
          type: string
        name: merchant_name__icontains
        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/ReceiptPaginationResponse'
        '405':
          description: Method Not Allowed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchemaResponse2'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchemaResponse2'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchemaResponse2'
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchemaResponse2'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchemaResponse2'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
      - HTTPBearer: []
    post:
      tags:
      - Receipts
      summary: Create a receipt
      operationId: post_receipts
      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/ReceiptCreateSchema'
        required: true
      responses:
        '201':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReceiptResponseSchema'
        '405':
          description: Method Not Allowed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchemaResponse2'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchemaResponse2'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchemaResponse2'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchemaResponse2'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchemaResponse2'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
      - HTTPBearer: []
    servers:
    - url: https://api.dev.monite.com/v1
      description: Development environment
    - url: https://api.sandbox.monite.com/v1
      description: Sandbox environment
    - url: https://api.monite.com/v1
      description: Production environment (Europe)
    - url: https://us.api.monite.com/v1
      description: Production environment (North America)
    - url: https://api.monite.oaknorth.co.uk/v1
      description: Oak POC environment
  /receipts/upload_from_file:
    post:
      tags:
      - Receipts
      summary: Upload a receipt from a file
      description: Upload an incoming receipt in the PDF, PNG, or JPEG format and scan its contents. The maximum file size is 20 MB.
      operationId: post_receipts_upload_from_file
      parameters:
      - required: true
        schema:
          type: string
          format: date
        example: '2023-09-01'
        name: x-monite-version
        in: header
      - description: The ID of the entity that owns the requested resource.
        required: true
        schema:
          type: string
          format: uuid
          examples:
          - 9d2b4c8f-2087-4738-ba91-7359683c49a4
        name: x-monite-entity-id
        in: header
      requestBody:
        content:
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/ReceiptUploadFile'
        required: true
      responses:
        '201':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReceiptResponseSchema'
        '405':
          description: Method Not Allowed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchemaResponse2'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchemaResponse2'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchemaResponse2'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchemaResponse2'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchemaResponse2'
        '409':
          description: Error uploading the file.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchemaResponse2'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
      - HTTPBearer: []
    servers:
    - url: https://api.dev.monite.com/v1
      description: Development environment
    - url: https://api.sandbox.monite.com/v1
      description: Sandbox environment
    - url: https://api.monite.com/v1
      description: Production environment (Europe)
    - url: https://us.api.monite.com/v1
      description: Production environment (North America)
    - url: https://api.monite.oaknorth.co.uk/v1
      description: Oak POC environment
  /receipts/{receipt_id}:
    get:
      tags:
      - Receipts
      summary: Get a receipt by ID
      operationId: get_receipts_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: receipt_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/ReceiptResponseSchema'
        '405':
          description: Method Not Allowed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchemaResponse2'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchemaResponse2'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchemaResponse2'
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchemaResponse2'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchemaResponse2'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
      - HTTPBearer: []
    patch:
      tags:
      - Receipts
      summary: Update a receipt
      operationId: patch_receipts_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: receipt_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/ReceiptUpdateSchema'
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReceiptResponseSchema'
        '405':
          description: Method Not Allowed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchemaResponse2'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchemaResponse2'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchemaResponse2'
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchemaResponse2'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchemaResponse2'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
      - HTTPBearer: []
    delete:
      tags:
      - Receipts
      summary: Delete a receipt
      operationId: delete_receipts_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: receipt_id
        in: path
      - description: The ID of the entity that owns the requested resource.
        required: true
        schema:
          type: string
          format: uuid
          examples:
          - 9d2b4c8f-2087-4738-ba91-7359683c49a4
        name: x-monite-entity-id
        in: header
      responses:
        '204':
          description: Successful Response
        '405':
          description: Method Not Allowed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchemaResponse2'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchemaResponse2'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchemaResponse2'
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchemaResponse2'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchemaResponse2'
        '409':
          description: Business logic error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchemaResponse2'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
      - HTTPBearer: []
    servers:
    - url: https://api.dev.monite.com/v1
      description: Development environment
    - url: https://api.sandbox.monite.com/v1
      description: Sandbox environment
    - url: https://api.monite.com/v1
      description: Production environment (Europe)
    - url: https://us.api.monite.com/v1
      description: Production environment (North America)
    - url: https://api.monite.oaknorth.co.uk/v1
      description: Oak POC environment
  /receipts/{receipt_id}/attach_file:
    post:
      tags:
      - Receipts
      summary: Attach a file to a receipt
      description: Attach a file to a receipt without an existing attachment.
      operationId: post_receipts_id_attach_file
      parameters:
      - required: true
        schema:
          type: string
          format: date
        example: '2023-09-01'
        name: x-monite-version
        in: header
      - required: true
        schema:
          type: string
          format: uuid
        name: receipt_id
        in: path
      - description: The ID of the entity that owns the requested resource.
        required: true
        schema:
          type: string
          format: uuid
          examples:
          - 9d2b4c8f-2087-4738-ba91-7359683c49a4
        name: x-monite-entity-id
        in: header
      requestBody:
        content:
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/ReceiptAttachFile'
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReceiptResponseSchema'
        '405':
          description: Method Not Allowed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchemaResponse2'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchemaResponse2'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchemaResponse2'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchemaResponse2'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchemaResponse2'
        '409':
          description: Conflict
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchemaResponse2'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
      - HTTPBearer: []
    servers:
    - url: https://api.dev.monite.com/v1
      description: Development environment
    - url: https://api.sandbox.monite.com/v1
      description: Sandbox environment
    - url: https://api.monite.com/v1
      description: Production environment (Europe)
    - url: https://us.api.monite.com/v1
      description: Production environment (North America)
    - url: https://api.monite.oaknorth.co.uk/v1
      description: Oak POC environment
  /receipts/{receipt_id}/line_items:
    get:
      tags:
      - Receipts
      summary: Get all line items of a receipt
      operationId: get_receipts_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: receipt_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/ReceiptLineItemCursorFields'
        name: sort
        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
        name: name
        in: query
      - required: false
        schema:
          type: string
        name: name__iexact
        in: query
      - required: false
        schema:
          type: string
        name: name__contains
        in: query
      - required: false
        schema:
          type: string
        name: name__icontains
        in: query
      - required: false
        schema:
          type: integer
          minimum: 0.0
        name: total__gt
        in: query
      - required: false
        schema:
          type: integer
          minimum: 0.0
        name: total__lt
        in: query
      - required: false
        schema:
          type: integer
          minimum: 0.0
        name: total__gte
        in: query
      - required: false
        schema:
          type: integer
          minimum: 0.0
        name: total__lte
        in: query
      - required: false
        schema:
          type: string
          format: uuid
        name: created_by_user_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/ReceiptLineItemsPaginationResponse'
        '405':
          description: Method Not Allowed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchemaResponse2'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchemaResponse2'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchemaResponse2'
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchemaResponse2'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchemaResponse2'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
      - HTTPBearer: []
    post:
      tags:
      - Receipts
      summary: Add a new line item to a receipt
      operationId: post_receipts_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: receipt_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/ReceiptLineItemCreateSchema'
        required: true
      responses:
        '201':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReceiptLineItemResponseSchema'
        '405':
          description: Method Not Allowed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchemaResponse2'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchemaResponse2'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchemaResponse2'
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchemaResponse2'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchemaResponse2'
        '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
  /receipts/{receipt_id}/line_items/{line_item_id}:
    patch:
      tags:
      - Receipts
      summary: Update a line item of a receipt
      operationId: patch_receipts_id_line_items_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: receipt_id
        in: path
      - required: true
        schema:
          type: string
          format: uuid
        name: line_item_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/ReceiptLineItemUpdateSchema'
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReceiptLineItemResponseSchema'
        '405':
          description: Method Not Allowed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchemaResponse2'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchemaResponse2'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchemaResponse2'
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchemaResponse2'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchemaResponse2'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
      - HTTPBearer: []
    delete:
      tags:
      - Receipts
      summary: Delete a line item from a receipt
      operationId: delete_receipts_id_line_items_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: receipt_id
        in: path
      - required: true
        schema:
          type: string
          format: uuid
        name: line_item_id
        in: path
      - description: The ID of the entity that owns the requested resource.
        required: true
        schema:
          type: string
          format: uuid
          examples:
          - 9d2b4c8f-2087-4738-ba91-7359683c49a4
        name: x-monite-entity-id
        in: header
      responses:
        '204':
          description: Successful Response
        '405':
          description: Method Not Allowed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchemaResponse2'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchemaResponse2'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchemaResponse2'
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchemaResponse2'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchemaResponse2'
        '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:
    ReceiptLineItemUpdateSchema:
      properties:
        accounting_tax_rate_id:
          type: string
          format: uuid
          description: Accounting tax rate ID.
        cost_center_id:
          type: string
          format: uuid
          description: Cost center ID.
        ledger_account_id:
          type: string
          format: uuid
          description: Ledger account ID.
        name:
          type: string
          description: Line item name/description.
        total:
          type: integer
          description: Line item total in minor units.
      additionalProperties: false
      type: object
    ReceiptResponseSchema:
      properties:
        id:
          type: string
          format: uuid
          description: Unique receipt ID.
        created_at:
          type: string
          format: date-time
          description: Creation timestamp.
        updated_at:
          type: string
          format: date-time
          description: Update timestamp.
        created_by_entity_user_id:
          type: string
          format: uuid
          description: Entity user who created.
        currency:
          allOf:
          - $ref: '#/components/schemas/CurrencyEnum'
          description: Currency code.
        currency_exchange:
          type: object
          description: Currency exchange details.
        description:
          type: string
          maxLength: 1024
          description: Short transaction description.
          example: Payment for lunch with clients
        document_id:
          type: string
          maxLength: 255
          description: Receipt number.
        file_id:
          type: string
          format: uuid
          description: The id of the receipt file stored in the file saver.
          example: 123e4567-e89b-12d3-a456-426614174000
        file_url:
          type: string
          description: The URL of the receipt file stored in the file saver.
        issued_at:
          type: string
          format: date-time
          description: Date when the receipt was issued.
        merchant_location:
          type: string
          maxLength: 255
          description: Merchant location.
        merchant_name:
          type: string
          maxLength: 128
          description: Merchant name.
        ocr_request_id:
          type: string
          format: uuid
          description: OCR request id.
        ocr_status:
          type: string
          description: OCR status.
        origin:
          allOf:
          - $ref: '#/components/schemas/ReceiptOriginEnum'
          description: Specifies how this receipt was created in Monite.
        partner_metadata:
          type: object
          description: Partner metadata.
        sender:
          type: string
          format: email
          description: The email address from which the invoice was sent to the entity.
          example: hello@example.com
        source_of_data:
          allOf:
          - $ref: '#/components/schemas/SourceOfReceiptDataEnum'
          description: Source of data.
        total_amount:
          type: integer
          description: Total amount in minor units.
        transaction_id:
          type: string
          format: uuid
          description: Transaction ID.
      type: object
      required:
      - id
      - created_at
      - updated_at
      - origin
    SourceOfReceiptDataEnum:
      type: string
      enum:
      - ocr
      - user_specified
    ReceiptOriginEnum:
      type: string
      enum:
      - upload
      - email
    ReceiptUpdateSchema:
      properties:
        base64_encoded_file:
          type: string
          description: Base64-encoded file contents.
        currency:
          allOf:
          - $ref: '#/components/schemas/CurrencyEnum'
          description: Currency code.
        description:
          type: string
          maxLength: 1024
          description: Short transaction description.
          example: Payment for lunch with clients
        document_id:
          type: string
          maxLength: 255
          description: Receipt number.
        issued_at:
          type: string
          format: date-time
          description: Date when the receipt was issued.
        merchant_location:
          type: string
          maxLength: 255
          description: Merchant location.
        merchant_name:
          type: string
          maxLength: 128
          description: Merchant name.
        partner_metadata:
          type: object
          description: Metadata for partner needs
        total_amount:
          type: integer
          minimum: 0.0
          description: Total amount.
        transaction_id:
          type: string
          format: uuid
          description: Transaction ID.
      additionalProperties: false
      type: object
    ReceiptPaginationResponse:
      properties:
        data:
          items:
            $ref: '#/components/schemas/ReceiptResponseSchema'
          type: array
        next_pagination_token:
          type: string
          description: Next page token.
        prev_pagination_token:
          type: string
          description: Previous page token.
      additionalProperties: false
      type: object
      required:
      - data
    ErrorSchemaResponse2:
      properties:
        error:
          $ref: '#/components/schemas/ErrorSchema2'
      type: object
      required:
      - error
    ReceiptCursorFields:
      type: string
      enum:
      - id
      - created_at
    ReceiptLineItemCreateSchema:
      properties:
        accounting_tax_rate_id:
          type: string
          format: uuid
          description: Accounting tax rate ID.
        cost_center_id:
          type: string
          format: uuid
          description: Cost center ID.
        ledger_account_id:
          type: string
          format: uuid
          description: Ledger account ID.
        name:
          type: string
          description: Line item name/description.
        total:
          type: integer
          description: Line item total in minor units.
      additionalProperties: false
      type: object
    ReceiptLineItemCursorFields:
      type: string
      enum:
      - created_at
      - updated_at
    ReceiptLineItemsPaginationResponse:
      properties:
        data:
          items:
            $ref: '#/components/schemas/ReceiptLineItemResponseSchema'
          type: array
        next_pagination_token:
          type: string
          description: Next page token.
        prev_pagination_token:
          type: string
          description: Previous page token.
      additionalProperties: false
      type: object
      required:
      - data
    OrderEnum:
      type: string
      enum:
      - asc
      - desc
    ReceiptLineItemResponseSchema:
      properties:
        id:
          type: string
          format: uuid
          description: Unique line item ID.
        created_at:
          type: string
          format: date-time
          description: Created at.
        updated_at:
          type: string
          format: date-time
          description: Updated at.
        accounting_tax_rate_id:
          type: string
          format: uuid
          description: Accounting tax rate ID.
        cost_center_id:
          type: string
          format: uuid
          description: Cost center ID.
        created_by_entity_user_id:
          type: string
          format: uuid
          description: Created by user.
        ledger_account_id:
          type: string
          format: uuid
          description: Ledger account ID.
        name:
          type: string
          description: Line item name.
        receipt_id:
          type: string
          format: uuid
          description: Receipt ID.
        total:
          type: integer
          description: Total.
      additionalProperties: false
      type: object
      required:
      - id
      - created_at
      - updated_at
      - receipt_id
    ReceiptUploadFile:
      properties:
        file:
          type: string
          format: binary
      type: object
      required:
      - file
    ReceiptCreateSchema:
      properties:
        base64_encoded_file:
          type: string
          description: Base64-encoded contents of the original receipt file.
        currency:
          allOf:
          - $ref: '#/components/schemas/CurrencyEnum'
          description: Currency code used in the receipt.
          example: EUR
        description:
          type: string
          maxLength: 1024
          description: Short transaction description.
          example: Payment for lunch with clients
        document_id:
          type: string
          maxLength: 255
          description: Unique receipt number assigned by the issuer.
          example: DE2287
        issued_at:
          type: string
          format: date-time
          description: Receipt issued date and time.
        merchant_location:
          type: string
          maxLength: 255
          description: Location of the merchant.
          example: West Street, London, UK
        merchant_name:
          type: string
          maxLength: 128
          description: Name of the merchant.
          example: Tesco
        partner_metadata:
          type: object
          description: Metadata for partner needs
        total_amount:
          type: integer
          minimum: 0.0
          description: Total amount for the receipt in minor units (e.g. cents).
          example: 15000
        transaction_id:
          type: string
          format: uuid
          description: Transaction ID.
      additionalProperties: false
      type: object
    ErrorSchema2:
      properties:
        message:
          type: string
      type: object
      required:
      - message
    ReceiptAttachFile:
      properties:
        file:
          type: string
          format: binary
      type: object
      required:
      - file
    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
    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
  securitySchemes:
    HTTPBearer:
      type: http
      scheme: bearer
x-refined-from:
- monite-openapi-2023-09-01.json
- monite-openapi-2024-05-25.json
- monite-openapi.yml