{
  "opencollection": "1.0.0",
  "info": {
    "name": "Puzzle Api Accounts Company API",
    "version": "0"
  },
  "items": [
    {
      "info": {
        "name": "Company",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Initiate Creating a Company",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://staging.southparkdata.com/rest/v0/company",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Call this endpoint to pass some company information that is usually asked for during Puzzle's onboarding flow. A URL will be returned. When you redirect your user to this URL, the company information that was passed the original request will be prefilled for them in Puzzle's UI, allowing them to skip a few steps and create their Puzzle account more quickly."
        },
        {
          "info": {
            "name": "Get companies",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://staging.southparkdata.com/rest/v0/companies"
          },
          "docs": "Returns a list of companies the calling user has access to.\n\nRequired scope: read:company"
        },
        {
          "info": {
            "name": "Get Company",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://staging.southparkdata.com/rest/v0/company/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "The company ID"
              }
            ]
          },
          "docs": "Get Company"
        },
        {
          "info": {
            "name": "Create Integration Connection",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://staging.southparkdata.com/rest/v0/company/:id/integrationConnection",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "The company ID"
              }
            ]
          },
          "docs": "Creates an integration connection for the company that you can use to push data into Puzzle.\n\nRequired scope: write:integration_connection"
        },
        {
          "info": {
            "name": "Disconnect Company",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://staging.southparkdata.com/rest/v0/company/:id/disconnect",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "The company ID"
              }
            ]
          },
          "docs": "Disconnect Company"
        },
        {
          "info": {
            "name": "Get Chart of Accounts",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://staging.southparkdata.com/rest/v0/company/:id/chartOfAccounts",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "The company ID"
              },
              {
                "name": "basis",
                "value": "",
                "type": "query"
              },
              {
                "name": "startDate",
                "value": "",
                "type": "query"
              },
              {
                "name": "effectiveDate",
                "value": "",
                "type": "query"
              },
              {
                "name": "nominalCode",
                "value": "",
                "type": "query"
              },
              {
                "name": "getRestricted",
                "value": "",
                "type": "query"
              }
            ]
          },
          "docs": "Retrieves the company's chart of accounts (COA), which defines the financial statement categories used for accounting purposes.\n\nBy default, all accounts are returned and the balances are calculated using cash basis.\n\nRequired scope: read:company"
        },
        {
          "info": {
            "name": "Get Classifications",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://staging.southparkdata.com/rest/v0/company/:id/classifications",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "The company ID"
              }
            ]
          },
          "docs": "Retrieves a list of all classifications available for the calling company.\n\nRequires scope: read:company"
        },
        {
          "info": {
            "name": "Create Classifications",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://staging.southparkdata.com/rest/v0/company/:id/classifications",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "The company ID"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Creates a classification.\n\nRequires scope: write:classification"
        },
        {
          "info": {
            "name": "Get Classification",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://staging.southparkdata.com/rest/v0/company/:id/classifications/:classificationId",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "The company ID"
              },
              {
                "name": "classificationId",
                "value": "",
                "type": "path",
                "description": "The classification ID"
              }
            ]
          },
          "docs": "Retrieves a classification available for the calling company.\n\nRequires scope: read:company"
        },
        {
          "info": {
            "name": "Get Trial Balance Report",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://staging.southparkdata.com/rest/v0/company/:id/trial-balance",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "The company ID"
              },
              {
                "name": "type",
                "value": "",
                "type": "query"
              },
              {
                "name": "viewBy",
                "value": "",
                "type": "query"
              },
              {
                "name": "startPeriod",
                "value": "",
                "type": "query"
              },
              {
                "name": "endPeriod",
                "value": "",
                "type": "query"
              },
              {
                "name": "dateMacro",
                "value": "",
                "type": "query"
              },
              {
                "name": "level",
                "value": "",
                "type": "query"
              },
              {
                "name": "basis",
                "value": "",
                "type": "query"
              },
              {
                "name": "highWatermarkToken",
                "value": "",
                "type": "query"
              }
            ]
          },
          "docs": "This endpoint generates a trial balance report. You can specify the time period for the report using either:\n\ndateMacro (a predefined date range)\nstartDate and endDate (a custom date range)\n\nIf all three are provided, dateMacro takes precedence.\n\nRequired scope: read:company"
        },
        {
          "info": {
            "name": "Get Monthly Checklist",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://staging.southparkdata.com/rest/v0/company/:id/monthly-checklists",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "The company ID"
              },
              {
                "name": "month",
                "value": "",
                "type": "query"
              }
            ]
          },
          "docs": "This endpoint retrieves the monthly checklist for the given company and month.\n\nRequired scope: read:company"
        }
      ]
    }
  ],
  "bundled": true
}