---
title: "List Purchases"
method: GET
path: "/cleemy-procurement/api/purchases"
tags: ["Purchases"]
---

# List Purchases

`GET /cleemy-procurement/api/purchases`

List purchases.

## Query parameters

- `fields.root` 'count'
- `page` integer
- `limit` integer

## Response `200`

OK

- object
  - `items` Purchase[], required
    - `id` integer
    - `type` 'Subscription' | 'OneTime' — Type of purchase.
    - `title` string — Title of the purchase.
    - `state` 'Created' | 'Processing' | 'Ongoing' | 'Denied' | 'Closed' | 'Cancelled'
    - `commitment` union
      - object — **Read-only.** Commitment of the purchase. readOnly: true
        - `id` integer — ID of the commitment.
        - `type` 'SubscriptionCommitment' — Type of the commitment.
        - `owner` object — User ID who is the owner of the commitment.
          - `id` integer
          - `href` string, uri
          - `name` string
          - `firstName` string
          - `lastName` string
          - `pictureHref` string, uri, nullable — **Read-only.** URL to this user picture image file.
        - `purchase` object — Purchase of the subscription commitment.
          - `id` integer
          - `href` string
          - `name` string
          - `type` 'Subscription' | 'OneTime' — **Read-only.** Type of the purchase.
        - `attachments` Attachment[] — Attachments of the commitment.
          - `id` integer
          - `file` File — Reference to a file.
            - `id` string, uuid
            - `href` string
            - `name` string
            - `displayHref` string
          - `createdAt` string, date-time
          - `pages` object
            - `displayHrefTemplate` string
            - `count` integer
        - `comment` string, nullable — Comment of the commitment.
        - `paymentMethod` 'BankTransfer' | 'PhysicalCard' | 'Check' | 'DirectDebit' | 'SingleUseCard' — BankTransfer: bank transfer. PhysicalCard: physical card. Check: check. DirectDebit: direct debit. SingleUseCard: single use card.
        - `state` 'Created' | 'UnderReview' | 'Provisioned' | 'Denied' | 'Cancelled' — Created: the commitment is created. UnderReview: the commitment's approval is pending'. Provisioned: the commitment is approved. Denied: the commitment is denied. Cancelled: the commitment is cancelled.
        - `startDate` string, date — Start date of the subscription.
        - `firstInvoiceDate` string, date — Date of the first invoice.
        - `invoicingFrequency` object — Invoicing frequency of the subscription.
          - `value` integer
          - `unit` 'Day' | 'Week' | 'Month' | 'Year' — Day: day. Week: week. Month: month. Year: year.
        - `subscriptionDuration` object — Duration of the subscription.
          - `value` integer
          - `unit` 'Day' | 'Week' | 'Month' | 'Year' — Day: day. Week: week. Month: month. Year: year.
        - `contractualObligation` object — Contractual obligation of the subscription.
          - `value` integer
          - `unit` 'Day' | 'Week' | 'Month' | 'Year' — Day: day. Week: week. Month: month. Year: year.
        - `terminationNotice` object — Termination notice of the subscription.
          - `value` integer
          - `unit` 'Day' | 'Week' | 'Month' | 'Year' — Day: day. Week: week. Month: month. Year: year.
        - `amountIncludingTaxesPerPeriod` object — Amount including taxes per period.
          - `base` TaxedAmount — Represents an amount of money with VAT taxes.
            - `excludingTaxes` Amount — Represents an amount of money.
              - …
            - `taxes` object[]
              - …
            - `includingTaxes` Amount — Represents an amount of money.
              - …
          - `counter` TaxedAmount — Represents an amount of money with VAT taxes.
            - `excludingTaxes` Amount — Represents an amount of money.
              - …
            - `taxes` object[]
              - …
            - `includingTaxes` Amount — Represents an amount of money.
              - …
          - `rate` number, double
        - `amountIncludingTaxes` object — Amount including taxes.
          - `base` TaxedAmount — Represents an amount of money with VAT taxes.
            - `excludingTaxes` Amount — Represents an amount of money.
              - …
            - `taxes` object[]
              - …
            - `includingTaxes` Amount — Represents an amount of money.
              - …
          - `counter` TaxedAmount — Represents an amount of money with VAT taxes.
            - `excludingTaxes` Amount — Represents an amount of money.
              - …
            - `taxes` object[]
              - …
            - `includingTaxes` Amount — Represents an amount of money.
              - …
          - `rate` number, double
        - `subscriptionEndDate` string, date — End date of the subscription.
        - `periodsCount` integer — Number of periods.
        - `contractualEndDate` string, date, nullable — End date of the contractual obligation.
        - `createdAt` string, date-time — Date of creation of the commitment. Read-only.
        - `author` object — **Read-only.** User ID who is the author of the commitment.
          - `id` integer
          - `href` string, uri
          - `name` string
          - `firstName` string
          - `lastName` string
          - `pictureHref` string, uri, nullable — **Read-only.** URL to this user picture image file.
        - `modifiedAt` string, date-time — **Read-only.** Date of last modification of the commitment.
        - `modifier` object — **Read-only.** User ID who is the modifier of the commitment.
          - `id` integer
          - `href` string, uri
          - `name` string
          - `firstName` string
          - `lastName` string
          - `pictureHref` string, uri, nullable — **Read-only.** URL to this user picture image file.
      - object — **Read-only.** Commitment of the purchase. readOnly: true
        - `id` integer
        - `type` 'OneTimeCommitment'
        - `purchase` object — Purchase of the one-time commitment.
          - `id` integer
          - `href` string
          - `name` string
          - `type` 'Subscription' | 'OneTime' — **Read-only.** Type of the purchase.
        - `owner` object — Reference to a user.
          - `id` integer
          - `href` string, uri
          - `name` string
          - `firstName` string
          - `lastName` string
          - `pictureHref` string, uri, nullable — **Read-only.** URL to this user picture image file.
        - `attachmentIds` integer[]
        - `attachments` Attachment[]
          - `id` integer
          - `file` File — Reference to a file.
            - `id` string, uuid
            - `href` string
            - `name` string
            - `displayHref` string
          - `createdAt` string, date-time
          - `pages` object
            - `displayHrefTemplate` string
            - `count` integer
        - `comment` string, nullable
        - `paymentMethod` 'BankTransfer' | 'PhysicalCard' | 'Check' | 'DirectDebit' | 'SingleUseCard' — BankTransfer: bank transfer. PhysicalCard: physical card. Check: check. DirectDebit: direct debit. SingleUseCard: single use card.
        - `state` 'Created' | 'UnderReview' | 'Provisioned' | 'Denied' | 'Cancelled' — Created: the commitment is created. UnderReview: the commitment's approval is pending'. Provisioned: the commitment is approved. Denied: the commitment is denied. Cancelled: the commitment is cancelled.
        - `amountIncludingTaxes` DualCurrencyTaxedAmount — Represents an amount of money with VAT taxes in two different currencies.
          - `base` TaxedAmount — Represents an amount of money with VAT taxes.
            - `excludingTaxes` Amount — Represents an amount of money.
              - …
            - `taxes` object[]
              - …
            - `includingTaxes` Amount — Represents an amount of money.
              - …
          - `counter` TaxedAmount — Represents an amount of money with VAT taxes.
            - `excludingTaxes` Amount — Represents an amount of money.
              - …
            - `taxes` object[]
              - …
            - `includingTaxes` Amount — Represents an amount of money.
              - …
          - `rate` number, double
        - `costDate` string, date
        - `invoiceDate` string, date
        - `createdAt` string, date-time
        - `author` object — Reference to a user.
          - `id` integer
          - `href` string, uri
          - `name` string
          - `firstName` string
          - `lastName` string
          - `pictureHref` string, uri, nullable — **Read-only.** URL to this user picture image file.
        - `modifiedAt` string, date-time
        - `modifier` object — Reference to a user.
          - `id` integer
          - `href` string, uri
          - `name` string
          - `firstName` string
          - `lastName` string
          - `pictureHref` string, uri, nullable — **Read-only.** URL to this user picture image file.
    - `ownerId` integer — ID of the user who is the owner of the purchase.
    - `owner` object — Owner of the purchase.
      - `id` integer
      - `href` string, uri
      - `name` string
      - `firstName` string
      - `lastName` string
      - `pictureHref` string, uri, nullable — **Read-only.** URL to this user picture image file.
    - `natureId` integer — ID of the nature to which the purchase belongs.
    - `nature` object — Nature of the purchase.
      - `id` integer
      - `name` string
      - `href` string
    - `costCenterId` integer — ID of the cost-center to which the purchase belongs.
    - `costCenter` object — **Read-only.** Cost-center to which the purchase belongs.
      - `id` integer
      - `name` string — **Read-only.** Name of the cost-center.
      - `code` string — **Read-only.** Code of the cost-center.
      - `href` string
    - `establishmentId` integer — ID of the establishment to which the purchase belongs.
    - `establishment` object — **Read-only.** Establishment to which the purchase belongs.
      - `id` integer
      - `name` string
      - `href` string, uri
    - `departmentId` integer — ID of the department to which the purchase belongs.
    - `department` object — **Read-only.** Department to which the purchase belongs.
      - `id` integer
      - `name` string
      - `href` string, uri
    - `supplier` union — Supplier of the purchase.
      - DraftSupplier — Draft supplier.
        - `type` 'Draft'
        - `name` string, required
        - `territoryId` string, required — ID of the territory to which the supplier belongs.
        - `territory` object — **Read-only.** Territory to which the supplier belongs.
          - `id` integer
          - `name` string
          - `href` string, uri
      - ConcreteSupplier — Non-draft supplier.
        - `id` integer, required
        - `type` 'Concrete'
        - `href` string
        - `name` string
        - `flag` 'Unflagged' | 'Flagged'
    - `availableAmount` object — **Read-only.** Available amount of the purchase.
      - `base` Amount — Represents an amount of money.
        - `value` number, double
        - `currency` 'Invalid' | 'ALL' | 'DZD' | 'ARS' | 'AUD' | 'BSD' | 'BHD' | 'BDT' | 'AMD' | 'BBD' | 'BMD' | 'BTN' | 'BOB' | 'BWP' | 'BZD' | 'SBD' | 'BND' | 'MMK' | 'BIF' | 'KHR' | 'CAD' | 'CVE' | 'KYD' | 'LKR' | 'CLP' | 'CNY' | 'COP' | 'KMF' | 'CRC' | 'HRK' | 'CUP' | 'CZK' | 'DKK' | 'DOP' | 'SVC' | 'ETB' | 'ERN' | 'FKP' | 'FJD' | 'DJF' | 'GMD' | 'GIP' | 'GTQ' | 'GNF' | 'GYD' | 'HTG' | 'HNL' | 'HKD' | 'HUF' | 'ISK' | 'INR' | 'IDR' | 'IRR' | 'IQD' | 'ILS' | 'JMD' | 'JPY' | 'KZT' | 'JOD' | 'KES' | 'KPW' | 'KRW' | 'KWD' | 'KGS' | 'LAK' | 'LBP' | 'LSL' | 'LVL' | 'LRD' | 'LYD' | 'LTL' | 'MOP' | 'MWK' | 'MYR' | 'MVR' | 'MRO' | 'MUR' | 'MXN' | 'MNT' | 'MDL' | 'MAD' | 'OMR' | 'NAD' | 'NPR' | 'ANG' | 'AWG' | 'VUV' | 'NZD' | 'NIO' | 'NGN' | 'NOK' | 'PKR' | 'PAB' | 'PGK' | 'PYG' | 'PEN' | 'PHP' | 'QAR' | 'RUB' | 'RWF' | 'SHP' | 'STD' | 'SAR' | 'SCR' | 'SLL' | 'SGD' | 'VND' | 'SOS' | 'ZAR' | 'SSP' | 'SZL' | 'SEK' | 'CHF' | 'SYP' | 'THB' | 'TOP' | 'TTD' | 'AED' | 'TND' | 'UGX' | 'MKD' | 'EGP' | 'GBP' | 'TZS' | 'USD' | 'UYU' | 'UZS' | 'WST' | 'YER' | 'ZMK' | 'TWD' | 'UYW' | 'VES' | 'MRU' | 'STN' | 'CUC' | 'ZWL' | 'BYN' | 'TMT' | 'GHS' | 'VEF' | 'SDG' | 'UYI' | 'RSD' | 'MZN' | 'AZN' | 'RON' | 'CHE' | 'CHW' | 'TRY' | 'XAF' | 'XCD' | 'XOF' | 'XPF' | 'XBA' | 'XBB' | 'XBC' | 'XBD' | 'XAU' | 'XDR' | 'XAG' | 'XPT' | 'XTS' | 'XPD' | 'XUA' | 'ZMW' | 'SRD' | 'MGA' | 'COU' | 'AFN' | 'TJS' | 'AOA' | 'BYR' | 'BGN' | 'CDF' | 'BAM' | 'EUR' | 'MXV' | 'UAH' | 'GEL' | 'BOV' | 'PLN' | 'BRL' | 'CLF' | 'XSU' | 'USN' | 'XXX' — ISO-4217 currency code.
      - `counter` Amount — Represents an amount of money.
        - `value` number, double
        - `currency` 'Invalid' | 'ALL' | 'DZD' | 'ARS' | 'AUD' | 'BSD' | 'BHD' | 'BDT' | 'AMD' | 'BBD' | 'BMD' | 'BTN' | 'BOB' | 'BWP' | 'BZD' | 'SBD' | 'BND' | 'MMK' | 'BIF' | 'KHR' | 'CAD' | 'CVE' | 'KYD' | 'LKR' | 'CLP' | 'CNY' | 'COP' | 'KMF' | 'CRC' | 'HRK' | 'CUP' | 'CZK' | 'DKK' | 'DOP' | 'SVC' | 'ETB' | 'ERN' | 'FKP' | 'FJD' | 'DJF' | 'GMD' | 'GIP' | 'GTQ' | 'GNF' | 'GYD' | 'HTG' | 'HNL' | 'HKD' | 'HUF' | 'ISK' | 'INR' | 'IDR' | 'IRR' | 'IQD' | 'ILS' | 'JMD' | 'JPY' | 'KZT' | 'JOD' | 'KES' | 'KPW' | 'KRW' | 'KWD' | 'KGS' | 'LAK' | 'LBP' | 'LSL' | 'LVL' | 'LRD' | 'LYD' | 'LTL' | 'MOP' | 'MWK' | 'MYR' | 'MVR' | 'MRO' | 'MUR' | 'MXN' | 'MNT' | 'MDL' | 'MAD' | 'OMR' | 'NAD' | 'NPR' | 'ANG' | 'AWG' | 'VUV' | 'NZD' | 'NIO' | 'NGN' | 'NOK' | 'PKR' | 'PAB' | 'PGK' | 'PYG' | 'PEN' | 'PHP' | 'QAR' | 'RUB' | 'RWF' | 'SHP' | 'STD' | 'SAR' | 'SCR' | 'SLL' | 'SGD' | 'VND' | 'SOS' | 'ZAR' | 'SSP' | 'SZL' | 'SEK' | 'CHF' | 'SYP' | 'THB' | 'TOP' | 'TTD' | 'AED' | 'TND' | 'UGX' | 'MKD' | 'EGP' | 'GBP' | 'TZS' | 'USD' | 'UYU' | 'UZS' | 'WST' | 'YER' | 'ZMK' | 'TWD' | 'UYW' | 'VES' | 'MRU' | 'STN' | 'CUC' | 'ZWL' | 'BYN' | 'TMT' | 'GHS' | 'VEF' | 'SDG' | 'UYI' | 'RSD' | 'MZN' | 'AZN' | 'RON' | 'CHE' | 'CHW' | 'TRY' | 'XAF' | 'XCD' | 'XOF' | 'XPF' | 'XBA' | 'XBB' | 'XBC' | 'XBD' | 'XAU' | 'XDR' | 'XAG' | 'XPT' | 'XTS' | 'XPD' | 'XUA' | 'ZMW' | 'SRD' | 'MGA' | 'COU' | 'AFN' | 'TJS' | 'AOA' | 'BYR' | 'BGN' | 'CDF' | 'BAM' | 'EUR' | 'MXV' | 'UAH' | 'GEL' | 'BOV' | 'PLN' | 'BRL' | 'CLF' | 'XSU' | 'USN' | 'XXX' — ISO-4217 currency code.
      - `rate` number, double
    - `billedAmount` object — **Read-only.** Billed amount of the purchase.
      - `base` Amount — Represents an amount of money.
        - `value` number, double
        - `currency` 'Invalid' | 'ALL' | 'DZD' | 'ARS' | 'AUD' | 'BSD' | 'BHD' | 'BDT' | 'AMD' | 'BBD' | 'BMD' | 'BTN' | 'BOB' | 'BWP' | 'BZD' | 'SBD' | 'BND' | 'MMK' | 'BIF' | 'KHR' | 'CAD' | 'CVE' | 'KYD' | 'LKR' | 'CLP' | 'CNY' | 'COP' | 'KMF' | 'CRC' | 'HRK' | 'CUP' | 'CZK' | 'DKK' | 'DOP' | 'SVC' | 'ETB' | 'ERN' | 'FKP' | 'FJD' | 'DJF' | 'GMD' | 'GIP' | 'GTQ' | 'GNF' | 'GYD' | 'HTG' | 'HNL' | 'HKD' | 'HUF' | 'ISK' | 'INR' | 'IDR' | 'IRR' | 'IQD' | 'ILS' | 'JMD' | 'JPY' | 'KZT' | 'JOD' | 'KES' | 'KPW' | 'KRW' | 'KWD' | 'KGS' | 'LAK' | 'LBP' | 'LSL' | 'LVL' | 'LRD' | 'LYD' | 'LTL' | 'MOP' | 'MWK' | 'MYR' | 'MVR' | 'MRO' | 'MUR' | 'MXN' | 'MNT' | 'MDL' | 'MAD' | 'OMR' | 'NAD' | 'NPR' | 'ANG' | 'AWG' | 'VUV' | 'NZD' | 'NIO' | 'NGN' | 'NOK' | 'PKR' | 'PAB' | 'PGK' | 'PYG' | 'PEN' | 'PHP' | 'QAR' | 'RUB' | 'RWF' | 'SHP' | 'STD' | 'SAR' | 'SCR' | 'SLL' | 'SGD' | 'VND' | 'SOS' | 'ZAR' | 'SSP' | 'SZL' | 'SEK' | 'CHF' | 'SYP' | 'THB' | 'TOP' | 'TTD' | 'AED' | 'TND' | 'UGX' | 'MKD' | 'EGP' | 'GBP' | 'TZS' | 'USD' | 'UYU' | 'UZS' | 'WST' | 'YER' | 'ZMK' | 'TWD' | 'UYW' | 'VES' | 'MRU' | 'STN' | 'CUC' | 'ZWL' | 'BYN' | 'TMT' | 'GHS' | 'VEF' | 'SDG' | 'UYI' | 'RSD' | 'MZN' | 'AZN' | 'RON' | 'CHE' | 'CHW' | 'TRY' | 'XAF' | 'XCD' | 'XOF' | 'XPF' | 'XBA' | 'XBB' | 'XBC' | 'XBD' | 'XAU' | 'XDR' | 'XAG' | 'XPT' | 'XTS' | 'XPD' | 'XUA' | 'ZMW' | 'SRD' | 'MGA' | 'COU' | 'AFN' | 'TJS' | 'AOA' | 'BYR' | 'BGN' | 'CDF' | 'BAM' | 'EUR' | 'MXV' | 'UAH' | 'GEL' | 'BOV' | 'PLN' | 'BRL' | 'CLF' | 'XSU' | 'USN' | 'XXX' — ISO-4217 currency code.
      - `counter` Amount — Represents an amount of money.
        - `value` number, double
        - `currency` 'Invalid' | 'ALL' | 'DZD' | 'ARS' | 'AUD' | 'BSD' | 'BHD' | 'BDT' | 'AMD' | 'BBD' | 'BMD' | 'BTN' | 'BOB' | 'BWP' | 'BZD' | 'SBD' | 'BND' | 'MMK' | 'BIF' | 'KHR' | 'CAD' | 'CVE' | 'KYD' | 'LKR' | 'CLP' | 'CNY' | 'COP' | 'KMF' | 'CRC' | 'HRK' | 'CUP' | 'CZK' | 'DKK' | 'DOP' | 'SVC' | 'ETB' | 'ERN' | 'FKP' | 'FJD' | 'DJF' | 'GMD' | 'GIP' | 'GTQ' | 'GNF' | 'GYD' | 'HTG' | 'HNL' | 'HKD' | 'HUF' | 'ISK' | 'INR' | 'IDR' | 'IRR' | 'IQD' | 'ILS' | 'JMD' | 'JPY' | 'KZT' | 'JOD' | 'KES' | 'KPW' | 'KRW' | 'KWD' | 'KGS' | 'LAK' | 'LBP' | 'LSL' | 'LVL' | 'LRD' | 'LYD' | 'LTL' | 'MOP' | 'MWK' | 'MYR' | 'MVR' | 'MRO' | 'MUR' | 'MXN' | 'MNT' | 'MDL' | 'MAD' | 'OMR' | 'NAD' | 'NPR' | 'ANG' | 'AWG' | 'VUV' | 'NZD' | 'NIO' | 'NGN' | 'NOK' | 'PKR' | 'PAB' | 'PGK' | 'PYG' | 'PEN' | 'PHP' | 'QAR' | 'RUB' | 'RWF' | 'SHP' | 'STD' | 'SAR' | 'SCR' | 'SLL' | 'SGD' | 'VND' | 'SOS' | 'ZAR' | 'SSP' | 'SZL' | 'SEK' | 'CHF' | 'SYP' | 'THB' | 'TOP' | 'TTD' | 'AED' | 'TND' | 'UGX' | 'MKD' | 'EGP' | 'GBP' | 'TZS' | 'USD' | 'UYU' | 'UZS' | 'WST' | 'YER' | 'ZMK' | 'TWD' | 'UYW' | 'VES' | 'MRU' | 'STN' | 'CUC' | 'ZWL' | 'BYN' | 'TMT' | 'GHS' | 'VEF' | 'SDG' | 'UYI' | 'RSD' | 'MZN' | 'AZN' | 'RON' | 'CHE' | 'CHW' | 'TRY' | 'XAF' | 'XCD' | 'XOF' | 'XPF' | 'XBA' | 'XBB' | 'XBC' | 'XBD' | 'XAU' | 'XDR' | 'XAG' | 'XPT' | 'XTS' | 'XPD' | 'XUA' | 'ZMW' | 'SRD' | 'MGA' | 'COU' | 'AFN' | 'TJS' | 'AOA' | 'BYR' | 'BGN' | 'CDF' | 'BAM' | 'EUR' | 'MXV' | 'UAH' | 'GEL' | 'BOV' | 'PLN' | 'BRL' | 'CLF' | 'XSU' | 'USN' | 'XXX' — ISO-4217 currency code.
      - `rate` number, double
    - `committedAmount` object — **Read-only.** Committed amount of the purchase.
      - `base` Amount — Represents an amount of money.
        - `value` number, double
        - `currency` 'Invalid' | 'ALL' | 'DZD' | 'ARS' | 'AUD' | 'BSD' | 'BHD' | 'BDT' | 'AMD' | 'BBD' | 'BMD' | 'BTN' | 'BOB' | 'BWP' | 'BZD' | 'SBD' | 'BND' | 'MMK' | 'BIF' | 'KHR' | 'CAD' | 'CVE' | 'KYD' | 'LKR' | 'CLP' | 'CNY' | 'COP' | 'KMF' | 'CRC' | 'HRK' | 'CUP' | 'CZK' | 'DKK' | 'DOP' | 'SVC' | 'ETB' | 'ERN' | 'FKP' | 'FJD' | 'DJF' | 'GMD' | 'GIP' | 'GTQ' | 'GNF' | 'GYD' | 'HTG' | 'HNL' | 'HKD' | 'HUF' | 'ISK' | 'INR' | 'IDR' | 'IRR' | 'IQD' | 'ILS' | 'JMD' | 'JPY' | 'KZT' | 'JOD' | 'KES' | 'KPW' | 'KRW' | 'KWD' | 'KGS' | 'LAK' | 'LBP' | 'LSL' | 'LVL' | 'LRD' | 'LYD' | 'LTL' | 'MOP' | 'MWK' | 'MYR' | 'MVR' | 'MRO' | 'MUR' | 'MXN' | 'MNT' | 'MDL' | 'MAD' | 'OMR' | 'NAD' | 'NPR' | 'ANG' | 'AWG' | 'VUV' | 'NZD' | 'NIO' | 'NGN' | 'NOK' | 'PKR' | 'PAB' | 'PGK' | 'PYG' | 'PEN' | 'PHP' | 'QAR' | 'RUB' | 'RWF' | 'SHP' | 'STD' | 'SAR' | 'SCR' | 'SLL' | 'SGD' | 'VND' | 'SOS' | 'ZAR' | 'SSP' | 'SZL' | 'SEK' | 'CHF' | 'SYP' | 'THB' | 'TOP' | 'TTD' | 'AED' | 'TND' | 'UGX' | 'MKD' | 'EGP' | 'GBP' | 'TZS' | 'USD' | 'UYU' | 'UZS' | 'WST' | 'YER' | 'ZMK' | 'TWD' | 'UYW' | 'VES' | 'MRU' | 'STN' | 'CUC' | 'ZWL' | 'BYN' | 'TMT' | 'GHS' | 'VEF' | 'SDG' | 'UYI' | 'RSD' | 'MZN' | 'AZN' | 'RON' | 'CHE' | 'CHW' | 'TRY' | 'XAF' | 'XCD' | 'XOF' | 'XPF' | 'XBA' | 'XBB' | 'XBC' | 'XBD' | 'XAU' | 'XDR' | 'XAG' | 'XPT' | 'XTS' | 'XPD' | 'XUA' | 'ZMW' | 'SRD' | 'MGA' | 'COU' | 'AFN' | 'TJS' | 'AOA' | 'BYR' | 'BGN' | 'CDF' | 'BAM' | 'EUR' | 'MXV' | 'UAH' | 'GEL' | 'BOV' | 'PLN' | 'BRL' | 'CLF' | 'XSU' | 'USN' | 'XXX' — ISO-4217 currency code.
      - `counter` Amount — Represents an amount of money.
        - `value` number, double
        - `currency` 'Invalid' | 'ALL' | 'DZD' | 'ARS' | 'AUD' | 'BSD' | 'BHD' | 'BDT' | 'AMD' | 'BBD' | 'BMD' | 'BTN' | 'BOB' | 'BWP' | 'BZD' | 'SBD' | 'BND' | 'MMK' | 'BIF' | 'KHR' | 'CAD' | 'CVE' | 'KYD' | 'LKR' | 'CLP' | 'CNY' | 'COP' | 'KMF' | 'CRC' | 'HRK' | 'CUP' | 'CZK' | 'DKK' | 'DOP' | 'SVC' | 'ETB' | 'ERN' | 'FKP' | 'FJD' | 'DJF' | 'GMD' | 'GIP' | 'GTQ' | 'GNF' | 'GYD' | 'HTG' | 'HNL' | 'HKD' | 'HUF' | 'ISK' | 'INR' | 'IDR' | 'IRR' | 'IQD' | 'ILS' | 'JMD' | 'JPY' | 'KZT' | 'JOD' | 'KES' | 'KPW' | 'KRW' | 'KWD' | 'KGS' | 'LAK' | 'LBP' | 'LSL' | 'LVL' | 'LRD' | 'LYD' | 'LTL' | 'MOP' | 'MWK' | 'MYR' | 'MVR' | 'MRO' | 'MUR' | 'MXN' | 'MNT' | 'MDL' | 'MAD' | 'OMR' | 'NAD' | 'NPR' | 'ANG' | 'AWG' | 'VUV' | 'NZD' | 'NIO' | 'NGN' | 'NOK' | 'PKR' | 'PAB' | 'PGK' | 'PYG' | 'PEN' | 'PHP' | 'QAR' | 'RUB' | 'RWF' | 'SHP' | 'STD' | 'SAR' | 'SCR' | 'SLL' | 'SGD' | 'VND' | 'SOS' | 'ZAR' | 'SSP' | 'SZL' | 'SEK' | 'CHF' | 'SYP' | 'THB' | 'TOP' | 'TTD' | 'AED' | 'TND' | 'UGX' | 'MKD' | 'EGP' | 'GBP' | 'TZS' | 'USD' | 'UYU' | 'UZS' | 'WST' | 'YER' | 'ZMK' | 'TWD' | 'UYW' | 'VES' | 'MRU' | 'STN' | 'CUC' | 'ZWL' | 'BYN' | 'TMT' | 'GHS' | 'VEF' | 'SDG' | 'UYI' | 'RSD' | 'MZN' | 'AZN' | 'RON' | 'CHE' | 'CHW' | 'TRY' | 'XAF' | 'XCD' | 'XOF' | 'XPF' | 'XBA' | 'XBB' | 'XBC' | 'XBD' | 'XAU' | 'XDR' | 'XAG' | 'XPT' | 'XTS' | 'XPD' | 'XUA' | 'ZMW' | 'SRD' | 'MGA' | 'COU' | 'AFN' | 'TJS' | 'AOA' | 'BYR' | 'BGN' | 'CDF' | 'BAM' | 'EUR' | 'MXV' | 'UAH' | 'GEL' | 'BOV' | 'PLN' | 'BRL' | 'CLF' | 'XSU' | 'USN' | 'XXX' — ISO-4217 currency code.
      - `rate` number, double
    - `confirmedAmount` object — **Read-only.** Confirmed amount of the purchase.
      - `base` Amount — Represents an amount of money.
        - `value` number, double
        - `currency` 'Invalid' | 'ALL' | 'DZD' | 'ARS' | 'AUD' | 'BSD' | 'BHD' | 'BDT' | 'AMD' | 'BBD' | 'BMD' | 'BTN' | 'BOB' | 'BWP' | 'BZD' | 'SBD' | 'BND' | 'MMK' | 'BIF' | 'KHR' | 'CAD' | 'CVE' | 'KYD' | 'LKR' | 'CLP' | 'CNY' | 'COP' | 'KMF' | 'CRC' | 'HRK' | 'CUP' | 'CZK' | 'DKK' | 'DOP' | 'SVC' | 'ETB' | 'ERN' | 'FKP' | 'FJD' | 'DJF' | 'GMD' | 'GIP' | 'GTQ' | 'GNF' | 'GYD' | 'HTG' | 'HNL' | 'HKD' | 'HUF' | 'ISK' | 'INR' | 'IDR' | 'IRR' | 'IQD' | 'ILS' | 'JMD' | 'JPY' | 'KZT' | 'JOD' | 'KES' | 'KPW' | 'KRW' | 'KWD' | 'KGS' | 'LAK' | 'LBP' | 'LSL' | 'LVL' | 'LRD' | 'LYD' | 'LTL' | 'MOP' | 'MWK' | 'MYR' | 'MVR' | 'MRO' | 'MUR' | 'MXN' | 'MNT' | 'MDL' | 'MAD' | 'OMR' | 'NAD' | 'NPR' | 'ANG' | 'AWG' | 'VUV' | 'NZD' | 'NIO' | 'NGN' | 'NOK' | 'PKR' | 'PAB' | 'PGK' | 'PYG' | 'PEN' | 'PHP' | 'QAR' | 'RUB' | 'RWF' | 'SHP' | 'STD' | 'SAR' | 'SCR' | 'SLL' | 'SGD' | 'VND' | 'SOS' | 'ZAR' | 'SSP' | 'SZL' | 'SEK' | 'CHF' | 'SYP' | 'THB' | 'TOP' | 'TTD' | 'AED' | 'TND' | 'UGX' | 'MKD' | 'EGP' | 'GBP' | 'TZS' | 'USD' | 'UYU' | 'UZS' | 'WST' | 'YER' | 'ZMK' | 'TWD' | 'UYW' | 'VES' | 'MRU' | 'STN' | 'CUC' | 'ZWL' | 'BYN' | 'TMT' | 'GHS' | 'VEF' | 'SDG' | 'UYI' | 'RSD' | 'MZN' | 'AZN' | 'RON' | 'CHE' | 'CHW' | 'TRY' | 'XAF' | 'XCD' | 'XOF' | 'XPF' | 'XBA' | 'XBB' | 'XBC' | 'XBD' | 'XAU' | 'XDR' | 'XAG' | 'XPT' | 'XTS' | 'XPD' | 'XUA' | 'ZMW' | 'SRD' | 'MGA' | 'COU' | 'AFN' | 'TJS' | 'AOA' | 'BYR' | 'BGN' | 'CDF' | 'BAM' | 'EUR' | 'MXV' | 'UAH' | 'GEL' | 'BOV' | 'PLN' | 'BRL' | 'CLF' | 'XSU' | 'USN' | 'XXX' — ISO-4217 currency code.
      - `counter` Amount — Represents an amount of money.
        - `value` number, double
        - `currency` 'Invalid' | 'ALL' | 'DZD' | 'ARS' | 'AUD' | 'BSD' | 'BHD' | 'BDT' | 'AMD' | 'BBD' | 'BMD' | 'BTN' | 'BOB' | 'BWP' | 'BZD' | 'SBD' | 'BND' | 'MMK' | 'BIF' | 'KHR' | 'CAD' | 'CVE' | 'KYD' | 'LKR' | 'CLP' | 'CNY' | 'COP' | 'KMF' | 'CRC' | 'HRK' | 'CUP' | 'CZK' | 'DKK' | 'DOP' | 'SVC' | 'ETB' | 'ERN' | 'FKP' | 'FJD' | 'DJF' | 'GMD' | 'GIP' | 'GTQ' | 'GNF' | 'GYD' | 'HTG' | 'HNL' | 'HKD' | 'HUF' | 'ISK' | 'INR' | 'IDR' | 'IRR' | 'IQD' | 'ILS' | 'JMD' | 'JPY' | 'KZT' | 'JOD' | 'KES' | 'KPW' | 'KRW' | 'KWD' | 'KGS' | 'LAK' | 'LBP' | 'LSL' | 'LVL' | 'LRD' | 'LYD' | 'LTL' | 'MOP' | 'MWK' | 'MYR' | 'MVR' | 'MRO' | 'MUR' | 'MXN' | 'MNT' | 'MDL' | 'MAD' | 'OMR' | 'NAD' | 'NPR' | 'ANG' | 'AWG' | 'VUV' | 'NZD' | 'NIO' | 'NGN' | 'NOK' | 'PKR' | 'PAB' | 'PGK' | 'PYG' | 'PEN' | 'PHP' | 'QAR' | 'RUB' | 'RWF' | 'SHP' | 'STD' | 'SAR' | 'SCR' | 'SLL' | 'SGD' | 'VND' | 'SOS' | 'ZAR' | 'SSP' | 'SZL' | 'SEK' | 'CHF' | 'SYP' | 'THB' | 'TOP' | 'TTD' | 'AED' | 'TND' | 'UGX' | 'MKD' | 'EGP' | 'GBP' | 'TZS' | 'USD' | 'UYU' | 'UZS' | 'WST' | 'YER' | 'ZMK' | 'TWD' | 'UYW' | 'VES' | 'MRU' | 'STN' | 'CUC' | 'ZWL' | 'BYN' | 'TMT' | 'GHS' | 'VEF' | 'SDG' | 'UYI' | 'RSD' | 'MZN' | 'AZN' | 'RON' | 'CHE' | 'CHW' | 'TRY' | 'XAF' | 'XCD' | 'XOF' | 'XPF' | 'XBA' | 'XBB' | 'XBC' | 'XBD' | 'XAU' | 'XDR' | 'XAG' | 'XPT' | 'XTS' | 'XPD' | 'XUA' | 'ZMW' | 'SRD' | 'MGA' | 'COU' | 'AFN' | 'TJS' | 'AOA' | 'BYR' | 'BGN' | 'CDF' | 'BAM' | 'EUR' | 'MXV' | 'UAH' | 'GEL' | 'BOV' | 'PLN' | 'BRL' | 'CLF' | 'XSU' | 'USN' | 'XXX' — ISO-4217 currency code.
      - `rate` number, double
    - `requestedAmount` object — **Read-only.** Requested amount of the purchase.
      - `base` Amount — Represents an amount of money.
        - `value` number, double
        - `currency` 'Invalid' | 'ALL' | 'DZD' | 'ARS' | 'AUD' | 'BSD' | 'BHD' | 'BDT' | 'AMD' | 'BBD' | 'BMD' | 'BTN' | 'BOB' | 'BWP' | 'BZD' | 'SBD' | 'BND' | 'MMK' | 'BIF' | 'KHR' | 'CAD' | 'CVE' | 'KYD' | 'LKR' | 'CLP' | 'CNY' | 'COP' | 'KMF' | 'CRC' | 'HRK' | 'CUP' | 'CZK' | 'DKK' | 'DOP' | 'SVC' | 'ETB' | 'ERN' | 'FKP' | 'FJD' | 'DJF' | 'GMD' | 'GIP' | 'GTQ' | 'GNF' | 'GYD' | 'HTG' | 'HNL' | 'HKD' | 'HUF' | 'ISK' | 'INR' | 'IDR' | 'IRR' | 'IQD' | 'ILS' | 'JMD' | 'JPY' | 'KZT' | 'JOD' | 'KES' | 'KPW' | 'KRW' | 'KWD' | 'KGS' | 'LAK' | 'LBP' | 'LSL' | 'LVL' | 'LRD' | 'LYD' | 'LTL' | 'MOP' | 'MWK' | 'MYR' | 'MVR' | 'MRO' | 'MUR' | 'MXN' | 'MNT' | 'MDL' | 'MAD' | 'OMR' | 'NAD' | 'NPR' | 'ANG' | 'AWG' | 'VUV' | 'NZD' | 'NIO' | 'NGN' | 'NOK' | 'PKR' | 'PAB' | 'PGK' | 'PYG' | 'PEN' | 'PHP' | 'QAR' | 'RUB' | 'RWF' | 'SHP' | 'STD' | 'SAR' | 'SCR' | 'SLL' | 'SGD' | 'VND' | 'SOS' | 'ZAR' | 'SSP' | 'SZL' | 'SEK' | 'CHF' | 'SYP' | 'THB' | 'TOP' | 'TTD' | 'AED' | 'TND' | 'UGX' | 'MKD' | 'EGP' | 'GBP' | 'TZS' | 'USD' | 'UYU' | 'UZS' | 'WST' | 'YER' | 'ZMK' | 'TWD' | 'UYW' | 'VES' | 'MRU' | 'STN' | 'CUC' | 'ZWL' | 'BYN' | 'TMT' | 'GHS' | 'VEF' | 'SDG' | 'UYI' | 'RSD' | 'MZN' | 'AZN' | 'RON' | 'CHE' | 'CHW' | 'TRY' | 'XAF' | 'XCD' | 'XOF' | 'XPF' | 'XBA' | 'XBB' | 'XBC' | 'XBD' | 'XAU' | 'XDR' | 'XAG' | 'XPT' | 'XTS' | 'XPD' | 'XUA' | 'ZMW' | 'SRD' | 'MGA' | 'COU' | 'AFN' | 'TJS' | 'AOA' | 'BYR' | 'BGN' | 'CDF' | 'BAM' | 'EUR' | 'MXV' | 'UAH' | 'GEL' | 'BOV' | 'PLN' | 'BRL' | 'CLF' | 'XSU' | 'USN' | 'XXX' — ISO-4217 currency code.
      - `counter` Amount — Represents an amount of money.
        - `value` number, double
        - `currency` 'Invalid' | 'ALL' | 'DZD' | 'ARS' | 'AUD' | 'BSD' | 'BHD' | 'BDT' | 'AMD' | 'BBD' | 'BMD' | 'BTN' | 'BOB' | 'BWP' | 'BZD' | 'SBD' | 'BND' | 'MMK' | 'BIF' | 'KHR' | 'CAD' | 'CVE' | 'KYD' | 'LKR' | 'CLP' | 'CNY' | 'COP' | 'KMF' | 'CRC' | 'HRK' | 'CUP' | 'CZK' | 'DKK' | 'DOP' | 'SVC' | 'ETB' | 'ERN' | 'FKP' | 'FJD' | 'DJF' | 'GMD' | 'GIP' | 'GTQ' | 'GNF' | 'GYD' | 'HTG' | 'HNL' | 'HKD' | 'HUF' | 'ISK' | 'INR' | 'IDR' | 'IRR' | 'IQD' | 'ILS' | 'JMD' | 'JPY' | 'KZT' | 'JOD' | 'KES' | 'KPW' | 'KRW' | 'KWD' | 'KGS' | 'LAK' | 'LBP' | 'LSL' | 'LVL' | 'LRD' | 'LYD' | 'LTL' | 'MOP' | 'MWK' | 'MYR' | 'MVR' | 'MRO' | 'MUR' | 'MXN' | 'MNT' | 'MDL' | 'MAD' | 'OMR' | 'NAD' | 'NPR' | 'ANG' | 'AWG' | 'VUV' | 'NZD' | 'NIO' | 'NGN' | 'NOK' | 'PKR' | 'PAB' | 'PGK' | 'PYG' | 'PEN' | 'PHP' | 'QAR' | 'RUB' | 'RWF' | 'SHP' | 'STD' | 'SAR' | 'SCR' | 'SLL' | 'SGD' | 'VND' | 'SOS' | 'ZAR' | 'SSP' | 'SZL' | 'SEK' | 'CHF' | 'SYP' | 'THB' | 'TOP' | 'TTD' | 'AED' | 'TND' | 'UGX' | 'MKD' | 'EGP' | 'GBP' | 'TZS' | 'USD' | 'UYU' | 'UZS' | 'WST' | 'YER' | 'ZMK' | 'TWD' | 'UYW' | 'VES' | 'MRU' | 'STN' | 'CUC' | 'ZWL' | 'BYN' | 'TMT' | 'GHS' | 'VEF' | 'SDG' | 'UYI' | 'RSD' | 'MZN' | 'AZN' | 'RON' | 'CHE' | 'CHW' | 'TRY' | 'XAF' | 'XCD' | 'XOF' | 'XPF' | 'XBA' | 'XBB' | 'XBC' | 'XBD' | 'XAU' | 'XDR' | 'XAG' | 'XPT' | 'XTS' | 'XPD' | 'XUA' | 'ZMW' | 'SRD' | 'MGA' | 'COU' | 'AFN' | 'TJS' | 'AOA' | 'BYR' | 'BGN' | 'CDF' | 'BAM' | 'EUR' | 'MXV' | 'UAH' | 'GEL' | 'BOV' | 'PLN' | 'BRL' | 'CLF' | 'XSU' | 'USN' | 'XXX' — ISO-4217 currency code.
      - `rate` number, double
    - `aggregatedStates` object — **Read-only.** Aggregated states of the purchase.
      - `creditNotes` object — Aggregated states of the credit notes of the purchase.
        - `expected` integer — Number of expected credit notes.
        - `toReview` integer — Number of credit notes to review.
        - `partial` integer — Number of partial credit notes.
        - `confirmed` integer — Number of confirmed credit notes.
        - `pendingRetraction` integer — Number of pending retraction credit notes.
        - `removed` integer — Number of removed credit notes.
        - `bypassed` integer — Number of bypassed credit notes.
      - `invoices` object — **Read-only.** Aggregated states of the invoices of the purchase.
        - `expected` integer — Number of expected invoices.
        - `toReview` integer — Number of invoices to review.
        - `pendingBreakdown` integer — Number of invoices pending breakdown.
        - `confirmed` integer — Number of confirmed invoices.
        - `litigation` integer — Number of invoices in litigation.
        - `discarded` integer — Number of discarded invoices.
        - `removed` integer — Number of removed invoices.
        - `bypassed` integer — Number of bypassed invoices.
      - `invoicesPayments` object — **Read-only.** Aggregated states of the invoices payments of the purchase.
        - `toPay` integer — Number of invoices to pay.
        - `underReview` integer — Number of invoices under review.
        - `emitting` integer — Number of invoices emitting.
        - `paid` integer — Number of paid invoices.
        - `onHold` integer — Number of invoices on hold.
      - `creditNotesPayments` object — **Read-only.** Aggregated states of the credit notes payments of the purchase.
        - `available` integer — Number of available credit notes payments.
        - `consumed` integer — Number of consumed credit notes payments.
        - `unavailable` integer — Number of unavailable credit notes payments.
    - `axisSectionIds` integer[] — **Write-only.** IDs of the axis-sections to which the purchase belongs.
    - `axisSections` AxisSectionReference[] — **Read-only.** Axis-sections to which the purchase belongs.
      - `id` integer, required
      - `href` string, uri — **Read-only.** Relative link to this resource.
      - `name` string — **Read-only.** Name of the axis-section.
      - `code` string — **Read-only.** Code of the axis-section.
      - `axisId` integer — **Read-only.** ID of the axis to which the axis-section belongs.
    - `createdAt` string, date-time — **Read-only.** Date of creation of the purchase
    - `author` object — Reference to a user.
      - `id` integer
      - `href` string, uri
      - `name` string
      - `firstName` string
      - `lastName` string
      - `pictureHref` string, uri, nullable — **Read-only.** URL to this user picture image file.
    - `modifiedAt` string, date-time — **Read-only.** Date of last modification of the purchase.
    - `modifier` object — Reference to a user.
      - `id` integer
      - `href` string, uri
      - `name` string
      - `firstName` string
      - `lastName` string
      - `pictureHref` string, uri, nullable — **Read-only.** URL to this user picture image file.
  - `prev` union
    - string
    - integer
  - `next` union
    - string
    - integer
  - `count` integer

---

[API](https://skmtc.net/luccasoftware/apis/lucca-expenses.md) · [All operations](https://skmtc.net/luccasoftware/apis/lucca-expenses/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/luccasoftware/lucca-expenses/revisions/110f9897756c/schema)