{
  "opencollection": "1.0.0",
  "info": {
    "name": "Companies AI Embed Payment API",
    "version": "v296.0-SNAPSHOT"
  },
  "items": [
    {
      "info": {
        "name": "Payment",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "List all payments for a company",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://marketplace.appdirect.com/api/billing/v1/companies/:companyId/payments",
            "params": [
              {
                "name": "companyId",
                "value": "",
                "type": "path",
                "description": "Company UUID"
              },
              {
                "name": "count",
                "value": "",
                "type": "query",
                "description": "Number of results to fetch. Used for paging."
              },
              {
                "name": "fromDate",
                "value": "",
                "type": "query",
                "description": "From date"
              },
              {
                "name": "method",
                "value": "",
                "type": "query",
                "description": "Payment method"
              },
              {
                "name": "result",
                "value": "",
                "type": "query",
                "description": "Payment result"
              },
              {
                "name": "sortField",
                "value": "",
                "type": "query",
                "description": "Sort field"
              },
              {
                "name": "sortOrder",
                "value": "",
                "type": "query",
                "description": "Sort order"
              },
              {
                "name": "start",
                "value": "",
                "type": "query",
                "description": "First result index. Used for paging."
              },
              {
                "name": "toDate",
                "value": "",
                "type": "query",
                "description": "To date"
              }
            ]
          },
          "docs": "List all of  the payments for the given company"
        },
        {
          "info": {
            "name": "List all payments for a user",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://marketplace.appdirect.com/api/billing/v1/companies/:companyId/users/:userId/payments",
            "params": [
              {
                "name": "companyId",
                "value": "",
                "type": "path",
                "description": "Company UUID"
              },
              {
                "name": "userId",
                "value": "",
                "type": "path",
                "description": "User UUID"
              },
              {
                "name": "count",
                "value": "",
                "type": "query",
                "description": "Number of results to fetch. Used for paging."
              },
              {
                "name": "fromDate",
                "value": "",
                "type": "query",
                "description": "From date"
              },
              {
                "name": "method",
                "value": "",
                "type": "query",
                "description": "Payment method"
              },
              {
                "name": "result",
                "value": "",
                "type": "query",
                "description": "Payment result"
              },
              {
                "name": "sortField",
                "value": "",
                "type": "query",
                "description": "Sort field"
              },
              {
                "name": "sortOrder",
                "value": "",
                "type": "query",
                "description": "Sort order"
              },
              {
                "name": "start",
                "value": "",
                "type": "query",
                "description": "First result index. Used for paging."
              },
              {
                "name": "toDate",
                "value": "",
                "type": "query",
                "description": "To date"
              }
            ]
          },
          "docs": "List all of the payments for the given user"
        },
        {
          "info": {
            "name": "List all payments",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://marketplace.appdirect.com/api/billing/v1/payments",
            "params": [
              {
                "name": "count",
                "value": "",
                "type": "query",
                "description": "Number of results to fetch. Used for paging."
              },
              {
                "name": "fromDate",
                "value": "",
                "type": "query",
                "description": "From date"
              },
              {
                "name": "method",
                "value": "",
                "type": "query",
                "description": "Payment method"
              },
              {
                "name": "result",
                "value": "",
                "type": "query",
                "description": "Payment result"
              },
              {
                "name": "sortField",
                "value": "",
                "type": "query",
                "description": "Sort field"
              },
              {
                "name": "sortOrder",
                "value": "",
                "type": "query",
                "description": "Sort order"
              },
              {
                "name": "start",
                "value": "",
                "type": "query",
                "description": "First result index. Used for paging."
              },
              {
                "name": "toDate",
                "value": "",
                "type": "query",
                "description": "To date"
              }
            ]
          },
          "docs": "List all payments matching the input filters"
        },
        {
          "info": {
            "name": "Retrieve a payment",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://marketplace.appdirect.com/api/billing/v1/payments/:paymentNumber",
            "params": [
              {
                "name": "paymentNumber",
                "value": "",
                "type": "path",
                "description": "Payment number"
              }
            ]
          },
          "docs": "Retrieve a payment given its payment number"
        },
        {
          "info": {
            "name": "List all payment invoices",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://marketplace.appdirect.com/api/billing/v1/payments/:paymentNumber/invoices",
            "params": [
              {
                "name": "paymentNumber",
                "value": "",
                "type": "path",
                "description": "Payment number"
              },
              {
                "name": "count",
                "value": "",
                "type": "query",
                "description": "Number of results to fetch. Used for paging."
              },
              {
                "name": "excludeFree",
                "value": "",
                "type": "query",
                "description": "Exclude free invoices"
              },
              {
                "name": "fromDate",
                "value": "",
                "type": "query",
                "description": "From date"
              },
              {
                "name": "sortField",
                "value": "",
                "type": "query",
                "description": "Sort field"
              },
              {
                "name": "sortOrder",
                "value": "",
                "type": "query",
                "description": "Sort order"
              },
              {
                "name": "start",
                "value": "",
                "type": "query",
                "description": "First result index. Used for paging."
              },
              {
                "name": "status",
                "value": "",
                "type": "query",
                "description": "Status of the related invoice(s)"
              },
              {
                "name": "toDate",
                "value": "",
                "type": "query",
                "description": "To date"
              }
            ]
          },
          "docs": "List all invoices attached to a given payment"
        }
      ]
    }
  ],
  "bundled": true
}