{
  "opencollection": "1.0.0",
  "info": {
    "name": "AlayaCare Accounting Accounts Transactions API",
    "version": "1.0.19-oas3"
  },
  "request": {
    "auth": {
      "type": "basic",
      "username": "{{username}}",
      "password": "{{password}}"
    }
  },
  "items": [
    {
      "info": {
        "name": "Transactions",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Returns a collection of transactions",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://example.alayacare.com/ext/api/v2/accounting/transactions",
            "params": [
              {
                "name": "transaction_ids",
                "value": "",
                "type": "query",
                "description": "A list of transaction IDs to filter by"
              },
              {
                "name": "exclude_ids",
                "value": "",
                "type": "query",
                "description": "A list of transaction IDs to exclude from the results"
              },
              {
                "name": "reference_id",
                "value": "",
                "type": "query",
                "description": "The Reference ID of the transaction to find"
              },
              {
                "name": "type",
                "value": "",
                "type": "query",
                "description": "The type of transactions to list"
              },
              {
                "name": "reversed",
                "value": "",
                "type": "query",
                "description": "Whether to include reversed transactions or not"
              },
              {
                "name": "ar_entry_type",
                "value": "",
                "type": "query",
                "description": "The transaction's entry type to filter by."
              },
              {
                "name": "ar_description",
                "value": "",
                "type": "query",
                "description": "The transaction's description to filter by."
              },
              {
                "name": "invoice_number",
                "value": "",
                "type": "query",
                "description": "The invoice number to filter the transactions by"
              },
              {
                "name": "search",
                "value": "",
                "type": "query",
                "description": "The Reference ID of the transaction or the Invoice Number to find"
              },
              {
                "name": "invoice_id",
                "value": "",
                "type": "query",
                "description": "The invoice ID to filter the transactions by"
              },
              {
                "name": "invoice_item_ids",
                "value": "",
                "type": "query",
                "description": "The invoice item IDs to filter the transactions by"
              },
              {
                "name": "client_id",
                "value": "",
                "type": "query",
                "description": "The client ID to filter by"
              },
              {
                "name": "funder_id",
                "value": "",
                "type": "query",
                "description": "The funder ID to filter by"
              },
              {
                "name": "billing_contact_id",
                "value": "",
                "type": "query",
                "description": "The billing contact ID to filter by"
              },
              {
                "name": "transaction_date_from",
                "value": "",
                "type": "query",
                "description": "The date after which transactions should be filtered (inclusive) - ex. 2024-01-31"
              },
              {
                "name": "transaction_date_to",
                "value": "",
                "type": "query",
                "description": "The date before which transactions should be filtered (exclusive) - ex. 2024-01-31"
              },
              {
                "name": "memo",
                "value": "",
                "type": "query",
                "description": "String for which to search (partial) in the transaction memo"
              },
              {
                "name": "client_search",
                "value": "",
                "type": "query",
                "description": "The name or the id of the client (partial)"
              },
              {
                "name": "date_from",
                "value": "",
                "type": "query",
                "description": "The posting date after which transactions should be filtered (inclusive) - ex. 2024-01-31"
              },
              {
                "name": "date_to",
                "value": "",
                "type": "query",
                "description": "The posting date before which transactions should be filtered (inclusive) - ex. 2024-01-31"
              },
              {
                "name": "account_name",
                "value": "",
                "type": "query",
                "description": "The name of the account to filter by"
              },
              {
                "name": "account_number",
                "value": "",
                "type": "query",
                "description": "The number of the account to filter by"
              },
              {
                "name": "account_ids",
                "value": "",
                "type": "query",
                "description": "The account IDs to filter by"
              },
              {
                "name": "adjusted",
                "value": "",
                "type": "query",
                "description": "Whether or not the transaction has an adjustment allocated to it."
              },
              {
                "name": "include_medicaid",
                "value": "",
                "type": "query",
                "description": "Whether or not to include medicaid funders. Defaults to True"
              },
              {
                "name": "include_ccac",
                "value": "",
                "type": "query",
                "description": "Whether or not to include CCAC funders. Defaults to True"
              },
              {
                "name": "include_allocated",
                "value": "",
                "type": "query",
                "description": "Whether to include allocated transactions or not"
              },
              {
                "name": "include_voided_sales",
                "value": "",
                "type": "query",
                "description": "True to included voided sales; False to exclude them. Defaults to true"
              },
              {
                "name": "only_without_allocations",
                "value": "",
                "type": "query",
                "description": "True to select only the transactions that do not have allocations (in this case, note that reverted allocations are considered as non-existent);  False to select the transactions no matter their number of allocations. Defaults to False."
              },
              {
                "name": "include_canceled_payments",
                "value": "",
                "type": "query",
                "description": "True to include canceled payments; False to exclude them. Defaults to true"
              },
              {
                "name": "order",
                "value": "",
                "type": "query",
                "description": "Field on which to sort the results"
              },
              {
                "name": "include_account",
                "value": "",
                "type": "query",
                "description": "Whether to include the account information in the response"
              },
              {
                "name": "asc",
                "value": "",
                "type": "query",
                "description": "Whether to sort ascendingly, defaults to false"
              },
              {
                "name": "page",
                "value": "",
                "type": "query",
                "description": "Page to retrieve"
              },
              {
                "name": "count",
                "value": "",
                "type": "query",
                "description": "Number of items per page"
              }
            ]
          },
          "docs": "Returns a collection of transactions"
        },
        {
          "info": {
            "name": "Find transaction by ID",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://example.alayacare.com/ext/api/v2/accounting/transactions/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Reference ID of transaction to return"
              }
            ]
          },
          "docs": "Returns a single transaction"
        }
      ]
    }
  ],
  "bundled": true
}