{ "openapi": "3.0.3", "info": { "title": "Boss Insights", "description": "A single API that provides a holistic view of business data including accounting, banking, commerce, marketing and more.\n\nThis documentation is intended for software developers and covers the Boss Insights API endpoints.\n\n
\nšŸ“š Looking for an API overview? You'll find that at our Developer Documentation site.\n
", "version": "1.26.0", "termsOfService": "https://bossinsights.com/legal-msa/", "contact": { "name": "Boss Insights Support", "url": "http://bossinsights.com/support" }, "license": { "name": "Apache 2.0", "url": "https://www.apache.org/licenses/LICENSE-2.0.html" } }, "servers": [ { "url": "https://example.myintranetapps.com/api", "description": "Example API Domain" } ], "paths": { "/accounting_transactions": { "get": { "operationId": "getAccountingTransactionCollection", "tags": [ "AccountingTransaction" ], "responses": { "200": { "description": "AccountingTransaction collection", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AccountingTransaction" } } }, "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AccountingTransaction" } } }, "text/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AccountingTransaction" } } }, "text/csv": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AccountingTransaction" } } }, "text/html": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AccountingTransaction" } } } } } }, "summary": "Retrieves a Collection of accounting transaction resources", "description": "Retrieves a Collection of accounting transaction resources", "parameters": [ { "name": "start", "in": "query", "description": "YYYY-MM-DD", "required": false, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string", "format": "date-time" }, "style": "form", "explode": false, "allowReserved": false, "example": "2022-07-01" }, { "name": "end", "in": "query", "description": "YYYY-MM-DD", "required": false, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string", "format": "date-time" }, "style": "form", "explode": false, "allowReserved": false, "example": "2022-08-31" }, { "name": "page", "in": "query", "description": "The collection page number", "required": false, "deprecated": false, "allowEmptyValue": true, "schema": { "type": "integer", "default": 1 }, "style": "form", "explode": false, "allowReserved": false }, { "name": "itemsPerPage", "in": "query", "description": "The number of items per page", "required": false, "deprecated": false, "allowEmptyValue": true, "schema": { "type": "integer", "default": 100, "minimum": 0, "maximum": 200 }, "style": "form", "explode": false, "allowReserved": false } ], "deprecated": false }, "parameters": [] }, "/accounting_transactions/{id}": { "get": { "operationId": "getAccountingTransactionItem", "tags": [ "AccountingTransaction" ], "responses": { "200": { "description": "AccountingTransaction resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccountingTransaction" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/AccountingTransaction" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/AccountingTransaction" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/AccountingTransaction" } }, "text/html": { "schema": { "$ref": "#/components/schemas/AccountingTransaction" } } } }, "404": { "description": "Resource not found" } }, "summary": "Retrieves a AccountingTransaction resource.", "description": "Retrieves a AccountingTransaction resource.", "parameters": [ { "name": "id", "in": "path", "description": "Resource identifier", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "deprecated": false }, "parameters": [] }, "/accounts": { "get": { "operationId": "getAccountCollection", "tags": [ "Account" ], "responses": { "200": { "description": "Account collection", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Account" } } }, "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Account" } } }, "text/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Account" } } }, "text/csv": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Account" } } }, "text/html": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Account" } } } } } }, "summary": "Retrieves the collection of Account resources.", "description": "Retrieves the collection of Account resources.", "parameters": [], "deprecated": false }, "post": { "operationId": "postAccountCollection", "tags": [ "Account" ], "responses": { "201": { "description": "Account resource created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Account" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/Account" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/Account" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/Account" } }, "text/html": { "schema": { "$ref": "#/components/schemas/Account" } } }, "links": { "GetAccountItem": { "operationId": "getAccountItem", "parameters": { "id": "$response.body#/id" }, "description": "The `id` value returned in the response can be used as the `id` parameter in `GET /accounts/{id}`." } } }, "400": { "description": "Invalid input" }, "422": { "description": "Unprocessable entity" } }, "summary": "Creates a Account resource.", "description": "Creates a Account resource.", "parameters": [], "requestBody": { "description": "The new Account resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Account" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/Account" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/Account" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/Account" } }, "text/html": { "schema": { "$ref": "#/components/schemas/Account" } } }, "required": true }, "deprecated": false }, "parameters": [] }, "/accounts/{id}": { "get": { "operationId": "getAccountItem", "tags": [ "Account" ], "responses": { "200": { "description": "Account resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Account" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/Account" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/Account" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/Account" } }, "text/html": { "schema": { "$ref": "#/components/schemas/Account" } } } }, "404": { "description": "Resource not found" } }, "summary": "Retrieves a Account resource.", "description": "Retrieves a Account resource.", "parameters": [ { "name": "id", "in": "path", "description": "Resource identifier", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "deprecated": false }, "put": { "operationId": "putAccountItem", "tags": [ "Account" ], "responses": { "200": { "description": "Account resource updated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Account" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/Account" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/Account" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/Account" } }, "text/html": { "schema": { "$ref": "#/components/schemas/Account" } } }, "links": { "GetAccountItem": { "operationId": "getAccountItem", "parameters": { "id": "$response.body#/id" }, "description": "The `id` value returned in the response can be used as the `id` parameter in `GET /accounts/{id}`." } } }, "400": { "description": "Invalid input" }, "422": { "description": "Unprocessable entity" }, "404": { "description": "Resource not found" } }, "summary": "Replaces the Account resource.", "description": "Replaces the Account resource.", "parameters": [ { "name": "id", "in": "path", "description": "Resource identifier", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "requestBody": { "description": "The updated Account resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Account" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/Account" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/Account" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/Account" } }, "text/html": { "schema": { "$ref": "#/components/schemas/Account" } } }, "required": true }, "deprecated": false }, "delete": { "operationId": "deleteAccountItem", "tags": [ "Account" ], "responses": { "204": { "description": "Account resource deleted" }, "404": { "description": "Resource not found" } }, "summary": "Removes the Account resource.", "description": "Removes the Account resource.", "parameters": [ { "name": "id", "in": "path", "description": "Resource identifier", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "deprecated": false }, "parameters": [] }, "/activities": { "get": { "operationId": "getActivityCollection", "tags": [ "Activity" ], "responses": { "200": { "description": "Activity collection", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Activity" } } }, "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Activity" } } }, "text/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Activity" } } }, "text/csv": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Activity" } } }, "text/html": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Activity" } } } } } }, "summary": "Retrieves the collection of Activity resources.", "description": "Retrieves the collection of Activity resources.", "parameters": [ { "name": "page", "in": "query", "description": "The collection page number", "required": false, "deprecated": false, "allowEmptyValue": true, "schema": { "type": "integer", "default": 1 }, "style": "form", "explode": false, "allowReserved": false }, { "name": "itemsPerPage", "in": "query", "description": "The number of items per page", "required": false, "deprecated": false, "allowEmptyValue": true, "schema": { "type": "integer", "default": 100, "minimum": 0, "maximum": 200 }, "style": "form", "explode": false, "allowReserved": false } ], "deprecated": false }, "parameters": [] }, "/activities/{id}": { "get": { "operationId": "getActivityItem", "tags": [ "Activity" ], "responses": { "200": { "description": "Activity resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Activity" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/Activity" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/Activity" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/Activity" } }, "text/html": { "schema": { "$ref": "#/components/schemas/Activity" } } } }, "404": { "description": "Resource not found" } }, "summary": "Retrieves a Activity resource.", "description": "Retrieves a Activity resource.", "parameters": [ { "name": "id", "in": "path", "description": "Resource identifier", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "deprecated": false }, "parameters": [] }, "/aged_payables_excel": { "get": { "operationId": "getAgedPayablesExcelItem", "tags": [ "AgedPayablesExcel" ], "responses": { "200": { "description": "AgedPayablesExcel resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AgedPayablesExcel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/AgedPayablesExcel" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/AgedPayablesExcel" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/AgedPayablesExcel" } }, "text/html": { "schema": { "$ref": "#/components/schemas/AgedPayablesExcel" } } } }, "404": { "description": "Resource not found" } }, "summary": "Retrieves an excel workbook of an aged payables report", "description": "Retrieves a AgedPayablesExcel resource.", "parameters": [ { "name": "asOf", "in": "query", "description": "YYYY-MM-DD", "required": false, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string", "format": "date-time" }, "style": "form", "explode": false, "allowReserved": false, "example": "2022-08-31" }, { "name": "refresh", "in": "query", "description": "If refresh is set, data will be fetched from the source application even when cached data is available", "required": false, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "form", "explode": false, "allowReserved": false, "example": "true" }, { "name": "sort", "in": "query", "description": "Vendors can be sorted by total amount in ascending or descending order, or alphabetically. Default is alphabetical.", "required": false, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string", "enum": [ "descending", "ascending", "alphabetical" ] }, "style": "form", "explode": false, "allowReserved": false, "example": "descending" } ], "deprecated": false }, "parameters": [] }, "/aged_payables_report": { "get": { "operationId": "getAgedPayablesReportItem", "tags": [ "AgedPayablesReport" ], "responses": { "200": { "description": "AgedPayablesReport resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AgedPayablesReport" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/AgedPayablesReport" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/AgedPayablesReport" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/AgedPayablesReport" } }, "text/html": { "schema": { "$ref": "#/components/schemas/AgedPayablesReport" } } } }, "404": { "description": "Resource not found" } }, "summary": "Retrieves an aged payables report", "description": "Retrieves a AgedPayablesReport resource.", "parameters": [ { "name": "asOf", "in": "query", "description": "YYYY-MM-DD", "required": false, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string", "format": "date-time" }, "style": "form", "explode": false, "allowReserved": false, "example": "2022-08-31" }, { "name": "refresh", "in": "query", "description": "If refresh is set, data will be fetched from the source application even when cached data is available", "required": false, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "form", "explode": false, "allowReserved": false, "example": "true" }, { "name": "sort", "in": "query", "description": "Vendors can be sorted by total amount in ascending or descending order, or alphabetically. Default is alphabetical.", "required": false, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string", "enum": [ "descending", "ascending", "alphabetical" ] }, "style": "form", "explode": false, "allowReserved": false, "example": "descending" } ], "deprecated": false }, "parameters": [] }, "/aged_receivables_excel": { "get": { "operationId": "getAgedReceivablesExcelItem", "tags": [ "AgedReceivablesExcel" ], "responses": { "200": { "description": "AgedReceivablesExcel resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AgedReceivablesExcel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/AgedReceivablesExcel" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/AgedReceivablesExcel" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/AgedReceivablesExcel" } }, "text/html": { "schema": { "$ref": "#/components/schemas/AgedReceivablesExcel" } } } }, "404": { "description": "Resource not found" } }, "summary": "Retrieves an excel workbook of an aged receivables report", "description": "Retrieves a AgedReceivablesExcel resource.", "parameters": [ { "name": "asOf", "in": "query", "description": "YYYY-MM-DD", "required": false, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string", "format": "date-time" }, "style": "form", "explode": false, "allowReserved": false, "example": "2022-08-31" }, { "name": "refresh", "in": "query", "description": "If refresh is set, data will be fetched from the source application even when cached data is available", "required": false, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "form", "explode": false, "allowReserved": false, "example": "true" }, { "name": "sort", "in": "query", "description": "Customers can be sorted by total amount in ascending or descending order, or alphabetically. Default is alphabetical.", "required": false, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string", "enum": [ "descending", "ascending", "alphabetical" ] }, "style": "form", "explode": false, "allowReserved": false, "example": "descending" } ], "deprecated": false }, "parameters": [] }, "/aged_receivables_report": { "get": { "operationId": "getAgedReceivablesReportItem", "tags": [ "AgedReceivablesReport" ], "responses": { "200": { "description": "AgedReceivablesReport resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AgedReceivablesReport" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/AgedReceivablesReport" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/AgedReceivablesReport" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/AgedReceivablesReport" } }, "text/html": { "schema": { "$ref": "#/components/schemas/AgedReceivablesReport" } } } }, "404": { "description": "Resource not found" } }, "summary": "Retrieves an aged receivables report", "description": "Retrieves a AgedReceivablesReport resource.", "parameters": [ { "name": "asOf", "in": "query", "description": "YYYY-MM-DD", "required": false, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string", "format": "date-time" }, "style": "form", "explode": false, "allowReserved": false, "example": "2022-08-31" }, { "name": "refresh", "in": "query", "description": "If refresh is set, data will be fetched from the source application even when cached data is available", "required": false, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "form", "explode": false, "allowReserved": false, "example": "true" }, { "name": "sort", "in": "query", "description": "Can be sorted by total amount in ascending or descending order, or alphabetically. Default is alphabetical.", "required": false, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string", "enum": [ "descending", "ascending", "alphabetical" ] }, "style": "form", "explode": false, "allowReserved": false, "example": "descending" } ], "deprecated": false }, "parameters": [] }, "/application_charges": { "get": { "operationId": "getApplicationChargeCollection", "tags": [ "ApplicationCharge" ], "responses": { "200": { "description": "ApplicationCharge collection", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ApplicationCharge" } } }, "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ApplicationCharge" } } }, "text/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ApplicationCharge" } } }, "text/csv": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ApplicationCharge" } } }, "text/html": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ApplicationCharge" } } } } } }, "summary": "Retrieves the collection of ApplicationCharge resources.", "description": "Retrieves the collection of ApplicationCharge resources.", "parameters": [ { "name": "page", "in": "query", "description": "The collection page number", "required": false, "deprecated": false, "allowEmptyValue": true, "schema": { "type": "integer", "default": 1 }, "style": "form", "explode": false, "allowReserved": false }, { "name": "itemsPerPage", "in": "query", "description": "The number of items per page", "required": false, "deprecated": false, "allowEmptyValue": true, "schema": { "type": "integer", "default": 100, "minimum": 0, "maximum": 200 }, "style": "form", "explode": false, "allowReserved": false } ], "deprecated": false }, "parameters": [] }, "/application_charges/{id}": { "get": { "operationId": "getApplicationChargeItem", "tags": [ "ApplicationCharge" ], "responses": { "200": { "description": "ApplicationCharge resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApplicationCharge" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApplicationCharge" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ApplicationCharge" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/ApplicationCharge" } }, "text/html": { "schema": { "$ref": "#/components/schemas/ApplicationCharge" } } } }, "404": { "description": "Resource not found" } }, "summary": "Retrieves a ApplicationCharge resource.", "description": "Retrieves a ApplicationCharge resource.", "parameters": [ { "name": "id", "in": "path", "description": "Resource identifier", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "deprecated": false }, "parameters": [] }, "/application_credits": { "get": { "operationId": "getApplicationCreditCollection", "tags": [ "ApplicationCredit" ], "responses": { "200": { "description": "ApplicationCredit collection", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ApplicationCredit" } } }, "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ApplicationCredit" } } }, "text/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ApplicationCredit" } } }, "text/csv": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ApplicationCredit" } } }, "text/html": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ApplicationCredit" } } } } } }, "summary": "Retrieves the collection of ApplicationCredit resources.", "description": "Retrieves the collection of ApplicationCredit resources.", "parameters": [ { "name": "page", "in": "query", "description": "The collection page number", "required": false, "deprecated": false, "allowEmptyValue": true, "schema": { "type": "integer", "default": 1 }, "style": "form", "explode": false, "allowReserved": false }, { "name": "itemsPerPage", "in": "query", "description": "The number of items per page", "required": false, "deprecated": false, "allowEmptyValue": true, "schema": { "type": "integer", "default": 100, "minimum": 0, "maximum": 200 }, "style": "form", "explode": false, "allowReserved": false } ], "deprecated": false }, "parameters": [] }, "/application_credits/{id}": { "get": { "operationId": "getApplicationCreditItem", "tags": [ "ApplicationCredit" ], "responses": { "200": { "description": "ApplicationCredit resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApplicationCredit" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApplicationCredit" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ApplicationCredit" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/ApplicationCredit" } }, "text/html": { "schema": { "$ref": "#/components/schemas/ApplicationCredit" } } } }, "404": { "description": "Resource not found" } }, "summary": "Retrieves a ApplicationCredit resource.", "description": "Retrieves a ApplicationCredit resource.", "parameters": [ { "name": "id", "in": "path", "description": "Resource identifier", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "deprecated": false }, "parameters": [] }, "/assets": { "get": { "operationId": "getAssetCollection", "tags": [ "Asset" ], "responses": { "200": { "description": "Asset collection", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Asset" } } }, "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Asset" } } }, "text/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Asset" } } }, "text/csv": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Asset" } } }, "text/html": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Asset" } } } } } }, "summary": "Retrieves the collection of Asset resources.", "description": "Retrieves the collection of Asset resources.", "parameters": [ { "name": "page", "in": "query", "description": "The collection page number", "required": false, "deprecated": false, "allowEmptyValue": true, "schema": { "type": "integer", "default": 1 }, "style": "form", "explode": false, "allowReserved": false }, { "name": "itemsPerPage", "in": "query", "description": "The number of items per page", "required": false, "deprecated": false, "allowEmptyValue": true, "schema": { "type": "integer", "default": 100, "minimum": 0, "maximum": 200 }, "style": "form", "explode": false, "allowReserved": false } ], "deprecated": false }, "parameters": [] }, "/assets/{id}": { "get": { "operationId": "getAssetItem", "tags": [ "Asset" ], "responses": { "200": { "description": "Asset resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Asset" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/Asset" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/Asset" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/Asset" } }, "text/html": { "schema": { "$ref": "#/components/schemas/Asset" } } } }, "404": { "description": "Resource not found" } }, "summary": "Retrieves a Asset resource.", "description": "Retrieves a Asset resource.", "parameters": [ { "name": "id", "in": "path", "description": "Resource identifier", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "deprecated": false }, "parameters": [] }, "/balance_histories": { "get": { "operationId": "getBalanceHistoryCollection", "tags": [ "BalanceHistory" ], "responses": { "200": { "description": "BalanceHistory collection", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BalanceHistory" } } }, "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BalanceHistory" } } }, "text/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BalanceHistory" } } }, "text/csv": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BalanceHistory" } } }, "text/html": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BalanceHistory" } } } } } }, "summary": "Retrieves the collection of BalanceHistory resources.", "description": "Retrieves the collection of BalanceHistory resources.", "parameters": [ { "name": "page", "in": "query", "description": "The collection page number", "required": false, "deprecated": false, "allowEmptyValue": true, "schema": { "type": "integer", "default": 1 }, "style": "form", "explode": false, "allowReserved": false }, { "name": "itemsPerPage", "in": "query", "description": "The number of items per page", "required": false, "deprecated": false, "allowEmptyValue": true, "schema": { "type": "integer", "default": 100, "minimum": 0, "maximum": 200 }, "style": "form", "explode": false, "allowReserved": false } ], "deprecated": false }, "parameters": [] }, "/balance_histories/{id}": { "get": { "operationId": "getBalanceHistoryItem", "tags": [ "BalanceHistory" ], "responses": { "200": { "description": "BalanceHistory resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BalanceHistory" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/BalanceHistory" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/BalanceHistory" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/BalanceHistory" } }, "text/html": { "schema": { "$ref": "#/components/schemas/BalanceHistory" } } } }, "404": { "description": "Resource not found" } }, "summary": "Retrieves a BalanceHistory resource.", "description": "Retrieves a BalanceHistory resource.", "parameters": [ { "name": "id", "in": "path", "description": "Resource identifier", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "deprecated": false }, "parameters": [] }, "/balance_sheet_excel": { "get": { "operationId": "getBalanceSheetExcelItem", "tags": [ "BalanceSheetExcel" ], "responses": { "200": { "description": "BalanceSheetExcel resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BalanceSheetExcel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/BalanceSheetExcel" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/BalanceSheetExcel" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/BalanceSheetExcel" } }, "text/html": { "schema": { "$ref": "#/components/schemas/BalanceSheetExcel" } } } }, "404": { "description": "Resource not found" } }, "summary": "Retrieves an excel workbook of a series of mapped balance sheets", "description": "Retrieves an excel workbook of a series of mapped balance sheets", "parameters": [ { "name": "start", "in": "query", "description": "YYYY-MM-DD", "required": false, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string", "format": "date-time" }, "style": "form", "explode": false, "allowReserved": false, "example": "2022-07-01" }, { "name": "end", "in": "query", "description": "YYYY-MM-DD", "required": false, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string", "format": "date-time" }, "style": "form", "explode": false, "allowReserved": false, "example": "2022-08-31" }, { "name": "refresh", "in": "query", "description": "If refresh is set, data will be fetched from the source application even when cached data is available", "required": false, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "form", "explode": false, "allowReserved": false, "example": "true" } ], "deprecated": false }, "parameters": [] }, "/balance_sheet_report": { "get": { "operationId": "getBalanceSheetReportItem", "tags": [ "BalanceSheetReport" ], "responses": { "200": { "description": "BalanceSheetReport resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BalanceSheetReport" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/BalanceSheetReport" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/BalanceSheetReport" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/BalanceSheetReport" } }, "text/html": { "schema": { "$ref": "#/components/schemas/BalanceSheetReport" } } } }, "404": { "description": "Resource not found" } }, "summary": "Retrieves a mapped balance sheet", "description": "Retrieves a mapped balance sheet", "parameters": [ { "name": "asOf", "in": "query", "description": "YYYY-MM-DD", "required": false, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string", "format": "date-time" }, "style": "form", "explode": false, "allowReserved": false, "example": "2022-08-31" }, { "name": "refresh", "in": "query", "description": "If refresh is set, data will be fetched from the source application even when cached data is available", "required": false, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "form", "explode": false, "allowReserved": false, "example": "true" } ], "deprecated": false }, "parameters": [] }, "/balance_sheets": { "get": { "operationId": "getBalanceSheetItem", "tags": [ "BalanceSheet" ], "responses": { "200": { "description": "BalanceSheet resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BalanceSheet" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/BalanceSheet" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/BalanceSheet" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/BalanceSheet" } }, "text/html": { "schema": { "$ref": "#/components/schemas/BalanceSheet" } } } }, "404": { "description": "Resource not found" } }, "summary": "Retrieves a BalanceSheet resource.", "description": "Retrieves a BalanceSheet resource.", "parameters": [ { "name": "end", "in": "query", "description": "YYYY-MM-DD", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string", "format": "date-time" }, "style": "form", "explode": false, "allowReserved": false, "example": "2022-11-30" }, { "name": "accounting_method", "in": "query", "description": "The Accounting Method", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string", "enum": [ "cash", "accrual" ] }, "style": "form", "explode": false, "allowReserved": false, "example": "accrual" } ], "deprecated": false }, "parameters": [] }, "/bank_accounts": { "get": { "operationId": "getBankAccountCollection", "tags": [ "BankAccount" ], "responses": { "200": { "description": "BankAccount collection", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BankAccount" } } }, "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BankAccount" } } }, "text/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BankAccount" } } }, "text/csv": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BankAccount" } } }, "text/html": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BankAccount" } } } } } }, "summary": "Retrieves the collection of BankAccount resources.", "description": "Retrieves the collection of BankAccount resources.", "parameters": [ { "name": "page", "in": "query", "description": "The collection page number", "required": false, "deprecated": false, "allowEmptyValue": true, "schema": { "type": "integer", "default": 1 }, "style": "form", "explode": false, "allowReserved": false }, { "name": "itemsPerPage", "in": "query", "description": "The number of items per page", "required": false, "deprecated": false, "allowEmptyValue": true, "schema": { "type": "integer", "default": 100, "minimum": 0, "maximum": 200 }, "style": "form", "explode": false, "allowReserved": false } ], "deprecated": false }, "parameters": [] }, "/bank_accounts/{id}": { "get": { "operationId": "getBankAccountItem", "tags": [ "BankAccount" ], "responses": { "200": { "description": "BankAccount resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BankAccount" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/BankAccount" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/BankAccount" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/BankAccount" } }, "text/html": { "schema": { "$ref": "#/components/schemas/BankAccount" } } } }, "404": { "description": "Resource not found" } }, "summary": "Retrieves a BankAccount resource.", "description": "Retrieves a BankAccount resource.", "parameters": [ { "name": "id", "in": "path", "description": "Resource identifier", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "deprecated": false }, "parameters": [] }, "/bank_opening_balances": { "get": { "operationId": "getBankOpeningBalanceCollection", "tags": [ "BankOpeningBalance" ], "responses": { "200": { "description": "BankOpeningBalance collection", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BankOpeningBalance" } } }, "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BankOpeningBalance" } } }, "text/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BankOpeningBalance" } } }, "text/csv": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BankOpeningBalance" } } }, "text/html": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BankOpeningBalance" } } } } } }, "summary": "Retrieves the collection of BankOpeningBalance resources.", "description": "Retrieves the collection of BankOpeningBalance resources.", "parameters": [ { "name": "page", "in": "query", "description": "The collection page number", "required": false, "deprecated": false, "allowEmptyValue": true, "schema": { "type": "integer", "default": 1 }, "style": "form", "explode": false, "allowReserved": false }, { "name": "itemsPerPage", "in": "query", "description": "The number of items per page", "required": false, "deprecated": false, "allowEmptyValue": true, "schema": { "type": "integer", "default": 100, "minimum": 0, "maximum": 200 }, "style": "form", "explode": false, "allowReserved": false } ], "deprecated": false }, "parameters": [] }, "/bank_opening_balances/{id}": { "get": { "operationId": "getBankOpeningBalanceItem", "tags": [ "BankOpeningBalance" ], "responses": { "200": { "description": "BankOpeningBalance resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BankOpeningBalance" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/BankOpeningBalance" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/BankOpeningBalance" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/BankOpeningBalance" } }, "text/html": { "schema": { "$ref": "#/components/schemas/BankOpeningBalance" } } } }, "404": { "description": "Resource not found" } }, "summary": "Retrieves a BankOpeningBalance resource.", "description": "Retrieves a BankOpeningBalance resource.", "parameters": [ { "name": "id", "in": "path", "description": "Resource identifier", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "deprecated": false }, "parameters": [] }, "/bank_reconciliations": { "get": { "operationId": "getBankReconciliationCollection", "tags": [ "BankReconciliation" ], "responses": { "200": { "description": "BankReconciliation collection", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BankReconciliation" } } }, "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BankReconciliation" } } }, "text/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BankReconciliation" } } }, "text/csv": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BankReconciliation" } } }, "text/html": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BankReconciliation" } } } } } }, "summary": "Retrieves the collection of BankReconciliation resources.", "description": "Retrieves the collection of BankReconciliation resources.", "parameters": [ { "name": "page", "in": "query", "description": "The collection page number", "required": false, "deprecated": false, "allowEmptyValue": true, "schema": { "type": "integer", "default": 1 }, "style": "form", "explode": false, "allowReserved": false }, { "name": "itemsPerPage", "in": "query", "description": "The number of items per page", "required": false, "deprecated": false, "allowEmptyValue": true, "schema": { "type": "integer", "default": 100, "minimum": 0, "maximum": 200 }, "style": "form", "explode": false, "allowReserved": false } ], "deprecated": false }, "parameters": [] }, "/bank_reconciliations/{id}": { "get": { "operationId": "getBankReconciliationItem", "tags": [ "BankReconciliation" ], "responses": { "200": { "description": "BankReconciliation resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BankReconciliation" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/BankReconciliation" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/BankReconciliation" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/BankReconciliation" } }, "text/html": { "schema": { "$ref": "#/components/schemas/BankReconciliation" } } } }, "404": { "description": "Resource not found" } }, "summary": "Retrieves a BankReconciliation resource.", "description": "Retrieves a BankReconciliation resource.", "parameters": [ { "name": "id", "in": "path", "description": "Resource identifier", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "deprecated": false }, "parameters": [] }, "/bank_summaries": { "get": { "operationId": "getBankSummaryCollection", "tags": [ "BankSummary" ], "responses": { "200": { "description": "BankSummary collection", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BankSummary" } } }, "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BankSummary" } } }, "text/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BankSummary" } } }, "text/csv": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BankSummary" } } }, "text/html": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BankSummary" } } } } } }, "summary": "Retrieves the collection of BankSummary resources.", "description": "Retrieves the collection of BankSummary resources.", "parameters": [ { "name": "page", "in": "query", "description": "The collection page number", "required": false, "deprecated": false, "allowEmptyValue": true, "schema": { "type": "integer", "default": 1 }, "style": "form", "explode": false, "allowReserved": false }, { "name": "itemsPerPage", "in": "query", "description": "The number of items per page", "required": false, "deprecated": false, "allowEmptyValue": true, "schema": { "type": "integer", "default": 100, "minimum": 0, "maximum": 200 }, "style": "form", "explode": false, "allowReserved": false } ], "deprecated": false }, "parameters": [] }, "/bank_summaries/{id}": { "get": { "operationId": "getBankSummaryItem", "tags": [ "BankSummary" ], "responses": { "200": { "description": "BankSummary resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BankSummary" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/BankSummary" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/BankSummary" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/BankSummary" } }, "text/html": { "schema": { "$ref": "#/components/schemas/BankSummary" } } } }, "404": { "description": "Resource not found" } }, "summary": "Retrieves a BankSummary resource.", "description": "Retrieves a BankSummary resource.", "parameters": [ { "name": "id", "in": "path", "description": "Resource identifier", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "deprecated": false }, "parameters": [] }, "/bank_transactions": { "get": { "operationId": "getBankTransactionCollection", "tags": [ "BankTransaction" ], "responses": { "200": { "description": "BankTransaction collection", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BankTransaction" } } }, "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BankTransaction" } } }, "text/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BankTransaction" } } }, "text/csv": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BankTransaction" } } }, "text/html": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BankTransaction" } } } } } }, "summary": "Retrieves the collection of BankTransaction resources.", "description": "Retrieves the collection of BankTransaction resources.", "parameters": [ { "name": "page", "in": "query", "description": "The collection page number", "required": false, "deprecated": false, "allowEmptyValue": true, "schema": { "type": "integer", "default": 1 }, "style": "form", "explode": false, "allowReserved": false }, { "name": "itemsPerPage", "in": "query", "description": "The number of items per page", "required": false, "deprecated": false, "allowEmptyValue": true, "schema": { "type": "integer", "default": 100, "minimum": 0, "maximum": 200 }, "style": "form", "explode": false, "allowReserved": false } ], "deprecated": false }, "parameters": [] }, "/bank_transactions/{id}": { "get": { "operationId": "getBankTransactionItem", "tags": [ "BankTransaction" ], "responses": { "200": { "description": "BankTransaction resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BankTransaction" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/BankTransaction" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/BankTransaction" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/BankTransaction" } }, "text/html": { "schema": { "$ref": "#/components/schemas/BankTransaction" } } } }, "404": { "description": "Resource not found" } }, "summary": "Retrieves a BankTransaction resource.", "description": "Retrieves a BankTransaction resource.", "parameters": [ { "name": "id", "in": "path", "description": "Resource identifier", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "deprecated": false }, "parameters": [] }, "/bank_transfers": { "get": { "operationId": "getBankTransferCollection", "tags": [ "BankTransfer" ], "responses": { "200": { "description": "BankTransfer collection", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BankTransfer" } } }, "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BankTransfer" } } }, "text/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BankTransfer" } } }, "text/csv": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BankTransfer" } } }, "text/html": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BankTransfer" } } } } } }, "summary": "Retrieves the collection of BankTransfer resources.", "description": "Retrieves the collection of BankTransfer resources.", "parameters": [ { "name": "page", "in": "query", "description": "The collection page number", "required": false, "deprecated": false, "allowEmptyValue": true, "schema": { "type": "integer", "default": 1 }, "style": "form", "explode": false, "allowReserved": false }, { "name": "itemsPerPage", "in": "query", "description": "The number of items per page", "required": false, "deprecated": false, "allowEmptyValue": true, "schema": { "type": "integer", "default": 100, "minimum": 0, "maximum": 200 }, "style": "form", "explode": false, "allowReserved": false } ], "deprecated": false }, "parameters": [] }, "/bank_transfers/{id}": { "get": { "operationId": "getBankTransferItem", "tags": [ "BankTransfer" ], "responses": { "200": { "description": "BankTransfer resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BankTransfer" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/BankTransfer" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/BankTransfer" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/BankTransfer" } }, "text/html": { "schema": { "$ref": "#/components/schemas/BankTransfer" } } } }, "404": { "description": "Resource not found" } }, "summary": "Retrieves a BankTransfer resource.", "description": "Retrieves a BankTransfer resource.", "parameters": [ { "name": "id", "in": "path", "description": "Resource identifier", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "deprecated": false }, "parameters": [] }, "/batch_payments": { "get": { "operationId": "getBatchPaymentCollection", "tags": [ "BatchPayment" ], "responses": { "200": { "description": "BatchPayment collection", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BatchPayment" } } }, "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BatchPayment" } } }, "text/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BatchPayment" } } }, "text/csv": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BatchPayment" } } }, "text/html": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BatchPayment" } } } } } }, "summary": "Retrieves the collection of BatchPayment resources.", "description": "Retrieves the collection of BatchPayment resources.", "parameters": [ { "name": "page", "in": "query", "description": "The collection page number", "required": false, "deprecated": false, "allowEmptyValue": true, "schema": { "type": "integer", "default": 1 }, "style": "form", "explode": false, "allowReserved": false }, { "name": "itemsPerPage", "in": "query", "description": "The number of items per page", "required": false, "deprecated": false, "allowEmptyValue": true, "schema": { "type": "integer", "default": 100, "minimum": 0, "maximum": 200 }, "style": "form", "explode": false, "allowReserved": false } ], "deprecated": false }, "parameters": [] }, "/batch_payments/{id}": { "get": { "operationId": "getBatchPaymentItem", "tags": [ "BatchPayment" ], "responses": { "200": { "description": "BatchPayment resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BatchPayment" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/BatchPayment" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/BatchPayment" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/BatchPayment" } }, "text/html": { "schema": { "$ref": "#/components/schemas/BatchPayment" } } } }, "404": { "description": "Resource not found" } }, "summary": "Retrieves a BatchPayment resource.", "description": "Retrieves a BatchPayment resource.", "parameters": [ { "name": "id", "in": "path", "description": "Resource identifier", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "deprecated": false }, "parameters": [] }, "/bill_payments": { "get": { "operationId": "getBillPaymentCollection", "tags": [ "BillPayment" ], "responses": { "200": { "description": "BillPayment collection", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BillPayment" } } }, "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BillPayment" } } }, "text/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BillPayment" } } }, "text/csv": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BillPayment" } } }, "text/html": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BillPayment" } } } } } }, "summary": "Retrieves the collection of BillPayment resources.", "description": "Retrieves the collection of BillPayment resources.", "parameters": [ { "name": "page", "in": "query", "description": "The collection page number", "required": false, "deprecated": false, "allowEmptyValue": true, "schema": { "type": "integer", "default": 1 }, "style": "form", "explode": false, "allowReserved": false }, { "name": "itemsPerPage", "in": "query", "description": "The number of items per page", "required": false, "deprecated": false, "allowEmptyValue": true, "schema": { "type": "integer", "default": 100, "minimum": 0, "maximum": 200 }, "style": "form", "explode": false, "allowReserved": false } ], "deprecated": false }, "post": { "operationId": "postBillPaymentCollection", "tags": [ "BillPayment" ], "responses": { "201": { "description": "BillPayment resource created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BillPayment" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/BillPayment" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/BillPayment" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/BillPayment" } }, "text/html": { "schema": { "$ref": "#/components/schemas/BillPayment" } } }, "links": { "GetBillPaymentItem": { "operationId": "getBillPaymentItem", "parameters": { "id": "$response.body#/id" }, "description": "The `id` value returned in the response can be used as the `id` parameter in `GET /bill_payments/{id}`." } } }, "400": { "description": "Invalid input" }, "422": { "description": "Unprocessable entity" } }, "summary": "Creates a BillPayment resource.", "description": "Creates a BillPayment resource.", "parameters": [], "requestBody": { "description": "The new BillPayment resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BillPayment" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/BillPayment" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/BillPayment" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/BillPayment" } }, "text/html": { "schema": { "$ref": "#/components/schemas/BillPayment" } } }, "required": true }, "deprecated": false }, "parameters": [] }, "/bill_payments/{id}": { "get": { "operationId": "getBillPaymentItem", "tags": [ "BillPayment" ], "responses": { "200": { "description": "BillPayment resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BillPayment" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/BillPayment" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/BillPayment" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/BillPayment" } }, "text/html": { "schema": { "$ref": "#/components/schemas/BillPayment" } } } }, "404": { "description": "Resource not found" } }, "summary": "Retrieves a BillPayment resource.", "description": "Retrieves a BillPayment resource.", "parameters": [ { "name": "id", "in": "path", "description": "Resource identifier", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "deprecated": false }, "put": { "operationId": "putBillPaymentItem", "tags": [ "BillPayment" ], "responses": { "200": { "description": "BillPayment resource updated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BillPayment" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/BillPayment" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/BillPayment" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/BillPayment" } }, "text/html": { "schema": { "$ref": "#/components/schemas/BillPayment" } } }, "links": { "GetBillPaymentItem": { "operationId": "getBillPaymentItem", "parameters": { "id": "$response.body#/id" }, "description": "The `id` value returned in the response can be used as the `id` parameter in `GET /bill_payments/{id}`." } } }, "400": { "description": "Invalid input" }, "422": { "description": "Unprocessable entity" }, "404": { "description": "Resource not found" } }, "summary": "Replaces the BillPayment resource.", "description": "Replaces the BillPayment resource.", "parameters": [ { "name": "id", "in": "path", "description": "Resource identifier", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "requestBody": { "description": "The updated BillPayment resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BillPayment" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/BillPayment" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/BillPayment" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/BillPayment" } }, "text/html": { "schema": { "$ref": "#/components/schemas/BillPayment" } } }, "required": true }, "deprecated": false }, "delete": { "operationId": "deleteBillPaymentItem", "tags": [ "BillPayment" ], "responses": { "204": { "description": "BillPayment resource deleted" }, "404": { "description": "Resource not found" } }, "summary": "Removes the BillPayment resource.", "description": "Removes the BillPayment resource.", "parameters": [ { "name": "id", "in": "path", "description": "Resource identifier", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "deprecated": false }, "parameters": [] }, "/bills": { "get": { "operationId": "getBillCollection", "tags": [ "Bill" ], "responses": { "200": { "description": "Bill collection", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Bill" } } }, "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Bill" } } }, "text/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Bill" } } }, "text/csv": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Bill" } } }, "text/html": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Bill" } } } } } }, "summary": "Retrieves the collection of Bill resources.", "description": "Retrieves the collection of Bill resources.", "parameters": [ { "name": "page", "in": "query", "description": "The collection page number", "required": false, "deprecated": false, "allowEmptyValue": true, "schema": { "type": "integer", "default": 1 }, "style": "form", "explode": false, "allowReserved": false }, { "name": "itemsPerPage", "in": "query", "description": "The number of items per page", "required": false, "deprecated": false, "allowEmptyValue": true, "schema": { "type": "integer", "default": 100, "minimum": 0, "maximum": 200 }, "style": "form", "explode": false, "allowReserved": false } ], "deprecated": false }, "post": { "operationId": "postBillCollection", "tags": [ "Bill" ], "responses": { "201": { "description": "Bill resource created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Bill" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/Bill" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/Bill" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/Bill" } }, "text/html": { "schema": { "$ref": "#/components/schemas/Bill" } } }, "links": { "GetBillItem": { "operationId": "getBillItem", "parameters": { "id": "$response.body#/id" }, "description": "The `id` value returned in the response can be used as the `id` parameter in `GET /bills/{id}`." } } }, "400": { "description": "Invalid input" }, "422": { "description": "Unprocessable entity" } }, "summary": "Creates a Bill resource.", "description": "Creates a Bill resource.", "parameters": [], "requestBody": { "description": "The new Bill resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Bill" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/Bill" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/Bill" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/Bill" } }, "text/html": { "schema": { "$ref": "#/components/schemas/Bill" } } }, "required": true }, "deprecated": false }, "parameters": [] }, "/bills/{id}": { "get": { "operationId": "getBillItem", "tags": [ "Bill" ], "responses": { "200": { "description": "Bill resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Bill" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/Bill" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/Bill" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/Bill" } }, "text/html": { "schema": { "$ref": "#/components/schemas/Bill" } } } }, "404": { "description": "Resource not found" } }, "summary": "Retrieves a Bill resource.", "description": "Retrieves a Bill resource.", "parameters": [ { "name": "id", "in": "path", "description": "Resource identifier", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "deprecated": false }, "put": { "operationId": "putBillItem", "tags": [ "Bill" ], "responses": { "200": { "description": "Bill resource updated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Bill" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/Bill" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/Bill" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/Bill" } }, "text/html": { "schema": { "$ref": "#/components/schemas/Bill" } } }, "links": { "GetBillItem": { "operationId": "getBillItem", "parameters": { "id": "$response.body#/id" }, "description": "The `id` value returned in the response can be used as the `id` parameter in `GET /bills/{id}`." } } }, "400": { "description": "Invalid input" }, "422": { "description": "Unprocessable entity" }, "404": { "description": "Resource not found" } }, "summary": "Replaces the Bill resource.", "description": "Replaces the Bill resource.", "parameters": [ { "name": "id", "in": "path", "description": "Resource identifier", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "requestBody": { "description": "The updated Bill resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Bill" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/Bill" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/Bill" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/Bill" } }, "text/html": { "schema": { "$ref": "#/components/schemas/Bill" } } }, "required": true }, "deprecated": false }, "delete": { "operationId": "deleteBillItem", "tags": [ "Bill" ], "responses": { "204": { "description": "Bill resource deleted" }, "404": { "description": "Resource not found" } }, "summary": "Removes the Bill resource.", "description": "Removes the Bill resource.", "parameters": [ { "name": "id", "in": "path", "description": "Resource identifier", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "deprecated": false }, "parameters": [] }, "/blog_postings": { "get": { "operationId": "getBlogPostingCollection", "tags": [ "BlogPosting" ], "responses": { "200": { "description": "BlogPosting collection", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BlogPosting" } } }, "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BlogPosting" } } }, "text/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BlogPosting" } } }, "text/csv": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BlogPosting" } } }, "text/html": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BlogPosting" } } } } } }, "summary": "Retrieves the collection of BlogPosting resources.", "description": "Retrieves the collection of BlogPosting resources.", "parameters": [ { "name": "page", "in": "query", "description": "The collection page number", "required": false, "deprecated": false, "allowEmptyValue": true, "schema": { "type": "integer", "default": 1 }, "style": "form", "explode": false, "allowReserved": false }, { "name": "itemsPerPage", "in": "query", "description": "The number of items per page", "required": false, "deprecated": false, "allowEmptyValue": true, "schema": { "type": "integer", "default": 100, "minimum": 0, "maximum": 200 }, "style": "form", "explode": false, "allowReserved": false } ], "deprecated": false }, "parameters": [] }, "/blog_postings/{id}": { "get": { "operationId": "getBlogPostingItem", "tags": [ "BlogPosting" ], "responses": { "200": { "description": "BlogPosting resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BlogPosting" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/BlogPosting" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/BlogPosting" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/BlogPosting" } }, "text/html": { "schema": { "$ref": "#/components/schemas/BlogPosting" } } } }, "404": { "description": "Resource not found" } }, "summary": "Retrieves a BlogPosting resource.", "description": "Retrieves a BlogPosting resource.", "parameters": [ { "name": "id", "in": "path", "description": "Resource identifier", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "deprecated": false }, "parameters": [] }, "/blogs": { "get": { "operationId": "getBlogCollection", "tags": [ "Blog" ], "responses": { "200": { "description": "Blog collection", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Blog" } } }, "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Blog" } } }, "text/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Blog" } } }, "text/csv": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Blog" } } }, "text/html": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Blog" } } } } } }, "summary": "Retrieves the collection of Blog resources.", "description": "Retrieves the collection of Blog resources.", "parameters": [ { "name": "page", "in": "query", "description": "The collection page number", "required": false, "deprecated": false, "allowEmptyValue": true, "schema": { "type": "integer", "default": 1 }, "style": "form", "explode": false, "allowReserved": false }, { "name": "itemsPerPage", "in": "query", "description": "The number of items per page", "required": false, "deprecated": false, "allowEmptyValue": true, "schema": { "type": "integer", "default": 100, "minimum": 0, "maximum": 200 }, "style": "form", "explode": false, "allowReserved": false } ], "deprecated": false }, "parameters": [] }, "/blogs/{id}": { "get": { "operationId": "getBlogItem", "tags": [ "Blog" ], "responses": { "200": { "description": "Blog resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Blog" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/Blog" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/Blog" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/Blog" } }, "text/html": { "schema": { "$ref": "#/components/schemas/Blog" } } } }, "404": { "description": "Resource not found" } }, "summary": "Retrieves a Blog resource.", "description": "Retrieves a Blog resource.", "parameters": [ { "name": "id", "in": "path", "description": "Resource identifier", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "deprecated": false }, "parameters": [] }, "/budget_summaries/{id}": { "get": { "operationId": "getBudgetSummaryItem", "tags": [ "BudgetSummary" ], "responses": { "200": { "description": "BudgetSummary resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BudgetSummary" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/BudgetSummary" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/BudgetSummary" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/BudgetSummary" } }, "text/html": { "schema": { "$ref": "#/components/schemas/BudgetSummary" } } } }, "404": { "description": "Resource not found" } }, "summary": "Retrieves a BudgetSummary resource.", "description": "Retrieves a BudgetSummary resource.", "parameters": [ { "name": "id", "in": "path", "description": "Resource identifier", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "deprecated": false }, "parameters": [] }, "/budget_summary": { "get": { "operationId": "getBudgetSummaryCollection", "tags": [ "BudgetSummary" ], "responses": { "200": { "description": "BudgetSummary collection", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BudgetSummary" } } }, "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BudgetSummary" } } }, "text/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BudgetSummary" } } }, "text/csv": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BudgetSummary" } } }, "text/html": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BudgetSummary" } } } } } }, "summary": "Retrieves the collection of BudgetSummary resources.", "description": "Retrieves the collection of BudgetSummary resources.", "parameters": [ { "name": "page", "in": "query", "description": "The collection page number", "required": false, "deprecated": false, "allowEmptyValue": true, "schema": { "type": "integer", "default": 1 }, "style": "form", "explode": false, "allowReserved": false }, { "name": "itemsPerPage", "in": "query", "description": "The number of items per page", "required": false, "deprecated": false, "allowEmptyValue": true, "schema": { "type": "integer", "default": 100, "minimum": 0, "maximum": 200 }, "style": "form", "explode": false, "allowReserved": false } ], "deprecated": false }, "parameters": [] }, "/calls": { "get": { "operationId": "getCallCollection", "tags": [ "Call" ], "responses": { "200": { "description": "Call collection", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Call" } } }, "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Call" } } }, "text/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Call" } } }, "text/csv": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Call" } } }, "text/html": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Call" } } } } } }, "summary": "Retrieves the collection of Call resources.", "description": "Retrieves the collection of Call resources.", "parameters": [ { "name": "page", "in": "query", "description": "The collection page number", "required": false, "deprecated": false, "allowEmptyValue": true, "schema": { "type": "integer", "default": 1 }, "style": "form", "explode": false, "allowReserved": false }, { "name": "itemsPerPage", "in": "query", "description": "The number of items per page", "required": false, "deprecated": false, "allowEmptyValue": true, "schema": { "type": "integer", "default": 100, "minimum": 0, "maximum": 200 }, "style": "form", "explode": false, "allowReserved": false } ], "deprecated": false }, "parameters": [] }, "/calls/{id}": { "get": { "operationId": "getCallItem", "tags": [ "Call" ], "responses": { "200": { "description": "Call resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Call" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/Call" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/Call" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/Call" } }, "text/html": { "schema": { "$ref": "#/components/schemas/Call" } } } }, "404": { "description": "Resource not found" } }, "summary": "Retrieves a Call resource.", "description": "Retrieves a Call resource.", "parameters": [ { "name": "id", "in": "path", "description": "Resource identifier", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "deprecated": false }, "parameters": [] }, "/campaign_reports": { "get": { "operationId": "getCampaignReportCollection", "tags": [ "CampaignReport" ], "responses": { "200": { "description": "CampaignReport collection", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CampaignReport" } } }, "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CampaignReport" } } }, "text/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CampaignReport" } } }, "text/csv": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CampaignReport" } } }, "text/html": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CampaignReport" } } } } } }, "summary": "Retrieves the collection of CampaignReport resources.", "description": "Retrieves the collection of CampaignReport resources.", "parameters": [ { "name": "page", "in": "query", "description": "The collection page number", "required": false, "deprecated": false, "allowEmptyValue": true, "schema": { "type": "integer", "default": 1 }, "style": "form", "explode": false, "allowReserved": false }, { "name": "itemsPerPage", "in": "query", "description": "The number of items per page", "required": false, "deprecated": false, "allowEmptyValue": true, "schema": { "type": "integer", "default": 100, "minimum": 0, "maximum": 200 }, "style": "form", "explode": false, "allowReserved": false } ], "deprecated": false }, "parameters": [] }, "/campaign_reports/{id}": { "get": { "operationId": "getCampaignReportItem", "tags": [ "CampaignReport" ], "responses": { "200": { "description": "CampaignReport resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CampaignReport" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/CampaignReport" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/CampaignReport" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CampaignReport" } }, "text/html": { "schema": { "$ref": "#/components/schemas/CampaignReport" } } } }, "404": { "description": "Resource not found" } }, "summary": "Retrieves a CampaignReport resource.", "description": "Retrieves a CampaignReport resource.", "parameters": [ { "name": "id", "in": "path", "description": "Resource identifier", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "deprecated": false }, "parameters": [] }, "/campaigns": { "get": { "operationId": "getCampaignCollection", "tags": [ "Campaign" ], "responses": { "200": { "description": "Campaign collection", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Campaign" } } }, "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Campaign" } } }, "text/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Campaign" } } }, "text/csv": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Campaign" } } }, "text/html": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Campaign" } } } } } }, "summary": "Retrieves the collection of Campaign resources.", "description": "Retrieves the collection of Campaign resources.", "parameters": [ { "name": "page", "in": "query", "description": "The collection page number", "required": false, "deprecated": false, "allowEmptyValue": true, "schema": { "type": "integer", "default": 1 }, "style": "form", "explode": false, "allowReserved": false }, { "name": "itemsPerPage", "in": "query", "description": "The number of items per page", "required": false, "deprecated": false, "allowEmptyValue": true, "schema": { "type": "integer", "default": 100, "minimum": 0, "maximum": 200 }, "style": "form", "explode": false, "allowReserved": false } ], "deprecated": false }, "parameters": [] }, "/campaigns/{id}": { "get": { "operationId": "getCampaignItem", "tags": [ "Campaign" ], "responses": { "200": { "description": "Campaign resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Campaign" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/Campaign" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/Campaign" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/Campaign" } }, "text/html": { "schema": { "$ref": "#/components/schemas/Campaign" } } } }, "404": { "description": "Resource not found" } }, "summary": "Retrieves a Campaign resource.", "description": "Retrieves a Campaign resource.", "parameters": [ { "name": "id", "in": "path", "description": "Resource identifier", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "deprecated": false }, "parameters": [] }, "/charges": { "get": { "operationId": "getChargeCollection", "tags": [ "Charge" ], "responses": { "200": { "description": "Charge collection", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Charge" } } }, "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Charge" } } }, "text/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Charge" } } }, "text/csv": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Charge" } } }, "text/html": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Charge" } } } } } }, "summary": "Retrieves the collection of Charge resources.", "description": "Retrieves the collection of Charge resources.", "parameters": [ { "name": "page", "in": "query", "description": "The collection page number", "required": false, "deprecated": false, "allowEmptyValue": true, "schema": { "type": "integer", "default": 1 }, "style": "form", "explode": false, "allowReserved": false }, { "name": "itemsPerPage", "in": "query", "description": "The number of items per page", "required": false, "deprecated": false, "allowEmptyValue": true, "schema": { "type": "integer", "default": 100, "minimum": 0, "maximum": 200 }, "style": "form", "explode": false, "allowReserved": false } ], "deprecated": false }, "parameters": [] }, "/charges/{id}": { "get": { "operationId": "getChargeItem", "tags": [ "Charge" ], "responses": { "200": { "description": "Charge resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Charge" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/Charge" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/Charge" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/Charge" } }, "text/html": { "schema": { "$ref": "#/components/schemas/Charge" } } } }, "404": { "description": "Resource not found" } }, "summary": "Retrieves a Charge resource.", "description": "Retrieves a Charge resource.", "parameters": [ { "name": "id", "in": "path", "description": "Resource identifier", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "deprecated": false }, "parameters": [] }, "/clients": { "get": { "operationId": "getClientCollection", "tags": [ "Client" ], "responses": { "200": { "description": "Client collection", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Client" } } }, "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Client" } } }, "text/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Client" } } }, "text/csv": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Client" } } }, "text/html": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Client" } } } } } }, "summary": "Retrieves the collection of Client resources.", "description": "Retrieves the collection of Client resources.", "parameters": [ { "name": "page", "in": "query", "description": "The collection page number", "required": false, "deprecated": false, "allowEmptyValue": true, "schema": { "type": "integer", "default": 1 }, "style": "form", "explode": false, "allowReserved": false }, { "name": "itemsPerPage", "in": "query", "description": "The number of items per page", "required": false, "deprecated": false, "allowEmptyValue": true, "schema": { "type": "integer", "default": 100, "minimum": 0, "maximum": 200 }, "style": "form", "explode": false, "allowReserved": false } ], "deprecated": false }, "parameters": [] }, "/clients/{id}": { "get": { "operationId": "getClientItem", "tags": [ "Client" ], "responses": { "200": { "description": "Client resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Client" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/Client" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/Client" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/Client" } }, "text/html": { "schema": { "$ref": "#/components/schemas/Client" } } } }, "404": { "description": "Resource not found" } }, "summary": "Retrieves a Client resource.", "description": "Retrieves a Client resource.", "parameters": [ { "name": "id", "in": "path", "description": "Resource identifier", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "deprecated": false }, "parameters": [] }, "/companies": { "get": { "operationId": "getCompanyCollection", "tags": [ "Company" ], "responses": { "200": { "description": "Company collection", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Company" } } }, "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Company" } } }, "text/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Company" } } }, "text/csv": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Company" } } }, "text/html": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Company" } } } } } }, "summary": "Retrieves the collection of Company resources.", "description": "Retrieves the collection of Company resources.", "parameters": [ { "name": "page", "in": "query", "description": "The collection page number", "required": false, "deprecated": false, "allowEmptyValue": true, "schema": { "type": "integer", "default": 1 }, "style": "form", "explode": false, "allowReserved": false }, { "name": "itemsPerPage", "in": "query", "description": "The number of items per page", "required": false, "deprecated": false, "allowEmptyValue": true, "schema": { "type": "integer", "default": 100, "minimum": 0, "maximum": 200 }, "style": "form", "explode": false, "allowReserved": false } ], "deprecated": false }, "parameters": [] }, "/companies/{id}": { "get": { "operationId": "getCompanyItem", "tags": [ "Company" ], "responses": { "200": { "description": "Company resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Company" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/Company" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/Company" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/Company" } }, "text/html": { "schema": { "$ref": "#/components/schemas/Company" } } } }, "404": { "description": "Resource not found" } }, "summary": "Retrieves a Company resource.", "description": "Retrieves a Company resource.", "parameters": [ { "name": "id", "in": "path", "description": "Resource identifier", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "deprecated": false }, "parameters": [] }, "/contact_groups": { "get": { "operationId": "getContactGroupCollection", "tags": [ "ContactGroup" ], "responses": { "200": { "description": "ContactGroup collection", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ContactGroup" } } }, "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ContactGroup" } } }, "text/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ContactGroup" } } }, "text/csv": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ContactGroup" } } }, "text/html": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ContactGroup" } } } } } }, "summary": "Retrieves the collection of ContactGroup resources.", "description": "Retrieves the collection of ContactGroup resources.", "parameters": [ { "name": "page", "in": "query", "description": "The collection page number", "required": false, "deprecated": false, "allowEmptyValue": true, "schema": { "type": "integer", "default": 1 }, "style": "form", "explode": false, "allowReserved": false }, { "name": "itemsPerPage", "in": "query", "description": "The number of items per page", "required": false, "deprecated": false, "allowEmptyValue": true, "schema": { "type": "integer", "default": 100, "minimum": 0, "maximum": 200 }, "style": "form", "explode": false, "allowReserved": false } ], "deprecated": false }, "parameters": [] }, "/contact_groups/{id}": { "get": { "operationId": "getContactGroupItem", "tags": [ "ContactGroup" ], "responses": { "200": { "description": "ContactGroup resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContactGroup" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ContactGroup" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ContactGroup" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/ContactGroup" } }, "text/html": { "schema": { "$ref": "#/components/schemas/ContactGroup" } } } }, "404": { "description": "Resource not found" } }, "summary": "Retrieves a ContactGroup resource.", "description": "Retrieves a ContactGroup resource.", "parameters": [ { "name": "id", "in": "path", "description": "Resource identifier", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "deprecated": false }, "parameters": [] }, "/contracts": { "get": { "operationId": "getContractCollection", "tags": [ "Contract" ], "responses": { "200": { "description": "Contract collection", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Contract" } } }, "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Contract" } } }, "text/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Contract" } } }, "text/csv": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Contract" } } }, "text/html": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Contract" } } } } } }, "summary": "Retrieves the collection of Contract resources.", "description": "Retrieves the collection of Contract resources.", "parameters": [ { "name": "page", "in": "query", "description": "The collection page number", "required": false, "deprecated": false, "allowEmptyValue": true, "schema": { "type": "integer", "default": 1 }, "style": "form", "explode": false, "allowReserved": false }, { "name": "itemsPerPage", "in": "query", "description": "The number of items per page", "required": false, "deprecated": false, "allowEmptyValue": true, "schema": { "type": "integer", "default": 100, "minimum": 0, "maximum": 200 }, "style": "form", "explode": false, "allowReserved": false } ], "deprecated": false }, "parameters": [] }, "/contracts/{id}": { "get": { "operationId": "getContractItem", "tags": [ "Contract" ], "responses": { "200": { "description": "Contract resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Contract" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/Contract" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/Contract" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/Contract" } }, "text/html": { "schema": { "$ref": "#/components/schemas/Contract" } } } }, "404": { "description": "Resource not found" } }, "summary": "Retrieves a Contract resource.", "description": "Retrieves a Contract resource.", "parameters": [ { "name": "id", "in": "path", "description": "Resource identifier", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "deprecated": false }, "parameters": [] }, "/conversion": { "get": { "operationId": "getConversionCollection", "tags": [ "Conversion" ], "responses": { "200": { "description": "Conversion collection", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Conversion" } } }, "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Conversion" } } }, "text/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Conversion" } } }, "text/csv": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Conversion" } } }, "text/html": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Conversion" } } } } } }, "summary": "list converted documents", "description": "Retrieves the collection of Conversion resources.", "parameters": [ { "name": "page", "in": "query", "description": "The collection page number", "required": false, "deprecated": false, "allowEmptyValue": true, "schema": { "type": "integer", "default": 1 }, "style": "form", "explode": false, "allowReserved": false }, { "name": "itemsPerPage", "in": "query", "description": "The number of items per page", "required": false, "deprecated": false, "allowEmptyValue": true, "schema": { "type": "integer", "default": 100, "minimum": 0, "maximum": 200 }, "style": "form", "explode": false, "allowReserved": false } ], "deprecated": false }, "post": { "operationId": "postConversionCollection", "tags": [ "Conversion" ], "responses": { "201": { "description": "Conversion resource created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Conversion" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/Conversion" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/Conversion" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/Conversion" } }, "text/html": { "schema": { "$ref": "#/components/schemas/Conversion" } } }, "links": { "GetConversionItem": { "operationId": "getConversionItem", "parameters": {}, "description": "The values returned in the response can be used in `GET /conversion/{id}`." } } }, "400": { "description": "Invalid input" }, "422": { "description": "Unprocessable entity" } }, "summary": "Converts a document from one format to another", "description": "Creates a Conversion resource.", "parameters": [], "requestBody": { "description": "The new Conversion resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Conversion" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/Conversion" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/Conversion" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/Conversion" } }, "text/html": { "schema": { "$ref": "#/components/schemas/Conversion" } } }, "required": true }, "deprecated": false }, "parameters": [] }, "/conversion/{id}": { "get": { "operationId": "getConversionItem", "tags": [ "Conversion" ], "responses": { "200": { "description": "Conversion resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Conversion" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/Conversion" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/Conversion" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/Conversion" } }, "text/html": { "schema": { "$ref": "#/components/schemas/Conversion" } } } }, "404": { "description": "Resource not found" } }, "summary": "Retrieves conversion results", "description": "Retrieves a Conversion resource.", "parameters": [ { "name": "id", "in": "path", "description": "conversion job identifier", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "integer" }, "style": "simple", "explode": false, "allowReserved": false, "example": "42" }, { "name": "format", "in": "query", "description": "document format", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string", "enum": [ "data", "pages", "source" ] }, "style": "form", "explode": false, "allowReserved": false, "example": "data" } ], "deprecated": false }, "parameters": [] }, "/credit_notes": { "get": { "operationId": "getCreditNoteCollection", "tags": [ "CreditNote" ], "responses": { "200": { "description": "CreditNote collection", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CreditNote" } } }, "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CreditNote" } } }, "text/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CreditNote" } } }, "text/csv": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CreditNote" } } }, "text/html": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CreditNote" } } } } } }, "summary": "Retrieves the collection of CreditNote resources.", "description": "Retrieves the collection of CreditNote resources.", "parameters": [ { "name": "page", "in": "query", "description": "The collection page number", "required": false, "deprecated": false, "allowEmptyValue": true, "schema": { "type": "integer", "default": 1 }, "style": "form", "explode": false, "allowReserved": false }, { "name": "itemsPerPage", "in": "query", "description": "The number of items per page", "required": false, "deprecated": false, "allowEmptyValue": true, "schema": { "type": "integer", "default": 100, "minimum": 0, "maximum": 200 }, "style": "form", "explode": false, "allowReserved": false } ], "deprecated": false }, "post": { "operationId": "postCreditNoteCollection", "tags": [ "CreditNote" ], "responses": { "201": { "description": "CreditNote resource created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreditNote" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/CreditNote" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/CreditNote" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CreditNote" } }, "text/html": { "schema": { "$ref": "#/components/schemas/CreditNote" } } }, "links": { "GetCreditNoteItem": { "operationId": "getCreditNoteItem", "parameters": { "id": "$response.body#/id" }, "description": "The `id` value returned in the response can be used as the `id` parameter in `GET /credit_notes/{id}`." } } }, "400": { "description": "Invalid input" }, "422": { "description": "Unprocessable entity" } }, "summary": "Creates a CreditNote resource.", "description": "Creates a CreditNote resource.", "parameters": [], "requestBody": { "description": "The new CreditNote resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreditNote" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/CreditNote" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/CreditNote" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CreditNote" } }, "text/html": { "schema": { "$ref": "#/components/schemas/CreditNote" } } }, "required": true }, "deprecated": false }, "parameters": [] }, "/credit_notes/{id}": { "get": { "operationId": "getCreditNoteItem", "tags": [ "CreditNote" ], "responses": { "200": { "description": "CreditNote resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreditNote" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/CreditNote" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/CreditNote" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CreditNote" } }, "text/html": { "schema": { "$ref": "#/components/schemas/CreditNote" } } } }, "404": { "description": "Resource not found" } }, "summary": "Retrieves a CreditNote resource.", "description": "Retrieves a CreditNote resource.", "parameters": [ { "name": "id", "in": "path", "description": "Resource identifier", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "deprecated": false }, "put": { "operationId": "putCreditNoteItem", "tags": [ "CreditNote" ], "responses": { "200": { "description": "CreditNote resource updated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreditNote" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/CreditNote" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/CreditNote" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CreditNote" } }, "text/html": { "schema": { "$ref": "#/components/schemas/CreditNote" } } }, "links": { "GetCreditNoteItem": { "operationId": "getCreditNoteItem", "parameters": { "id": "$response.body#/id" }, "description": "The `id` value returned in the response can be used as the `id` parameter in `GET /credit_notes/{id}`." } } }, "400": { "description": "Invalid input" }, "422": { "description": "Unprocessable entity" }, "404": { "description": "Resource not found" } }, "summary": "Replaces the CreditNote resource.", "description": "Replaces the CreditNote resource.", "parameters": [ { "name": "id", "in": "path", "description": "Resource identifier", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "requestBody": { "description": "The updated CreditNote resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreditNote" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/CreditNote" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/CreditNote" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CreditNote" } }, "text/html": { "schema": { "$ref": "#/components/schemas/CreditNote" } } }, "required": true }, "deprecated": false }, "delete": { "operationId": "deleteCreditNoteItem", "tags": [ "CreditNote" ], "responses": { "204": { "description": "CreditNote resource deleted" }, "404": { "description": "Resource not found" } }, "summary": "Removes the CreditNote resource.", "description": "Removes the CreditNote resource.", "parameters": [ { "name": "id", "in": "path", "description": "Resource identifier", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "deprecated": false }, "parameters": [] }, "/customer_opening_balances": { "get": { "operationId": "getCustomerOpeningBalanceCollection", "tags": [ "CustomerOpeningBalance" ], "responses": { "200": { "description": "CustomerOpeningBalance collection", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CustomerOpeningBalance" } } }, "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CustomerOpeningBalance" } } }, "text/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CustomerOpeningBalance" } } }, "text/csv": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CustomerOpeningBalance" } } }, "text/html": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CustomerOpeningBalance" } } } } } }, "summary": "Retrieves the collection of CustomerOpeningBalance resources.", "description": "Retrieves the collection of CustomerOpeningBalance resources.", "parameters": [ { "name": "page", "in": "query", "description": "The collection page number", "required": false, "deprecated": false, "allowEmptyValue": true, "schema": { "type": "integer", "default": 1 }, "style": "form", "explode": false, "allowReserved": false }, { "name": "itemsPerPage", "in": "query", "description": "The number of items per page", "required": false, "deprecated": false, "allowEmptyValue": true, "schema": { "type": "integer", "default": 100, "minimum": 0, "maximum": 200 }, "style": "form", "explode": false, "allowReserved": false } ], "deprecated": false }, "parameters": [] }, "/customer_opening_balances/{id}": { "get": { "operationId": "getCustomerOpeningBalanceItem", "tags": [ "CustomerOpeningBalance" ], "responses": { "200": { "description": "CustomerOpeningBalance resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomerOpeningBalance" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/CustomerOpeningBalance" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/CustomerOpeningBalance" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CustomerOpeningBalance" } }, "text/html": { "schema": { "$ref": "#/components/schemas/CustomerOpeningBalance" } } } }, "404": { "description": "Resource not found" } }, "summary": "Retrieves a CustomerOpeningBalance resource.", "description": "Retrieves a CustomerOpeningBalance resource.", "parameters": [ { "name": "id", "in": "path", "description": "Resource identifier", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "deprecated": false }, "parameters": [] }, "/customers": { "get": { "operationId": "getCustomerCollection", "tags": [ "Customer" ], "responses": { "200": { "description": "Customer collection", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Customer" } } }, "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Customer" } } }, "text/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Customer" } } }, "text/csv": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Customer" } } }, "text/html": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Customer" } } } } } }, "summary": "Retrieves the collection of Customer resources.", "description": "Retrieves the collection of Customer resources.", "parameters": [ { "name": "page", "in": "query", "description": "The collection page number", "required": false, "deprecated": false, "allowEmptyValue": true, "schema": { "type": "integer", "default": 1 }, "style": "form", "explode": false, "allowReserved": false }, { "name": "itemsPerPage", "in": "query", "description": "The number of items per page", "required": false, "deprecated": false, "allowEmptyValue": true, "schema": { "type": "integer", "default": 100, "minimum": 0, "maximum": 200 }, "style": "form", "explode": false, "allowReserved": false } ], "deprecated": false }, "post": { "operationId": "postCustomerCollection", "tags": [ "Customer" ], "responses": { "201": { "description": "Customer resource created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Customer" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/Customer" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/Customer" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/Customer" } }, "text/html": { "schema": { "$ref": "#/components/schemas/Customer" } } }, "links": { "GetCustomerItem": { "operationId": "getCustomerItem", "parameters": { "id": "$response.body#/id" }, "description": "The `id` value returned in the response can be used as the `id` parameter in `GET /customers/{id}`." } } }, "400": { "description": "Invalid input" }, "422": { "description": "Unprocessable entity" } }, "summary": "Creates a Customer resource.", "description": "Creates a Customer resource.", "parameters": [], "requestBody": { "description": "The new Customer resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Customer" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/Customer" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/Customer" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/Customer" } }, "text/html": { "schema": { "$ref": "#/components/schemas/Customer" } } }, "required": true }, "deprecated": false }, "parameters": [] }, "/customers/{id}": { "get": { "operationId": "getCustomerItem", "tags": [ "Customer" ], "responses": { "200": { "description": "Customer resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Customer" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/Customer" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/Customer" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/Customer" } }, "text/html": { "schema": { "$ref": "#/components/schemas/Customer" } } } }, "404": { "description": "Resource not found" } }, "summary": "Retrieves a Customer resource.", "description": "Retrieves a Customer resource.", "parameters": [ { "name": "id", "in": "path", "description": "Resource identifier", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "deprecated": false }, "put": { "operationId": "putCustomerItem", "tags": [ "Customer" ], "responses": { "200": { "description": "Customer resource updated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Customer" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/Customer" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/Customer" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/Customer" } }, "text/html": { "schema": { "$ref": "#/components/schemas/Customer" } } }, "links": { "GetCustomerItem": { "operationId": "getCustomerItem", "parameters": { "id": "$response.body#/id" }, "description": "The `id` value returned in the response can be used as the `id` parameter in `GET /customers/{id}`." } } }, "400": { "description": "Invalid input" }, "422": { "description": "Unprocessable entity" }, "404": { "description": "Resource not found" } }, "summary": "Replaces the Customer resource.", "description": "Replaces the Customer resource.", "parameters": [ { "name": "id", "in": "path", "description": "Resource identifier", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "requestBody": { "description": "The updated Customer resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Customer" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/Customer" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/Customer" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/Customer" } }, "text/html": { "schema": { "$ref": "#/components/schemas/Customer" } } }, "required": true }, "deprecated": false }, "delete": { "operationId": "deleteCustomerItem", "tags": [ "Customer" ], "responses": { "204": { "description": "Customer resource deleted" }, "404": { "description": "Resource not found" } }, "summary": "Removes the Customer resource.", "description": "Removes the Customer resource.", "parameters": [ { "name": "id", "in": "path", "description": "Resource identifier", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "deprecated": false }, "parameters": [] }, "/data_sync": { "get": { "operationId": "getDataSyncItem", "tags": [ "DataSync" ], "responses": { "200": { "description": "DataSync resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataSync" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/DataSync" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/DataSync" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/DataSync" } }, "text/html": { "schema": { "$ref": "#/components/schemas/DataSync" } } } }, "404": { "description": "Resource not found" } }, "summary": "Syncs the latest data from a connected application and returns a success or failure message.", "description": "Retrieves a DataSync resource.", "parameters": [ { "name": "key", "in": "query", "description": "The key of the application you would like to sync. ", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "form", "explode": false, "allowReserved": false, "example": "quickbooks" } ], "deprecated": false }, "parameters": [] }, "/deals": { "get": { "operationId": "getDealCollection", "tags": [ "Deal" ], "responses": { "200": { "description": "Deal collection", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Deal" } } }, "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Deal" } } }, "text/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Deal" } } }, "text/csv": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Deal" } } }, "text/html": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Deal" } } } } } }, "summary": "Retrieves the collection of Deal resources.", "description": "Retrieves the collection of Deal resources.", "parameters": [ { "name": "page", "in": "query", "description": "The collection page number", "required": false, "deprecated": false, "allowEmptyValue": true, "schema": { "type": "integer", "default": 1 }, "style": "form", "explode": false, "allowReserved": false }, { "name": "itemsPerPage", "in": "query", "description": "The number of items per page", "required": false, "deprecated": false, "allowEmptyValue": true, "schema": { "type": "integer", "default": 100, "minimum": 0, "maximum": 200 }, "style": "form", "explode": false, "allowReserved": false } ], "deprecated": false }, "post": { "operationId": "postDealCollection", "tags": [ "Deal" ], "responses": { "201": { "description": "Deal resource created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Deal" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/Deal" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/Deal" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/Deal" } }, "text/html": { "schema": { "$ref": "#/components/schemas/Deal" } } }, "links": { "GetDealItem": { "operationId": "getDealItem", "parameters": { "id": "$response.body#/id" }, "description": "The `id` value returned in the response can be used as the `id` parameter in `GET /deals/{id}`." } } }, "400": { "description": "Invalid input" }, "422": { "description": "Unprocessable entity" } }, "summary": "Creates a Deal resource.", "description": "Creates a Deal resource.", "parameters": [], "requestBody": { "description": "The new Deal resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Deal" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/Deal" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/Deal" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/Deal" } }, "text/html": { "schema": { "$ref": "#/components/schemas/Deal" } } }, "required": true }, "deprecated": false }, "parameters": [] }, "/deals/{id}": { "get": { "operationId": "getDealItem", "tags": [ "Deal" ], "responses": { "200": { "description": "Deal resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Deal" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/Deal" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/Deal" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/Deal" } }, "text/html": { "schema": { "$ref": "#/components/schemas/Deal" } } } }, "404": { "description": "Resource not found" } }, "summary": "Retrieves a Deal resource.", "description": "Retrieves a Deal resource.", "parameters": [ { "name": "id", "in": "path", "description": "Resource identifier", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "deprecated": false }, "put": { "operationId": "putDealItem", "tags": [ "Deal" ], "responses": { "200": { "description": "Deal resource updated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Deal" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/Deal" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/Deal" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/Deal" } }, "text/html": { "schema": { "$ref": "#/components/schemas/Deal" } } }, "links": { "GetDealItem": { "operationId": "getDealItem", "parameters": { "id": "$response.body#/id" }, "description": "The `id` value returned in the response can be used as the `id` parameter in `GET /deals/{id}`." } } }, "400": { "description": "Invalid input" }, "422": { "description": "Unprocessable entity" }, "404": { "description": "Resource not found" } }, "summary": "Replaces the Deal resource.", "description": "Replaces the Deal resource.", "parameters": [ { "name": "id", "in": "path", "description": "Resource identifier", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "requestBody": { "description": "The updated Deal resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Deal" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/Deal" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/Deal" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/Deal" } }, "text/html": { "schema": { "$ref": "#/components/schemas/Deal" } } }, "required": true }, "deprecated": false }, "delete": { "operationId": "deleteDealItem", "tags": [ "Deal" ], "responses": { "204": { "description": "Deal resource deleted" }, "404": { "description": "Resource not found" } }, "summary": "Removes the Deal resource.", "description": "Removes the Deal resource.", "parameters": [ { "name": "id", "in": "path", "description": "Resource identifier", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "deprecated": false }, "parameters": [] }, "/departments": { "get": { "operationId": "getDepartmentCollection", "tags": [ "Department" ], "responses": { "200": { "description": "Department collection", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Department" } } }, "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Department" } } }, "text/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Department" } } }, "text/csv": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Department" } } }, "text/html": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Department" } } } } } }, "summary": "Retrieves the collection of Department resources.", "description": "Retrieves the collection of Department resources.", "parameters": [ { "name": "page", "in": "query", "description": "The collection page number", "required": false, "deprecated": false, "allowEmptyValue": true, "schema": { "type": "integer", "default": 1 }, "style": "form", "explode": false, "allowReserved": false }, { "name": "itemsPerPage", "in": "query", "description": "The number of items per page", "required": false, "deprecated": false, "allowEmptyValue": true, "schema": { "type": "integer", "default": 100, "minimum": 0, "maximum": 200 }, "style": "form", "explode": false, "allowReserved": false } ], "deprecated": false }, "parameters": [] }, "/departments/{id}": { "get": { "operationId": "getDepartmentItem", "tags": [ "Department" ], "responses": { "200": { "description": "Department resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Department" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/Department" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/Department" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/Department" } }, "text/html": { "schema": { "$ref": "#/components/schemas/Department" } } } }, "404": { "description": "Resource not found" } }, "summary": "Retrieves a Department resource.", "description": "Retrieves a Department resource.", "parameters": [ { "name": "id", "in": "path", "description": "Resource identifier", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "deprecated": false }, "parameters": [] }, "/employees": { "get": { "operationId": "getEmployeeCollection", "tags": [ "Employee" ], "responses": { "200": { "description": "Employee collection", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Employee" } } }, "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Employee" } } }, "text/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Employee" } } }, "text/csv": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Employee" } } }, "text/html": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Employee" } } } } } }, "summary": "Retrieves the collection of Employee resources.", "description": "Retrieves the collection of Employee resources.", "parameters": [ { "name": "page", "in": "query", "description": "The collection page number", "required": false, "deprecated": false, "allowEmptyValue": true, "schema": { "type": "integer", "default": 1 }, "style": "form", "explode": false, "allowReserved": false }, { "name": "itemsPerPage", "in": "query", "description": "The number of items per page", "required": false, "deprecated": false, "allowEmptyValue": true, "schema": { "type": "integer", "default": 100, "minimum": 0, "maximum": 200 }, "style": "form", "explode": false, "allowReserved": false } ], "deprecated": false }, "post": { "operationId": "postEmployeeCollection", "tags": [ "Employee" ], "responses": { "201": { "description": "Employee resource created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Employee" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/Employee" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/Employee" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/Employee" } }, "text/html": { "schema": { "$ref": "#/components/schemas/Employee" } } }, "links": { "GetEmployeeItem": { "operationId": "getEmployeeItem", "parameters": { "id": "$response.body#/id" }, "description": "The `id` value returned in the response can be used as the `id` parameter in `GET /employees/{id}`." } } }, "400": { "description": "Invalid input" }, "422": { "description": "Unprocessable entity" } }, "summary": "Creates a Employee resource.", "description": "Creates a Employee resource.", "parameters": [], "requestBody": { "description": "The new Employee resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Employee" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/Employee" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/Employee" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/Employee" } }, "text/html": { "schema": { "$ref": "#/components/schemas/Employee" } } }, "required": true }, "deprecated": false }, "parameters": [] }, "/employees/{id}": { "get": { "operationId": "getEmployeeItem", "tags": [ "Employee" ], "responses": { "200": { "description": "Employee resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Employee" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/Employee" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/Employee" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/Employee" } }, "text/html": { "schema": { "$ref": "#/components/schemas/Employee" } } } }, "404": { "description": "Resource not found" } }, "summary": "Retrieves a Employee resource.", "description": "Retrieves a Employee resource.", "parameters": [ { "name": "id", "in": "path", "description": "Resource identifier", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "deprecated": false }, "put": { "operationId": "putEmployeeItem", "tags": [ "Employee" ], "responses": { "200": { "description": "Employee resource updated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Employee" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/Employee" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/Employee" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/Employee" } }, "text/html": { "schema": { "$ref": "#/components/schemas/Employee" } } }, "links": { "GetEmployeeItem": { "operationId": "getEmployeeItem", "parameters": { "id": "$response.body#/id" }, "description": "The `id` value returned in the response can be used as the `id` parameter in `GET /employees/{id}`." } } }, "400": { "description": "Invalid input" }, "422": { "description": "Unprocessable entity" }, "404": { "description": "Resource not found" } }, "summary": "Replaces the Employee resource.", "description": "Replaces the Employee resource.", "parameters": [ { "name": "id", "in": "path", "description": "Resource identifier", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "requestBody": { "description": "The updated Employee resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Employee" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/Employee" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/Employee" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/Employee" } }, "text/html": { "schema": { "$ref": "#/components/schemas/Employee" } } }, "required": true }, "deprecated": false }, "delete": { "operationId": "deleteEmployeeItem", "tags": [ "Employee" ], "responses": { "204": { "description": "Employee resource deleted" }, "404": { "description": "Resource not found" } }, "summary": "Removes the Employee resource.", "description": "Removes the Employee resource.", "parameters": [ { "name": "id", "in": "path", "description": "Resource identifier", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "deprecated": false }, "parameters": [] }, "/engagements": { "get": { "operationId": "getEngagementCollection", "tags": [ "Engagement" ], "responses": { "200": { "description": "Engagement collection", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Engagement" } } }, "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Engagement" } } }, "text/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Engagement" } } }, "text/csv": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Engagement" } } }, "text/html": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Engagement" } } } } } }, "summary": "Retrieves the collection of Engagement resources.", "description": "Retrieves the collection of Engagement resources.", "parameters": [ { "name": "page", "in": "query", "description": "The collection page number", "required": false, "deprecated": false, "allowEmptyValue": true, "schema": { "type": "integer", "default": 1 }, "style": "form", "explode": false, "allowReserved": false }, { "name": "itemsPerPage", "in": "query", "description": "The number of items per page", "required": false, "deprecated": false, "allowEmptyValue": true, "schema": { "type": "integer", "default": 100, "minimum": 0, "maximum": 200 }, "style": "form", "explode": false, "allowReserved": false } ], "deprecated": false }, "parameters": [] }, "/engagements/{id}": { "get": { "operationId": "getEngagementItem", "tags": [ "Engagement" ], "responses": { "200": { "description": "Engagement resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Engagement" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/Engagement" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/Engagement" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/Engagement" } }, "text/html": { "schema": { "$ref": "#/components/schemas/Engagement" } } } }, "404": { "description": "Resource not found" } }, "summary": "Retrieves a Engagement resource.", "description": "Retrieves a Engagement resource.", "parameters": [ { "name": "id", "in": "path", "description": "Resource identifier", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "deprecated": false }, "parameters": [] }, "/estimates": { "get": { "operationId": "getEstimateCollection", "tags": [ "Estimate" ], "responses": { "200": { "description": "Estimate collection", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Estimate" } } }, "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Estimate" } } }, "text/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Estimate" } } }, "text/csv": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Estimate" } } }, "text/html": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Estimate" } } } } } }, "summary": "Retrieves the collection of Estimate resources.", "description": "Retrieves the collection of Estimate resources.", "parameters": [ { "name": "page", "in": "query", "description": "The collection page number", "required": false, "deprecated": false, "allowEmptyValue": true, "schema": { "type": "integer", "default": 1 }, "style": "form", "explode": false, "allowReserved": false }, { "name": "itemsPerPage", "in": "query", "description": "The number of items per page", "required": false, "deprecated": false, "allowEmptyValue": true, "schema": { "type": "integer", "default": 100, "minimum": 0, "maximum": 200 }, "style": "form", "explode": false, "allowReserved": false } ], "deprecated": false }, "parameters": [] }, "/estimates/{id}": { "get": { "operationId": "getEstimateItem", "tags": [ "Estimate" ], "responses": { "200": { "description": "Estimate resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Estimate" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/Estimate" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/Estimate" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/Estimate" } }, "text/html": { "schema": { "$ref": "#/components/schemas/Estimate" } } } }, "404": { "description": "Resource not found" } }, "summary": "Retrieves a Estimate resource.", "description": "Retrieves a Estimate resource.", "parameters": [ { "name": "id", "in": "path", "description": "Resource identifier", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "deprecated": false }, "parameters": [] }, "/events": { "get": { "operationId": "getEventCollection", "tags": [ "Event" ], "responses": { "200": { "description": "Event collection", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Event" } } }, "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Event" } } }, "text/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Event" } } }, "text/csv": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Event" } } }, "text/html": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Event" } } } } } }, "summary": "Retrieves the collection of Event resources.", "description": "Retrieves the collection of Event resources.", "parameters": [ { "name": "page", "in": "query", "description": "The collection page number", "required": false, "deprecated": false, "allowEmptyValue": true, "schema": { "type": "integer", "default": 1 }, "style": "form", "explode": false, "allowReserved": false }, { "name": "itemsPerPage", "in": "query", "description": "The number of items per page", "required": false, "deprecated": false, "allowEmptyValue": true, "schema": { "type": "integer", "default": 100, "minimum": 0, "maximum": 200 }, "style": "form", "explode": false, "allowReserved": false } ], "deprecated": false }, "parameters": [] }, "/events/{id}": { "get": { "operationId": "getEventItem", "tags": [ "Event" ], "responses": { "200": { "description": "Event resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Event" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/Event" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/Event" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/Event" } }, "text/html": { "schema": { "$ref": "#/components/schemas/Event" } } } }, "404": { "description": "Resource not found" } }, "summary": "Retrieves a Event resource.", "description": "Retrieves a Event resource.", "parameters": [ { "name": "id", "in": "path", "description": "Resource identifier", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "deprecated": false }, "parameters": [] }, "/executive_summaries/{id}": { "get": { "operationId": "getExecutiveSummaryItem", "tags": [ "ExecutiveSummary" ], "responses": { "200": { "description": "ExecutiveSummary resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExecutiveSummary" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ExecutiveSummary" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ExecutiveSummary" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/ExecutiveSummary" } }, "text/html": { "schema": { "$ref": "#/components/schemas/ExecutiveSummary" } } } }, "404": { "description": "Resource not found" } }, "summary": "Retrieves a ExecutiveSummary resource.", "description": "Retrieves a ExecutiveSummary resource.", "parameters": [ { "name": "id", "in": "path", "description": "Resource identifier", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "deprecated": false }, "parameters": [] }, "/executive_summary": { "get": { "operationId": "getExecutiveSummaryCollection", "tags": [ "ExecutiveSummary" ], "responses": { "200": { "description": "ExecutiveSummary collection", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ExecutiveSummary" } } }, "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ExecutiveSummary" } } }, "text/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ExecutiveSummary" } } }, "text/csv": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ExecutiveSummary" } } }, "text/html": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ExecutiveSummary" } } } } } }, "summary": "Retrieves the collection of ExecutiveSummary resources.", "description": "Retrieves the collection of ExecutiveSummary resources.", "parameters": [ { "name": "page", "in": "query", "description": "The collection page number", "required": false, "deprecated": false, "allowEmptyValue": true, "schema": { "type": "integer", "default": 1 }, "style": "form", "explode": false, "allowReserved": false }, { "name": "itemsPerPage", "in": "query", "description": "The number of items per page", "required": false, "deprecated": false, "allowEmptyValue": true, "schema": { "type": "integer", "default": 100, "minimum": 0, "maximum": 200 }, "style": "form", "explode": false, "allowReserved": false } ], "deprecated": false }, "parameters": [] }, "/expenses": { "get": { "operationId": "getExpenseCollection", "tags": [ "Expense" ], "responses": { "200": { "description": "Expense collection", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Expense" } } }, "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Expense" } } }, "text/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Expense" } } }, "text/csv": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Expense" } } }, "text/html": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Expense" } } } } } }, "summary": "Retrieves the collection of Expense resources.", "description": "Retrieves the collection of Expense resources.", "parameters": [ { "name": "page", "in": "query", "description": "The collection page number", "required": false, "deprecated": false, "allowEmptyValue": true, "schema": { "type": "integer", "default": 1 }, "style": "form", "explode": false, "allowReserved": false }, { "name": "itemsPerPage", "in": "query", "description": "The number of items per page", "required": false, "deprecated": false, "allowEmptyValue": true, "schema": { "type": "integer", "default": 100, "minimum": 0, "maximum": 200 }, "style": "form", "explode": false, "allowReserved": false } ], "deprecated": false }, "post": { "operationId": "postExpenseCollection", "tags": [ "Expense" ], "responses": { "201": { "description": "Expense resource created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Expense" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/Expense" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/Expense" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/Expense" } }, "text/html": { "schema": { "$ref": "#/components/schemas/Expense" } } }, "links": { "GetExpenseItem": { "operationId": "getExpenseItem", "parameters": { "id": "$response.body#/id" }, "description": "The `id` value returned in the response can be used as the `id` parameter in `GET /expenses/{id}`." } } }, "400": { "description": "Invalid input" }, "422": { "description": "Unprocessable entity" } }, "summary": "Creates a Expense resource.", "description": "Creates a Expense resource.", "parameters": [], "requestBody": { "description": "The new Expense resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Expense" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/Expense" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/Expense" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/Expense" } }, "text/html": { "schema": { "$ref": "#/components/schemas/Expense" } } }, "required": true }, "deprecated": false }, "parameters": [] }, "/expenses/{id}": { "get": { "operationId": "getExpenseItem", "tags": [ "Expense" ], "responses": { "200": { "description": "Expense resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Expense" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/Expense" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/Expense" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/Expense" } }, "text/html": { "schema": { "$ref": "#/components/schemas/Expense" } } } }, "404": { "description": "Resource not found" } }, "summary": "Retrieves a Expense resource.", "description": "Retrieves a Expense resource.", "parameters": [ { "name": "id", "in": "path", "description": "Resource identifier", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "deprecated": false }, "put": { "operationId": "putExpenseItem", "tags": [ "Expense" ], "responses": { "200": { "description": "Expense resource updated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Expense" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/Expense" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/Expense" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/Expense" } }, "text/html": { "schema": { "$ref": "#/components/schemas/Expense" } } }, "links": { "GetExpenseItem": { "operationId": "getExpenseItem", "parameters": { "id": "$response.body#/id" }, "description": "The `id` value returned in the response can be used as the `id` parameter in `GET /expenses/{id}`." } } }, "400": { "description": "Invalid input" }, "422": { "description": "Unprocessable entity" }, "404": { "description": "Resource not found" } }, "summary": "Replaces the Expense resource.", "description": "Replaces the Expense resource.", "parameters": [ { "name": "id", "in": "path", "description": "Resource identifier", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "requestBody": { "description": "The updated Expense resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Expense" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/Expense" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/Expense" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/Expense" } }, "text/html": { "schema": { "$ref": "#/components/schemas/Expense" } } }, "required": true }, "deprecated": false }, "delete": { "operationId": "deleteExpenseItem", "tags": [ "Expense" ], "responses": { "204": { "description": "Expense resource deleted" }, "404": { "description": "Resource not found" } }, "summary": "Removes the Expense resource.", "description": "Removes the Expense resource.", "parameters": [ { "name": "id", "in": "path", "description": "Resource identifier", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "deprecated": false }, "parameters": [] }, "/financial_mapping": { "get": { "operationId": "getFinancialMappingCollection", "tags": [ "FinancialMapping" ], "responses": { "200": { "description": "FinancialMapping collection", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/FinancialMapping" } } }, "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/FinancialMapping" } } }, "text/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/FinancialMapping" } } }, "text/csv": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/FinancialMapping" } } }, "text/html": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/FinancialMapping" } } } } } }, "summary": "Retrieves the collection of FinancialMapping resources.", "description": "Retrieves the collection of FinancialMapping resources.", "parameters": [], "deprecated": false }, "parameters": [] }, "/financial_mappings/{id}": { "get": { "operationId": "getFinancialMappingItem", "tags": [ "FinancialMapping" ], "responses": { "200": { "description": "FinancialMapping resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FinancialMapping" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/FinancialMapping" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/FinancialMapping" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/FinancialMapping" } }, "text/html": { "schema": { "$ref": "#/components/schemas/FinancialMapping" } } } }, "404": { "description": "Resource not found" } }, "summary": "Retrieves a FinancialMapping resource.", "description": "Retrieves a FinancialMapping resource.", "parameters": [ { "name": "id", "in": "path", "description": "Resource identifier", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "deprecated": false }, "parameters": [] }, "/financial_periods": { "get": { "operationId": "getFinancialPeriodCollection", "tags": [ "FinancialPeriod" ], "responses": { "200": { "description": "FinancialPeriod collection", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/FinancialPeriod" } } }, "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/FinancialPeriod" } } }, "text/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/FinancialPeriod" } } }, "text/csv": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/FinancialPeriod" } } }, "text/html": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/FinancialPeriod" } } } } } }, "summary": "Retrieves the collection of FinancialPeriod resources.", "description": "Retrieves the collection of FinancialPeriod resources.", "parameters": [], "deprecated": false }, "parameters": [] }, "/financial_periods/{id}": { "get": { "operationId": "getFinancialPeriodItem", "tags": [ "FinancialPeriod" ], "responses": { "200": { "description": "FinancialPeriod resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FinancialPeriod" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/FinancialPeriod" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/FinancialPeriod" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/FinancialPeriod" } }, "text/html": { "schema": { "$ref": "#/components/schemas/FinancialPeriod" } } } }, "404": { "description": "Resource not found" } }, "summary": "Retrieves a FinancialPeriod resource.", "description": "Retrieves a FinancialPeriod resource.", "parameters": [ { "name": "id", "in": "path", "description": "Resource identifier", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "deprecated": false }, "parameters": [] }, "/form_data": { "get": { "operationId": "getFormDataItem", "tags": [ "FormData" ], "responses": { "200": { "description": "FormData resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FormData" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/FormData" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/FormData" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/FormData" } }, "text/html": { "schema": { "$ref": "#/components/schemas/FormData" } } } }, "404": { "description": "Resource not found" } }, "summary": "Retrieves JSON Form Data", "description": "The returned object will have keys based on the 'name' attributes of each form input.", "parameters": [ { "name": "key", "in": "query", "description": "The key of the Form that you would like to retrieve data for. Default is 'profile'. ", "required": false, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "form", "explode": false, "allowReserved": false, "example": "profile" }, { "name": "formInput1", "in": "path", "description": "Resource identifier", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "deprecated": false }, "parameters": [] }, "/forms": { "get": { "operationId": "getFormCollection", "tags": [ "Form" ], "responses": { "200": { "description": "Form collection", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Form" } } }, "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Form" } } }, "text/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Form" } } }, "text/csv": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Form" } } }, "text/html": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Form" } } } } } }, "summary": "Retrieves the collection of Form resources.", "description": "Retrieves the collection of Form resources.", "parameters": [ { "name": "page", "in": "query", "description": "The collection page number", "required": false, "deprecated": false, "allowEmptyValue": true, "schema": { "type": "integer", "default": 1 }, "style": "form", "explode": false, "allowReserved": false }, { "name": "itemsPerPage", "in": "query", "description": "The number of items per page", "required": false, "deprecated": false, "allowEmptyValue": true, "schema": { "type": "integer", "default": 100, "minimum": 0, "maximum": 200 }, "style": "form", "explode": false, "allowReserved": false } ], "deprecated": false }, "parameters": [] }, "/forms/{id}": { "get": { "operationId": "getFormItem", "tags": [ "Form" ], "responses": { "200": { "description": "Form resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Form" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/Form" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/Form" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/Form" } }, "text/html": { "schema": { "$ref": "#/components/schemas/Form" } } } }, "404": { "description": "Resource not found" } }, "summary": "Retrieves a Form resource.", "description": "Retrieves a Form resource.", "parameters": [ { "name": "id", "in": "path", "description": "Resource identifier", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "deprecated": false }, "parameters": [] }, "/growth_histories": { "get": { "operationId": "getGrowthHistoryCollection", "tags": [ "GrowthHistory" ], "responses": { "200": { "description": "GrowthHistory collection", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/GrowthHistory" } } }, "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/GrowthHistory" } } }, "text/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/GrowthHistory" } } }, "text/csv": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/GrowthHistory" } } }, "text/html": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/GrowthHistory" } } } } } }, "summary": "Retrieves the collection of GrowthHistory resources.", "description": "Retrieves the collection of GrowthHistory resources.", "parameters": [ { "name": "page", "in": "query", "description": "The collection page number", "required": false, "deprecated": false, "allowEmptyValue": true, "schema": { "type": "integer", "default": 1 }, "style": "form", "explode": false, "allowReserved": false }, { "name": "itemsPerPage", "in": "query", "description": "The number of items per page", "required": false, "deprecated": false, "allowEmptyValue": true, "schema": { "type": "integer", "default": 100, "minimum": 0, "maximum": 200 }, "style": "form", "explode": false, "allowReserved": false } ], "deprecated": false }, "parameters": [] }, "/growth_histories/{id}": { "get": { "operationId": "getGrowthHistoryItem", "tags": [ "GrowthHistory" ], "responses": { "200": { "description": "GrowthHistory resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GrowthHistory" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/GrowthHistory" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/GrowthHistory" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/GrowthHistory" } }, "text/html": { "schema": { "$ref": "#/components/schemas/GrowthHistory" } } } }, "404": { "description": "Resource not found" } }, "summary": "Retrieves a GrowthHistory resource.", "description": "Retrieves a GrowthHistory resource.", "parameters": [ { "name": "id", "in": "path", "description": "Resource identifier", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "deprecated": false }, "parameters": [] }, "/integrations": { "get": { "operationId": "getIntegrationsListItem", "tags": [ "IntegrationsList" ], "responses": { "200": { "description": "IntegrationsList resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsList" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/IntegrationsList" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/IntegrationsList" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/IntegrationsList" } }, "text/html": { "schema": { "$ref": "#/components/schemas/IntegrationsList" } } } }, "404": { "description": "Resource not found" } }, "summary": "Retrieves a list of integrations", "description": "Retrieves a IntegrationsList resource.", "parameters": [ { "name": "file", "in": "path", "description": "Resource identifier", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "deprecated": false }, "parameters": [] }, "/inventories": { "get": { "operationId": "getInventoryCollection", "tags": [ "Inventory" ], "responses": { "200": { "description": "Inventory collection", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Inventory" } } }, "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Inventory" } } }, "text/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Inventory" } } }, "text/csv": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Inventory" } } }, "text/html": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Inventory" } } } } } }, "summary": "Retrieves the collection of Inventory resources.", "description": "Retrieves the collection of Inventory resources.", "parameters": [ { "name": "page", "in": "query", "description": "The collection page number", "required": false, "deprecated": false, "allowEmptyValue": true, "schema": { "type": "integer", "default": 1 }, "style": "form", "explode": false, "allowReserved": false }, { "name": "itemsPerPage", "in": "query", "description": "The number of items per page", "required": false, "deprecated": false, "allowEmptyValue": true, "schema": { "type": "integer", "default": 100, "minimum": 0, "maximum": 200 }, "style": "form", "explode": false, "allowReserved": false } ], "deprecated": false }, "post": { "operationId": "postInventoryCollection", "tags": [ "Inventory" ], "responses": { "201": { "description": "Inventory resource created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Inventory" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/Inventory" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/Inventory" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/Inventory" } }, "text/html": { "schema": { "$ref": "#/components/schemas/Inventory" } } }, "links": { "GetInventoryItem": { "operationId": "getInventoryItem", "parameters": { "id": "$response.body#/id" }, "description": "The `id` value returned in the response can be used as the `id` parameter in `GET /inventories/{id}`." } } }, "400": { "description": "Invalid input" }, "422": { "description": "Unprocessable entity" } }, "summary": "Creates a Inventory resource.", "description": "Creates a Inventory resource.", "parameters": [], "requestBody": { "description": "The new Inventory resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Inventory" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/Inventory" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/Inventory" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/Inventory" } }, "text/html": { "schema": { "$ref": "#/components/schemas/Inventory" } } }, "required": true }, "deprecated": false }, "parameters": [] }, "/inventories/{id}": { "get": { "operationId": "getInventoryItem", "tags": [ "Inventory" ], "responses": { "200": { "description": "Inventory resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Inventory" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/Inventory" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/Inventory" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/Inventory" } }, "text/html": { "schema": { "$ref": "#/components/schemas/Inventory" } } } }, "404": { "description": "Resource not found" } }, "summary": "Retrieves a Inventory resource.", "description": "Retrieves a Inventory resource.", "parameters": [ { "name": "id", "in": "path", "description": "Resource identifier", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "deprecated": false }, "put": { "operationId": "putInventoryItem", "tags": [ "Inventory" ], "responses": { "200": { "description": "Inventory resource updated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Inventory" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/Inventory" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/Inventory" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/Inventory" } }, "text/html": { "schema": { "$ref": "#/components/schemas/Inventory" } } }, "links": { "GetInventoryItem": { "operationId": "getInventoryItem", "parameters": { "id": "$response.body#/id" }, "description": "The `id` value returned in the response can be used as the `id` parameter in `GET /inventories/{id}`." } } }, "400": { "description": "Invalid input" }, "422": { "description": "Unprocessable entity" }, "404": { "description": "Resource not found" } }, "summary": "Replaces the Inventory resource.", "description": "Replaces the Inventory resource.", "parameters": [ { "name": "id", "in": "path", "description": "Resource identifier", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "requestBody": { "description": "The updated Inventory resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Inventory" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/Inventory" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/Inventory" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/Inventory" } }, "text/html": { "schema": { "$ref": "#/components/schemas/Inventory" } } }, "required": true }, "deprecated": false }, "delete": { "operationId": "deleteInventoryItem", "tags": [ "Inventory" ], "responses": { "204": { "description": "Inventory resource deleted" }, "404": { "description": "Resource not found" } }, "summary": "Removes the Inventory resource.", "description": "Removes the Inventory resource.", "parameters": [ { "name": "id", "in": "path", "description": "Resource identifier", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "deprecated": false }, "parameters": [] }, "/invoice_items": { "get": { "operationId": "getInvoiceItemCollection", "tags": [ "InvoiceItem" ], "responses": { "200": { "description": "InvoiceItem collection", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/InvoiceItem" } } }, "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/InvoiceItem" } } }, "text/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/InvoiceItem" } } }, "text/csv": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/InvoiceItem" } } }, "text/html": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/InvoiceItem" } } } } } }, "summary": "Retrieves the collection of InvoiceItem resources.", "description": "Retrieves the collection of InvoiceItem resources.", "parameters": [ { "name": "page", "in": "query", "description": "The collection page number", "required": false, "deprecated": false, "allowEmptyValue": true, "schema": { "type": "integer", "default": 1 }, "style": "form", "explode": false, "allowReserved": false }, { "name": "itemsPerPage", "in": "query", "description": "The number of items per page", "required": false, "deprecated": false, "allowEmptyValue": true, "schema": { "type": "integer", "default": 100, "minimum": 0, "maximum": 200 }, "style": "form", "explode": false, "allowReserved": false }, { "name": "invoiceId", "in": "query", "description": "", "required": false, "deprecated": false, "allowEmptyValue": true, "schema": { "type": "string" }, "style": "form", "explode": false, "allowReserved": false }, { "name": "invoiceId[]", "in": "query", "description": "", "required": false, "deprecated": false, "allowEmptyValue": true, "schema": { "type": "array", "items": { "type": "string" } }, "style": "form", "explode": true, "allowReserved": false } ], "deprecated": false }, "post": { "operationId": "postInvoiceItemCollection", "tags": [ "InvoiceItem" ], "responses": { "201": { "description": "InvoiceItem resource created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InvoiceItem" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/InvoiceItem" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/InvoiceItem" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/InvoiceItem" } }, "text/html": { "schema": { "$ref": "#/components/schemas/InvoiceItem" } } }, "links": { "GetInvoiceItemItem": { "operationId": "getInvoiceItemItem", "parameters": { "id": "$response.body#/id" }, "description": "The `id` value returned in the response can be used as the `id` parameter in `GET /invoice_items/{id}`." } } }, "400": { "description": "Invalid input" }, "422": { "description": "Unprocessable entity" } }, "summary": "Creates a InvoiceItem resource.", "description": "Creates a InvoiceItem resource.", "parameters": [], "requestBody": { "description": "The new InvoiceItem resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InvoiceItem" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/InvoiceItem" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/InvoiceItem" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/InvoiceItem" } }, "text/html": { "schema": { "$ref": "#/components/schemas/InvoiceItem" } } }, "required": true }, "deprecated": false }, "parameters": [] }, "/invoice_items/{id}": { "get": { "operationId": "getInvoiceItemItem", "tags": [ "InvoiceItem" ], "responses": { "200": { "description": "InvoiceItem resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InvoiceItem" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/InvoiceItem" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/InvoiceItem" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/InvoiceItem" } }, "text/html": { "schema": { "$ref": "#/components/schemas/InvoiceItem" } } } }, "404": { "description": "Resource not found" } }, "summary": "Retrieves a InvoiceItem resource.", "description": "Retrieves a InvoiceItem resource.", "parameters": [ { "name": "id", "in": "path", "description": "Resource identifier", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "deprecated": false }, "put": { "operationId": "putInvoiceItemItem", "tags": [ "InvoiceItem" ], "responses": { "200": { "description": "InvoiceItem resource updated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InvoiceItem" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/InvoiceItem" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/InvoiceItem" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/InvoiceItem" } }, "text/html": { "schema": { "$ref": "#/components/schemas/InvoiceItem" } } }, "links": { "GetInvoiceItemItem": { "operationId": "getInvoiceItemItem", "parameters": { "id": "$response.body#/id" }, "description": "The `id` value returned in the response can be used as the `id` parameter in `GET /invoice_items/{id}`." } } }, "400": { "description": "Invalid input" }, "422": { "description": "Unprocessable entity" }, "404": { "description": "Resource not found" } }, "summary": "Replaces the InvoiceItem resource.", "description": "Replaces the InvoiceItem resource.", "parameters": [ { "name": "id", "in": "path", "description": "Resource identifier", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "requestBody": { "description": "The updated InvoiceItem resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InvoiceItem" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/InvoiceItem" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/InvoiceItem" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/InvoiceItem" } }, "text/html": { "schema": { "$ref": "#/components/schemas/InvoiceItem" } } }, "required": true }, "deprecated": false }, "delete": { "operationId": "deleteInvoiceItemItem", "tags": [ "InvoiceItem" ], "responses": { "204": { "description": "InvoiceItem resource deleted" }, "404": { "description": "Resource not found" } }, "summary": "Removes the InvoiceItem resource.", "description": "Removes the InvoiceItem resource.", "parameters": [ { "name": "id", "in": "path", "description": "Resource identifier", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "deprecated": false }, "parameters": [] }, "/invoices": { "get": { "operationId": "getInvoiceCollection", "tags": [ "Invoice" ], "responses": { "200": { "description": "Invoice collection", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Invoice" } } }, "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Invoice" } } }, "text/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Invoice" } } }, "text/csv": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Invoice" } } }, "text/html": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Invoice" } } } } } }, "summary": "Retrieves the collection of Invoice resources.", "description": "Retrieves the collection of Invoice resources.", "parameters": [ { "name": "page", "in": "query", "description": "The collection page number", "required": false, "deprecated": false, "allowEmptyValue": true, "schema": { "type": "integer", "default": 1 }, "style": "form", "explode": false, "allowReserved": false }, { "name": "itemsPerPage", "in": "query", "description": "The number of items per page", "required": false, "deprecated": false, "allowEmptyValue": true, "schema": { "type": "integer", "default": 100, "minimum": 0, "maximum": 200 }, "style": "form", "explode": false, "allowReserved": false } ], "deprecated": false }, "parameters": [] }, "/invoices/{id}": { "get": { "operationId": "getInvoiceItem", "tags": [ "Invoice" ], "responses": { "200": { "description": "Invoice resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Invoice" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/Invoice" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/Invoice" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/Invoice" } }, "text/html": { "schema": { "$ref": "#/components/schemas/Invoice" } } } }, "404": { "description": "Resource not found" } }, "summary": "Retrieves a Invoice resource.", "description": "Retrieves a Invoice resource.", "parameters": [ { "name": "id", "in": "path", "description": "Resource identifier", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "deprecated": false }, "parameters": [] }, "/items": { "get": { "operationId": "getItemCollection", "tags": [ "Item" ], "responses": { "200": { "description": "Item collection", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Item" } } }, "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Item" } } }, "text/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Item" } } }, "text/csv": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Item" } } }, "text/html": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Item" } } } } } }, "summary": "Retrieves the collection of Item resources.", "description": "Retrieves the collection of Item resources.", "parameters": [ { "name": "page", "in": "query", "description": "The collection page number", "required": false, "deprecated": false, "allowEmptyValue": true, "schema": { "type": "integer", "default": 1 }, "style": "form", "explode": false, "allowReserved": false }, { "name": "itemsPerPage", "in": "query", "description": "The number of items per page", "required": false, "deprecated": false, "allowEmptyValue": true, "schema": { "type": "integer", "default": 100, "minimum": 0, "maximum": 200 }, "style": "form", "explode": false, "allowReserved": false } ], "deprecated": false }, "parameters": [] }, "/items/{id}": { "get": { "operationId": "getItemItem", "tags": [ "Item" ], "responses": { "200": { "description": "Item resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Item" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/Item" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/Item" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/Item" } }, "text/html": { "schema": { "$ref": "#/components/schemas/Item" } } } }, "404": { "description": "Resource not found" } }, "summary": "Retrieves a Item resource.", "description": "Retrieves a Item resource.", "parameters": [ { "name": "id", "in": "path", "description": "Resource identifier", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "deprecated": false }, "parameters": [] }, "/journal_lines": { "get": { "operationId": "getJournalLineCollection", "tags": [ "JournalLine" ], "responses": { "200": { "description": "JournalLine collection", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/JournalLine" } } }, "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/JournalLine" } } }, "text/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/JournalLine" } } }, "text/csv": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/JournalLine" } } }, "text/html": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/JournalLine" } } } } } }, "summary": "Retrieves the collection of JournalLine resources.", "description": "Retrieves the collection of JournalLine resources.", "parameters": [ { "name": "page", "in": "query", "description": "The collection page number", "required": false, "deprecated": false, "allowEmptyValue": true, "schema": { "type": "integer", "default": 1 }, "style": "form", "explode": false, "allowReserved": false }, { "name": "itemsPerPage", "in": "query", "description": "The number of items per page", "required": false, "deprecated": false, "allowEmptyValue": true, "schema": { "type": "integer", "default": 100, "minimum": 0, "maximum": 200 }, "style": "form", "explode": false, "allowReserved": false }, { "name": "journalId", "in": "query", "description": "", "required": false, "deprecated": false, "allowEmptyValue": true, "schema": { "type": "string" }, "style": "form", "explode": false, "allowReserved": false }, { "name": "journalId[]", "in": "query", "description": "", "required": false, "deprecated": false, "allowEmptyValue": true, "schema": { "type": "array", "items": { "type": "string" } }, "style": "form", "explode": true, "allowReserved": false } ], "deprecated": false }, "parameters": [] }, "/journal_lines/{id}": { "get": { "operationId": "getJournalLineItem", "tags": [ "JournalLine" ], "responses": { "200": { "description": "JournalLine resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JournalLine" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/JournalLine" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/JournalLine" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/JournalLine" } }, "text/html": { "schema": { "$ref": "#/components/schemas/JournalLine" } } } }, "404": { "description": "Resource not found" } }, "summary": "Retrieves a JournalLine resource.", "description": "Retrieves a JournalLine resource.", "parameters": [ { "name": "id", "in": "path", "description": "Resource identifier", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "deprecated": false }, "parameters": [] }, "/journals": { "get": { "operationId": "getJournalCollection", "tags": [ "Journal" ], "responses": { "200": { "description": "Journal collection", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Journal" } } }, "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Journal" } } }, "text/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Journal" } } }, "text/csv": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Journal" } } }, "text/html": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Journal" } } } } } }, "summary": "Retrieves the collection of Journal resources.", "description": "Retrieves the collection of Journal resources.", "parameters": [ { "name": "page", "in": "query", "description": "The collection page number", "required": false, "deprecated": false, "allowEmptyValue": true, "schema": { "type": "integer", "default": 1 }, "style": "form", "explode": false, "allowReserved": false }, { "name": "itemsPerPage", "in": "query", "description": "The number of items per page", "required": false, "deprecated": false, "allowEmptyValue": true, "schema": { "type": "integer", "default": 100, "minimum": 0, "maximum": 200 }, "style": "form", "explode": false, "allowReserved": false } ], "deprecated": false }, "parameters": [] }, "/journals/{id}": { "get": { "operationId": "getJournalItem", "tags": [ "Journal" ], "responses": { "200": { "description": "Journal resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Journal" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/Journal" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/Journal" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/Journal" } }, "text/html": { "schema": { "$ref": "#/components/schemas/Journal" } } } }, "404": { "description": "Resource not found" } }, "summary": "Retrieves a Journal resource.", "description": "Retrieves a Journal resource.", "parameters": [ { "name": "id", "in": "path", "description": "Resource identifier", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "deprecated": false }, "parameters": [] }, "/leads": { "get": { "operationId": "getLeadCollection", "tags": [ "Lead" ], "responses": { "200": { "description": "Lead collection", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Lead" } } }, "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Lead" } } }, "text/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Lead" } } }, "text/csv": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Lead" } } }, "text/html": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Lead" } } } } } }, "summary": "Retrieves the collection of Lead resources.", "description": "Retrieves the collection of Lead resources.", "parameters": [ { "name": "page", "in": "query", "description": "The collection page number", "required": false, "deprecated": false, "allowEmptyValue": true, "schema": { "type": "integer", "default": 1 }, "style": "form", "explode": false, "allowReserved": false }, { "name": "itemsPerPage", "in": "query", "description": "The number of items per page", "required": false, "deprecated": false, "allowEmptyValue": true, "schema": { "type": "integer", "default": 100, "minimum": 0, "maximum": 200 }, "style": "form", "explode": false, "allowReserved": false } ], "deprecated": false }, "post": { "operationId": "postLeadCollection", "tags": [ "Lead" ], "responses": { "201": { "description": "Lead resource created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Lead" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/Lead" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/Lead" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/Lead" } }, "text/html": { "schema": { "$ref": "#/components/schemas/Lead" } } }, "links": { "GetLeadItem": { "operationId": "getLeadItem", "parameters": { "id": "$response.body#/id" }, "description": "The `id` value returned in the response can be used as the `id` parameter in `GET /leads/{id}`." } } }, "400": { "description": "Invalid input" }, "422": { "description": "Unprocessable entity" } }, "summary": "Creates a Lead resource.", "description": "Creates a Lead resource.", "parameters": [], "requestBody": { "description": "The new Lead resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Lead" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/Lead" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/Lead" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/Lead" } }, "text/html": { "schema": { "$ref": "#/components/schemas/Lead" } } }, "required": true }, "deprecated": false }, "parameters": [] }, "/leads/{id}": { "get": { "operationId": "getLeadItem", "tags": [ "Lead" ], "responses": { "200": { "description": "Lead resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Lead" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/Lead" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/Lead" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/Lead" } }, "text/html": { "schema": { "$ref": "#/components/schemas/Lead" } } } }, "404": { "description": "Resource not found" } }, "summary": "Retrieves a Lead resource.", "description": "Retrieves a Lead resource.", "parameters": [ { "name": "id", "in": "path", "description": "Resource identifier", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "deprecated": false }, "put": { "operationId": "putLeadItem", "tags": [ "Lead" ], "responses": { "200": { "description": "Lead resource updated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Lead" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/Lead" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/Lead" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/Lead" } }, "text/html": { "schema": { "$ref": "#/components/schemas/Lead" } } }, "links": { "GetLeadItem": { "operationId": "getLeadItem", "parameters": { "id": "$response.body#/id" }, "description": "The `id` value returned in the response can be used as the `id` parameter in `GET /leads/{id}`." } } }, "400": { "description": "Invalid input" }, "422": { "description": "Unprocessable entity" }, "404": { "description": "Resource not found" } }, "summary": "Replaces the Lead resource.", "description": "Replaces the Lead resource.", "parameters": [ { "name": "id", "in": "path", "description": "Resource identifier", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "requestBody": { "description": "The updated Lead resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Lead" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/Lead" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/Lead" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/Lead" } }, "text/html": { "schema": { "$ref": "#/components/schemas/Lead" } } }, "required": true }, "deprecated": false }, "delete": { "operationId": "deleteLeadItem", "tags": [ "Lead" ], "responses": { "204": { "description": "Lead resource deleted" }, "404": { "description": "Resource not found" } }, "summary": "Removes the Lead resource.", "description": "Removes the Lead resource.", "parameters": [ { "name": "id", "in": "path", "description": "Resource identifier", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "deprecated": false }, "parameters": [] }, "/ledger_account_opening_balances": { "get": { "operationId": "getLedgerAccountOpeningBalanceCollection", "tags": [ "LedgerAccountOpeningBalance" ], "responses": { "200": { "description": "LedgerAccountOpeningBalance collection", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/LedgerAccountOpeningBalance" } } }, "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/LedgerAccountOpeningBalance" } } }, "text/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/LedgerAccountOpeningBalance" } } }, "text/csv": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/LedgerAccountOpeningBalance" } } }, "text/html": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/LedgerAccountOpeningBalance" } } } } } }, "summary": "Retrieves the collection of LedgerAccountOpeningBalance resources.", "description": "Retrieves the collection of LedgerAccountOpeningBalance resources.", "parameters": [ { "name": "page", "in": "query", "description": "The collection page number", "required": false, "deprecated": false, "allowEmptyValue": true, "schema": { "type": "integer", "default": 1 }, "style": "form", "explode": false, "allowReserved": false }, { "name": "itemsPerPage", "in": "query", "description": "The number of items per page", "required": false, "deprecated": false, "allowEmptyValue": true, "schema": { "type": "integer", "default": 100, "minimum": 0, "maximum": 200 }, "style": "form", "explode": false, "allowReserved": false } ], "deprecated": false }, "parameters": [] }, "/ledger_account_opening_balances/{id}": { "get": { "operationId": "getLedgerAccountOpeningBalanceItem", "tags": [ "LedgerAccountOpeningBalance" ], "responses": { "200": { "description": "LedgerAccountOpeningBalance resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LedgerAccountOpeningBalance" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/LedgerAccountOpeningBalance" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/LedgerAccountOpeningBalance" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/LedgerAccountOpeningBalance" } }, "text/html": { "schema": { "$ref": "#/components/schemas/LedgerAccountOpeningBalance" } } } }, "404": { "description": "Resource not found" } }, "summary": "Retrieves a LedgerAccountOpeningBalance resource.", "description": "Retrieves a LedgerAccountOpeningBalance resource.", "parameters": [ { "name": "id", "in": "path", "description": "Resource identifier", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "deprecated": false }, "parameters": [] }, "/ledger_account_types": { "get": { "operationId": "getLedgerAccountTypeCollection", "tags": [ "LedgerAccountType" ], "responses": { "200": { "description": "LedgerAccountType collection", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/LedgerAccountType" } } }, "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/LedgerAccountType" } } }, "text/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/LedgerAccountType" } } }, "text/csv": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/LedgerAccountType" } } }, "text/html": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/LedgerAccountType" } } } } } }, "summary": "Retrieves the collection of LedgerAccountType resources.", "description": "Retrieves the collection of LedgerAccountType resources.", "parameters": [ { "name": "page", "in": "query", "description": "The collection page number", "required": false, "deprecated": false, "allowEmptyValue": true, "schema": { "type": "integer", "default": 1 }, "style": "form", "explode": false, "allowReserved": false }, { "name": "itemsPerPage", "in": "query", "description": "The number of items per page", "required": false, "deprecated": false, "allowEmptyValue": true, "schema": { "type": "integer", "default": 100, "minimum": 0, "maximum": 200 }, "style": "form", "explode": false, "allowReserved": false } ], "deprecated": false }, "parameters": [] }, "/ledger_account_types/{id}": { "get": { "operationId": "getLedgerAccountTypeItem", "tags": [ "LedgerAccountType" ], "responses": { "200": { "description": "LedgerAccountType resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LedgerAccountType" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/LedgerAccountType" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/LedgerAccountType" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/LedgerAccountType" } }, "text/html": { "schema": { "$ref": "#/components/schemas/LedgerAccountType" } } } }, "404": { "description": "Resource not found" } }, "summary": "Retrieves a LedgerAccountType resource.", "description": "Retrieves a LedgerAccountType resource.", "parameters": [ { "name": "id", "in": "path", "description": "Resource identifier", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "deprecated": false }, "parameters": [] }, "/ledger_accounts": { "get": { "operationId": "getLedgerAccountsCollection", "tags": [ "LedgerAccounts" ], "responses": { "200": { "description": "LedgerAccounts collection", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/LedgerAccounts" } } }, "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/LedgerAccounts" } } }, "text/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/LedgerAccounts" } } }, "text/csv": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/LedgerAccounts" } } }, "text/html": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/LedgerAccounts" } } } } } }, "summary": "Retrieves the collection of LedgerAccounts resources.", "description": "Retrieves the collection of LedgerAccounts resources.", "parameters": [ { "name": "page", "in": "query", "description": "The collection page number", "required": false, "deprecated": false, "allowEmptyValue": true, "schema": { "type": "integer", "default": 1 }, "style": "form", "explode": false, "allowReserved": false }, { "name": "itemsPerPage", "in": "query", "description": "The number of items per page", "required": false, "deprecated": false, "allowEmptyValue": true, "schema": { "type": "integer", "default": 100, "minimum": 0, "maximum": 200 }, "style": "form", "explode": false, "allowReserved": false } ], "deprecated": false }, "parameters": [] }, "/ledger_accounts/{id}": { "get": { "operationId": "getLedgerAccountsItem", "tags": [ "LedgerAccounts" ], "responses": { "200": { "description": "LedgerAccounts resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LedgerAccounts" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/LedgerAccounts" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/LedgerAccounts" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/LedgerAccounts" } }, "text/html": { "schema": { "$ref": "#/components/schemas/LedgerAccounts" } } } }, "404": { "description": "Resource not found" } }, "summary": "Retrieves a LedgerAccounts resource.", "description": "Retrieves a LedgerAccounts resource.", "parameters": [ { "name": "id", "in": "path", "description": "Resource identifier", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "deprecated": false }, "parameters": [] }, "/ledger_entries": { "get": { "operationId": "getLedgerEntryCollection", "tags": [ "LedgerEntry" ], "responses": { "200": { "description": "LedgerEntry collection", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/LedgerEntry" } } }, "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/LedgerEntry" } } }, "text/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/LedgerEntry" } } }, "text/csv": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/LedgerEntry" } } }, "text/html": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/LedgerEntry" } } } } } }, "summary": "Retrieves the collection of LedgerEntry resources.", "description": "Retrieves the collection of LedgerEntry resources.", "parameters": [ { "name": "page", "in": "query", "description": "The collection page number", "required": false, "deprecated": false, "allowEmptyValue": true, "schema": { "type": "integer", "default": 1 }, "style": "form", "explode": false, "allowReserved": false }, { "name": "itemsPerPage", "in": "query", "description": "The number of items per page", "required": false, "deprecated": false, "allowEmptyValue": true, "schema": { "type": "integer", "default": 100, "minimum": 0, "maximum": 200 }, "style": "form", "explode": false, "allowReserved": false } ], "deprecated": false }, "parameters": [] }, "/ledger_entries/{id}": { "get": { "operationId": "getLedgerEntryItem", "tags": [ "LedgerEntry" ], "responses": { "200": { "description": "LedgerEntry resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LedgerEntry" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/LedgerEntry" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/LedgerEntry" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/LedgerEntry" } }, "text/html": { "schema": { "$ref": "#/components/schemas/LedgerEntry" } } } }, "404": { "description": "Resource not found" } }, "summary": "Retrieves a LedgerEntry resource.", "description": "Retrieves a LedgerEntry resource.", "parameters": [ { "name": "id", "in": "path", "description": "Resource identifier", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "deprecated": false }, "parameters": [] }, "/linked_transactions": { "get": { "operationId": "getLinkedTransactionCollection", "tags": [ "LinkedTransaction" ], "responses": { "200": { "description": "LinkedTransaction collection", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/LinkedTransaction" } } }, "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/LinkedTransaction" } } }, "text/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/LinkedTransaction" } } }, "text/csv": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/LinkedTransaction" } } }, "text/html": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/LinkedTransaction" } } } } } }, "summary": "Retrieves the collection of LinkedTransaction resources.", "description": "Retrieves the collection of LinkedTransaction resources.", "parameters": [ { "name": "page", "in": "query", "description": "The collection page number", "required": false, "deprecated": false, "allowEmptyValue": true, "schema": { "type": "integer", "default": 1 }, "style": "form", "explode": false, "allowReserved": false }, { "name": "itemsPerPage", "in": "query", "description": "The number of items per page", "required": false, "deprecated": false, "allowEmptyValue": true, "schema": { "type": "integer", "default": 100, "minimum": 0, "maximum": 200 }, "style": "form", "explode": false, "allowReserved": false } ], "deprecated": false }, "parameters": [] }, "/linked_transactions/{id}": { "get": { "operationId": "getLinkedTransactionItem", "tags": [ "LinkedTransaction" ], "responses": { "200": { "description": "LinkedTransaction resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LinkedTransaction" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/LinkedTransaction" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/LinkedTransaction" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/LinkedTransaction" } }, "text/html": { "schema": { "$ref": "#/components/schemas/LinkedTransaction" } } } }, "404": { "description": "Resource not found" } }, "summary": "Retrieves a LinkedTransaction resource.", "description": "Retrieves a LinkedTransaction resource.", "parameters": [ { "name": "id", "in": "path", "description": "Resource identifier", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "deprecated": false }, "parameters": [] }, "/locations": { "get": { "operationId": "getLocationCollection", "tags": [ "Location" ], "responses": { "200": { "description": "Location collection", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Location" } } }, "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Location" } } }, "text/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Location" } } }, "text/csv": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Location" } } }, "text/html": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Location" } } } } } }, "summary": "Retrieves the collection of Location resources.", "description": "Retrieves the collection of Location resources.", "parameters": [ { "name": "page", "in": "query", "description": "The collection page number", "required": false, "deprecated": false, "allowEmptyValue": true, "schema": { "type": "integer", "default": 1 }, "style": "form", "explode": false, "allowReserved": false }, { "name": "itemsPerPage", "in": "query", "description": "The number of items per page", "required": false, "deprecated": false, "allowEmptyValue": true, "schema": { "type": "integer", "default": 100, "minimum": 0, "maximum": 200 }, "style": "form", "explode": false, "allowReserved": false } ], "deprecated": false }, "post": { "operationId": "postLocationCollection", "tags": [ "Location" ], "responses": { "201": { "description": "Location resource created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Location" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/Location" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/Location" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/Location" } }, "text/html": { "schema": { "$ref": "#/components/schemas/Location" } } }, "links": { "GetLocationItem": { "operationId": "getLocationItem", "parameters": { "id": "$response.body#/id" }, "description": "The `id` value returned in the response can be used as the `id` parameter in `GET /locations/{id}`." } } }, "400": { "description": "Invalid input" }, "422": { "description": "Unprocessable entity" } }, "summary": "Creates a Location resource.", "description": "Creates a Location resource.", "parameters": [], "requestBody": { "description": "The new Location resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Location" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/Location" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/Location" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/Location" } }, "text/html": { "schema": { "$ref": "#/components/schemas/Location" } } }, "required": true }, "deprecated": false }, "parameters": [] }, "/locations/{id}": { "get": { "operationId": "getLocationItem", "tags": [ "Location" ], "responses": { "200": { "description": "Location resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Location" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/Location" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/Location" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/Location" } }, "text/html": { "schema": { "$ref": "#/components/schemas/Location" } } } }, "404": { "description": "Resource not found" } }, "summary": "Retrieves a Location resource.", "description": "Retrieves a Location resource.", "parameters": [ { "name": "id", "in": "path", "description": "Resource identifier", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "deprecated": false }, "put": { "operationId": "putLocationItem", "tags": [ "Location" ], "responses": { "200": { "description": "Location resource updated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Location" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/Location" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/Location" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/Location" } }, "text/html": { "schema": { "$ref": "#/components/schemas/Location" } } }, "links": { "GetLocationItem": { "operationId": "getLocationItem", "parameters": { "id": "$response.body#/id" }, "description": "The `id` value returned in the response can be used as the `id` parameter in `GET /locations/{id}`." } } }, "400": { "description": "Invalid input" }, "422": { "description": "Unprocessable entity" }, "404": { "description": "Resource not found" } }, "summary": "Replaces the Location resource.", "description": "Replaces the Location resource.", "parameters": [ { "name": "id", "in": "path", "description": "Resource identifier", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "requestBody": { "description": "The updated Location resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Location" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/Location" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/Location" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/Location" } }, "text/html": { "schema": { "$ref": "#/components/schemas/Location" } } }, "required": true }, "deprecated": false }, "delete": { "operationId": "deleteLocationItem", "tags": [ "Location" ], "responses": { "204": { "description": "Location resource deleted" }, "404": { "description": "Resource not found" } }, "summary": "Removes the Location resource.", "description": "Removes the Location resource.", "parameters": [ { "name": "id", "in": "path", "description": "Resource identifier", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "deprecated": false }, "parameters": [] }, "/manual_journals": { "get": { "operationId": "getManualJournalCollection", "tags": [ "ManualJournal" ], "responses": { "200": { "description": "ManualJournal collection", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ManualJournal" } } }, "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ManualJournal" } } }, "text/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ManualJournal" } } }, "text/csv": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ManualJournal" } } }, "text/html": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ManualJournal" } } } } } }, "summary": "Retrieves the collection of ManualJournal resources.", "description": "Retrieves the collection of ManualJournal resources.", "parameters": [ { "name": "page", "in": "query", "description": "The collection page number", "required": false, "deprecated": false, "allowEmptyValue": true, "schema": { "type": "integer", "default": 1 }, "style": "form", "explode": false, "allowReserved": false }, { "name": "itemsPerPage", "in": "query", "description": "The number of items per page", "required": false, "deprecated": false, "allowEmptyValue": true, "schema": { "type": "integer", "default": 100, "minimum": 0, "maximum": 200 }, "style": "form", "explode": false, "allowReserved": false } ], "deprecated": false }, "parameters": [] }, "/manual_journals/{id}": { "get": { "operationId": "getManualJournalItem", "tags": [ "ManualJournal" ], "responses": { "200": { "description": "ManualJournal resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManualJournal" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ManualJournal" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ManualJournal" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/ManualJournal" } }, "text/html": { "schema": { "$ref": "#/components/schemas/ManualJournal" } } } }, "404": { "description": "Resource not found" } }, "summary": "Retrieves a ManualJournal resource.", "description": "Retrieves a ManualJournal resource.", "parameters": [ { "name": "id", "in": "path", "description": "Resource identifier", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "deprecated": false }, "parameters": [] }, "/metrics": { "get": { "operationId": "getMetricsItem", "tags": [ "Metrics" ], "responses": { "200": { "description": "Metrics resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Metrics" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/Metrics" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/Metrics" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/Metrics" } }, "text/html": { "schema": { "$ref": "#/components/schemas/Metrics" } } } }, "404": { "description": "Resource not found" } }, "summary": "Retrieves a set of metrics", "description": "Retrieves a Metrics resource.", "parameters": [ { "name": "start", "in": "query", "description": "YYYY-MM-DD", "required": false, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string", "format": "date-time" }, "style": "form", "explode": false, "allowReserved": false, "example": "2022-07-01" }, { "name": "end", "in": "query", "description": "YYYY-MM-DD", "required": false, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string", "format": "date-time" }, "style": "form", "explode": false, "allowReserved": false, "example": "2022-08-31" }, { "name": "refresh", "in": "query", "description": "If refresh is set, data will be fetched from the source application even when cached data is available", "required": false, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "form", "explode": false, "allowReserved": false, "example": "true" } ], "deprecated": false }, "parameters": [] }, "/order_returns": { "get": { "operationId": "getOrderReturnCollection", "tags": [ "OrderReturn" ], "responses": { "200": { "description": "OrderReturn collection", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OrderReturn" } } }, "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OrderReturn" } } }, "text/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OrderReturn" } } }, "text/csv": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OrderReturn" } } }, "text/html": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OrderReturn" } } } } } }, "summary": "Retrieves the collection of OrderReturn resources.", "description": "Retrieves the collection of OrderReturn resources.", "parameters": [ { "name": "page", "in": "query", "description": "The collection page number", "required": false, "deprecated": false, "allowEmptyValue": true, "schema": { "type": "integer", "default": 1 }, "style": "form", "explode": false, "allowReserved": false }, { "name": "itemsPerPage", "in": "query", "description": "The number of items per page", "required": false, "deprecated": false, "allowEmptyValue": true, "schema": { "type": "integer", "default": 100, "minimum": 0, "maximum": 200 }, "style": "form", "explode": false, "allowReserved": false } ], "deprecated": false }, "parameters": [] }, "/order_returns/{id}": { "get": { "operationId": "getOrderReturnItem", "tags": [ "OrderReturn" ], "responses": { "200": { "description": "OrderReturn resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrderReturn" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/OrderReturn" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/OrderReturn" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/OrderReturn" } }, "text/html": { "schema": { "$ref": "#/components/schemas/OrderReturn" } } } }, "404": { "description": "Resource not found" } }, "summary": "Retrieves a OrderReturn resource.", "description": "Retrieves a OrderReturn resource.", "parameters": [ { "name": "id", "in": "path", "description": "Resource identifier", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "deprecated": false }, "parameters": [] }, "/orders": { "get": { "operationId": "getOrderCollection", "tags": [ "Order" ], "responses": { "200": { "description": "Order collection", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Order" } } }, "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Order" } } }, "text/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Order" } } }, "text/csv": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Order" } } }, "text/html": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Order" } } } } } }, "summary": "Retrieves the collection of Order resources.", "description": "Retrieves the collection of Order resources.", "parameters": [ { "name": "page", "in": "query", "description": "The collection page number", "required": false, "deprecated": false, "allowEmptyValue": true, "schema": { "type": "integer", "default": 1 }, "style": "form", "explode": false, "allowReserved": false }, { "name": "itemsPerPage", "in": "query", "description": "The number of items per page", "required": false, "deprecated": false, "allowEmptyValue": true, "schema": { "type": "integer", "default": 100, "minimum": 0, "maximum": 200 }, "style": "form", "explode": false, "allowReserved": false } ], "deprecated": false }, "post": { "operationId": "postOrderCollection", "tags": [ "Order" ], "responses": { "201": { "description": "Order resource created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Order" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/Order" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/Order" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/Order" } }, "text/html": { "schema": { "$ref": "#/components/schemas/Order" } } }, "links": { "GetOrderItem": { "operationId": "getOrderItem", "parameters": { "id": "$response.body#/id" }, "description": "The `id` value returned in the response can be used as the `id` parameter in `GET /orders/{id}`." } } }, "400": { "description": "Invalid input" }, "422": { "description": "Unprocessable entity" } }, "summary": "Creates a Order resource.", "description": "Creates a Order resource.", "parameters": [], "requestBody": { "description": "The new Order resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Order" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/Order" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/Order" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/Order" } }, "text/html": { "schema": { "$ref": "#/components/schemas/Order" } } }, "required": true }, "deprecated": false }, "parameters": [] }, "/orders/{id}": { "get": { "operationId": "getOrderItem", "tags": [ "Order" ], "responses": { "200": { "description": "Order resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Order" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/Order" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/Order" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/Order" } }, "text/html": { "schema": { "$ref": "#/components/schemas/Order" } } } }, "404": { "description": "Resource not found" } }, "summary": "Retrieves a Order resource.", "description": "Retrieves a Order resource.", "parameters": [ { "name": "id", "in": "path", "description": "Resource identifier", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "deprecated": false }, "put": { "operationId": "putOrderItem", "tags": [ "Order" ], "responses": { "200": { "description": "Order resource updated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Order" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/Order" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/Order" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/Order" } }, "text/html": { "schema": { "$ref": "#/components/schemas/Order" } } }, "links": { "GetOrderItem": { "operationId": "getOrderItem", "parameters": { "id": "$response.body#/id" }, "description": "The `id` value returned in the response can be used as the `id` parameter in `GET /orders/{id}`." } } }, "400": { "description": "Invalid input" }, "422": { "description": "Unprocessable entity" }, "404": { "description": "Resource not found" } }, "summary": "Replaces the Order resource.", "description": "Replaces the Order resource.", "parameters": [ { "name": "id", "in": "path", "description": "Resource identifier", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "requestBody": { "description": "The updated Order resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Order" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/Order" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/Order" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/Order" } }, "text/html": { "schema": { "$ref": "#/components/schemas/Order" } } }, "required": true }, "deprecated": false }, "delete": { "operationId": "deleteOrderItem", "tags": [ "Order" ], "responses": { "204": { "description": "Order resource deleted" }, "404": { "description": "Resource not found" } }, "summary": "Removes the Order resource.", "description": "Removes the Order resource.", "parameters": [ { "name": "id", "in": "path", "description": "Resource identifier", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "deprecated": false }, "parameters": [] }, "/organizations": { "get": { "operationId": "getOrganizationCollection", "tags": [ "Organization" ], "responses": { "200": { "description": "Organization collection", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Organization" } } }, "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Organization" } } }, "text/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Organization" } } }, "text/csv": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Organization" } } }, "text/html": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Organization" } } } } } }, "summary": "Retrieves the collection of Organization resources.", "description": "Retrieves the collection of Organization resources.", "parameters": [ { "name": "page", "in": "query", "description": "The collection page number", "required": false, "deprecated": false, "allowEmptyValue": true, "schema": { "type": "integer", "default": 1 }, "style": "form", "explode": false, "allowReserved": false }, { "name": "itemsPerPage", "in": "query", "description": "The number of items per page", "required": false, "deprecated": false, "allowEmptyValue": true, "schema": { "type": "integer", "default": 100, "minimum": 0, "maximum": 200 }, "style": "form", "explode": false, "allowReserved": false } ], "deprecated": false }, "parameters": [] }, "/organizations/{id}": { "get": { "operationId": "getOrganizationItem", "tags": [ "Organization" ], "responses": { "200": { "description": "Organization resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Organization" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/Organization" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/Organization" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/Organization" } }, "text/html": { "schema": { "$ref": "#/components/schemas/Organization" } } } }, "404": { "description": "Resource not found" } }, "summary": "Retrieves a Organization resource.", "description": "Retrieves a Organization resource.", "parameters": [ { "name": "id", "in": "path", "description": "Resource identifier", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "deprecated": false }, "parameters": [] }, "/other_incomes": { "get": { "operationId": "getOtherIncomeCollection", "tags": [ "OtherIncome" ], "responses": { "200": { "description": "OtherIncome collection", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OtherIncome" } } }, "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OtherIncome" } } }, "text/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OtherIncome" } } }, "text/csv": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OtherIncome" } } }, "text/html": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OtherIncome" } } } } } }, "summary": "Retrieves the collection of OtherIncome resources.", "description": "Retrieves the collection of OtherIncome resources.", "parameters": [ { "name": "page", "in": "query", "description": "The collection page number", "required": false, "deprecated": false, "allowEmptyValue": true, "schema": { "type": "integer", "default": 1 }, "style": "form", "explode": false, "allowReserved": false }, { "name": "itemsPerPage", "in": "query", "description": "The number of items per page", "required": false, "deprecated": false, "allowEmptyValue": true, "schema": { "type": "integer", "default": 100, "minimum": 0, "maximum": 200 }, "style": "form", "explode": false, "allowReserved": false } ], "deprecated": false }, "parameters": [] }, "/other_incomes/{id}": { "get": { "operationId": "getOtherIncomeItem", "tags": [ "OtherIncome" ], "responses": { "200": { "description": "OtherIncome resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OtherIncome" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/OtherIncome" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/OtherIncome" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/OtherIncome" } }, "text/html": { "schema": { "$ref": "#/components/schemas/OtherIncome" } } } }, "404": { "description": "Resource not found" } }, "summary": "Retrieves a OtherIncome resource.", "description": "Retrieves a OtherIncome resource.", "parameters": [ { "name": "id", "in": "path", "description": "Resource identifier", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "deprecated": false }, "parameters": [] }, "/owners": { "get": { "operationId": "getOwnerCollection", "tags": [ "Owner" ], "responses": { "200": { "description": "Owner collection", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Owner" } } }, "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Owner" } } }, "text/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Owner" } } }, "text/csv": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Owner" } } }, "text/html": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Owner" } } } } } }, "summary": "Retrieves the collection of Owner resources.", "description": "Retrieves the collection of Owner resources.", "parameters": [ { "name": "page", "in": "query", "description": "The collection page number", "required": false, "deprecated": false, "allowEmptyValue": true, "schema": { "type": "integer", "default": 1 }, "style": "form", "explode": false, "allowReserved": false }, { "name": "itemsPerPage", "in": "query", "description": "The number of items per page", "required": false, "deprecated": false, "allowEmptyValue": true, "schema": { "type": "integer", "default": 100, "minimum": 0, "maximum": 200 }, "style": "form", "explode": false, "allowReserved": false } ], "deprecated": false }, "parameters": [] }, "/owners/{id}": { "get": { "operationId": "getOwnerItem", "tags": [ "Owner" ], "responses": { "200": { "description": "Owner resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Owner" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/Owner" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/Owner" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/Owner" } }, "text/html": { "schema": { "$ref": "#/components/schemas/Owner" } } } }, "404": { "description": "Resource not found" } }, "summary": "Retrieves a Owner resource.", "description": "Retrieves a Owner resource.", "parameters": [ { "name": "id", "in": "path", "description": "Resource identifier", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "deprecated": false }, "parameters": [] }, "/payment_intents": { "get": { "operationId": "getPaymentIntentCollection", "tags": [ "PaymentIntent" ], "responses": { "200": { "description": "PaymentIntent collection", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PaymentIntent" } } }, "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PaymentIntent" } } }, "text/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PaymentIntent" } } }, "text/csv": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PaymentIntent" } } }, "text/html": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PaymentIntent" } } } } } }, "summary": "Retrieves the collection of PaymentIntent resources.", "description": "Retrieves the collection of PaymentIntent resources.", "parameters": [ { "name": "page", "in": "query", "description": "The collection page number", "required": false, "deprecated": false, "allowEmptyValue": true, "schema": { "type": "integer", "default": 1 }, "style": "form", "explode": false, "allowReserved": false }, { "name": "itemsPerPage", "in": "query", "description": "The number of items per page", "required": false, "deprecated": false, "allowEmptyValue": true, "schema": { "type": "integer", "default": 100, "minimum": 0, "maximum": 200 }, "style": "form", "explode": false, "allowReserved": false } ], "deprecated": false }, "parameters": [] }, "/payment_intents/{id}": { "get": { "operationId": "getPaymentIntentItem", "tags": [ "PaymentIntent" ], "responses": { "200": { "description": "PaymentIntent resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentIntent" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/PaymentIntent" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/PaymentIntent" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/PaymentIntent" } }, "text/html": { "schema": { "$ref": "#/components/schemas/PaymentIntent" } } } }, "404": { "description": "Resource not found" } }, "summary": "Retrieves a PaymentIntent resource.", "description": "Retrieves a PaymentIntent resource.", "parameters": [ { "name": "id", "in": "path", "description": "Resource identifier", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "deprecated": false }, "parameters": [] }, "/payment_methods": { "get": { "operationId": "getPaymentMethodCollection", "tags": [ "PaymentMethod" ], "responses": { "200": { "description": "PaymentMethod collection", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PaymentMethod" } } }, "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PaymentMethod" } } }, "text/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PaymentMethod" } } }, "text/csv": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PaymentMethod" } } }, "text/html": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PaymentMethod" } } } } } }, "summary": "Retrieves the collection of PaymentMethod resources.", "description": "Retrieves the collection of PaymentMethod resources.", "parameters": [ { "name": "page", "in": "query", "description": "The collection page number", "required": false, "deprecated": false, "allowEmptyValue": true, "schema": { "type": "integer", "default": 1 }, "style": "form", "explode": false, "allowReserved": false }, { "name": "itemsPerPage", "in": "query", "description": "The number of items per page", "required": false, "deprecated": false, "allowEmptyValue": true, "schema": { "type": "integer", "default": 100, "minimum": 0, "maximum": 200 }, "style": "form", "explode": false, "allowReserved": false } ], "deprecated": false }, "post": { "operationId": "postPaymentMethodCollection", "tags": [ "PaymentMethod" ], "responses": { "201": { "description": "PaymentMethod resource created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentMethod" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/PaymentMethod" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/PaymentMethod" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/PaymentMethod" } }, "text/html": { "schema": { "$ref": "#/components/schemas/PaymentMethod" } } }, "links": { "GetPaymentMethodItem": { "operationId": "getPaymentMethodItem", "parameters": { "id": "$response.body#/id" }, "description": "The `id` value returned in the response can be used as the `id` parameter in `GET /payment_methods/{id}`." } } }, "400": { "description": "Invalid input" }, "422": { "description": "Unprocessable entity" } }, "summary": "Creates a PaymentMethod resource.", "description": "Creates a PaymentMethod resource.", "parameters": [], "requestBody": { "description": "The new PaymentMethod resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentMethod" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/PaymentMethod" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/PaymentMethod" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/PaymentMethod" } }, "text/html": { "schema": { "$ref": "#/components/schemas/PaymentMethod" } } }, "required": true }, "deprecated": false }, "parameters": [] }, "/payment_methods/{id}": { "get": { "operationId": "getPaymentMethodItem", "tags": [ "PaymentMethod" ], "responses": { "200": { "description": "PaymentMethod resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentMethod" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/PaymentMethod" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/PaymentMethod" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/PaymentMethod" } }, "text/html": { "schema": { "$ref": "#/components/schemas/PaymentMethod" } } } }, "404": { "description": "Resource not found" } }, "summary": "Retrieves a PaymentMethod resource.", "description": "Retrieves a PaymentMethod resource.", "parameters": [ { "name": "id", "in": "path", "description": "Resource identifier", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "deprecated": false }, "put": { "operationId": "putPaymentMethodItem", "tags": [ "PaymentMethod" ], "responses": { "200": { "description": "PaymentMethod resource updated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentMethod" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/PaymentMethod" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/PaymentMethod" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/PaymentMethod" } }, "text/html": { "schema": { "$ref": "#/components/schemas/PaymentMethod" } } }, "links": { "GetPaymentMethodItem": { "operationId": "getPaymentMethodItem", "parameters": { "id": "$response.body#/id" }, "description": "The `id` value returned in the response can be used as the `id` parameter in `GET /payment_methods/{id}`." } } }, "400": { "description": "Invalid input" }, "422": { "description": "Unprocessable entity" }, "404": { "description": "Resource not found" } }, "summary": "Replaces the PaymentMethod resource.", "description": "Replaces the PaymentMethod resource.", "parameters": [ { "name": "id", "in": "path", "description": "Resource identifier", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "requestBody": { "description": "The updated PaymentMethod resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentMethod" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/PaymentMethod" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/PaymentMethod" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/PaymentMethod" } }, "text/html": { "schema": { "$ref": "#/components/schemas/PaymentMethod" } } }, "required": true }, "deprecated": false }, "delete": { "operationId": "deletePaymentMethodItem", "tags": [ "PaymentMethod" ], "responses": { "204": { "description": "PaymentMethod resource deleted" }, "404": { "description": "Resource not found" } }, "summary": "Removes the PaymentMethod resource.", "description": "Removes the PaymentMethod resource.", "parameters": [ { "name": "id", "in": "path", "description": "Resource identifier", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "deprecated": false }, "parameters": [] }, "/payment_services": { "get": { "operationId": "getPaymentServiceCollection", "tags": [ "PaymentService" ], "responses": { "200": { "description": "PaymentService collection", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PaymentService" } } }, "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PaymentService" } } }, "text/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PaymentService" } } }, "text/csv": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PaymentService" } } }, "text/html": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PaymentService" } } } } } }, "summary": "Retrieves the collection of PaymentService resources.", "description": "Retrieves the collection of PaymentService resources.", "parameters": [ { "name": "page", "in": "query", "description": "The collection page number", "required": false, "deprecated": false, "allowEmptyValue": true, "schema": { "type": "integer", "default": 1 }, "style": "form", "explode": false, "allowReserved": false }, { "name": "itemsPerPage", "in": "query", "description": "The number of items per page", "required": false, "deprecated": false, "allowEmptyValue": true, "schema": { "type": "integer", "default": 100, "minimum": 0, "maximum": 200 }, "style": "form", "explode": false, "allowReserved": false } ], "deprecated": false }, "parameters": [] }, "/payment_services/{id}": { "get": { "operationId": "getPaymentServiceItem", "tags": [ "PaymentService" ], "responses": { "200": { "description": "PaymentService resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentService" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/PaymentService" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/PaymentService" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/PaymentService" } }, "text/html": { "schema": { "$ref": "#/components/schemas/PaymentService" } } } }, "404": { "description": "Resource not found" } }, "summary": "Retrieves a PaymentService resource.", "description": "Retrieves a PaymentService resource.", "parameters": [ { "name": "id", "in": "path", "description": "Resource identifier", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "deprecated": false }, "parameters": [] }, "/payments": { "get": { "operationId": "getPaymentCollection", "tags": [ "Payment" ], "responses": { "200": { "description": "Payment collection", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Payment" } } }, "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Payment" } } }, "text/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Payment" } } }, "text/csv": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Payment" } } }, "text/html": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Payment" } } } } } }, "summary": "Retrieves the collection of Payment resources.", "description": "Retrieves the collection of Payment resources.", "parameters": [ { "name": "page", "in": "query", "description": "The collection page number", "required": false, "deprecated": false, "allowEmptyValue": true, "schema": { "type": "integer", "default": 1 }, "style": "form", "explode": false, "allowReserved": false }, { "name": "itemsPerPage", "in": "query", "description": "The number of items per page", "required": false, "deprecated": false, "allowEmptyValue": true, "schema": { "type": "integer", "default": 100, "minimum": 0, "maximum": 200 }, "style": "form", "explode": false, "allowReserved": false } ], "deprecated": false }, "post": { "operationId": "postPaymentCollection", "tags": [ "Payment" ], "responses": { "201": { "description": "Payment resource created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Payment" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/Payment" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/Payment" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/Payment" } }, "text/html": { "schema": { "$ref": "#/components/schemas/Payment" } } }, "links": { "GetPaymentItem": { "operationId": "getPaymentItem", "parameters": { "id": "$response.body#/id" }, "description": "The `id` value returned in the response can be used as the `id` parameter in `GET /payments/{id}`." } } }, "400": { "description": "Invalid input" }, "422": { "description": "Unprocessable entity" } }, "summary": "Creates a Payment resource.", "description": "Creates a Payment resource.", "parameters": [], "requestBody": { "description": "The new Payment resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Payment" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/Payment" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/Payment" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/Payment" } }, "text/html": { "schema": { "$ref": "#/components/schemas/Payment" } } }, "required": true }, "deprecated": false }, "parameters": [] }, "/payments/{id}": { "get": { "operationId": "getPaymentItem", "tags": [ "Payment" ], "responses": { "200": { "description": "Payment resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Payment" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/Payment" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/Payment" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/Payment" } }, "text/html": { "schema": { "$ref": "#/components/schemas/Payment" } } } }, "404": { "description": "Resource not found" } }, "summary": "Retrieves a Payment resource.", "description": "Retrieves a Payment resource.", "parameters": [ { "name": "id", "in": "path", "description": "Resource identifier", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "deprecated": false }, "put": { "operationId": "putPaymentItem", "tags": [ "Payment" ], "responses": { "200": { "description": "Payment resource updated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Payment" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/Payment" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/Payment" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/Payment" } }, "text/html": { "schema": { "$ref": "#/components/schemas/Payment" } } }, "links": { "GetPaymentItem": { "operationId": "getPaymentItem", "parameters": { "id": "$response.body#/id" }, "description": "The `id` value returned in the response can be used as the `id` parameter in `GET /payments/{id}`." } } }, "400": { "description": "Invalid input" }, "422": { "description": "Unprocessable entity" }, "404": { "description": "Resource not found" } }, "summary": "Replaces the Payment resource.", "description": "Replaces the Payment resource.", "parameters": [ { "name": "id", "in": "path", "description": "Resource identifier", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "requestBody": { "description": "The updated Payment resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Payment" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/Payment" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/Payment" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/Payment" } }, "text/html": { "schema": { "$ref": "#/components/schemas/Payment" } } }, "required": true }, "deprecated": false }, "delete": { "operationId": "deletePaymentItem", "tags": [ "Payment" ], "responses": { "204": { "description": "Payment resource deleted" }, "404": { "description": "Resource not found" } }, "summary": "Removes the Payment resource.", "description": "Removes the Payment resource.", "parameters": [ { "name": "id", "in": "path", "description": "Resource identifier", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "deprecated": false }, "parameters": [] }, "/payouts": { "get": { "operationId": "getPayoutCollection", "tags": [ "Payout" ], "responses": { "200": { "description": "Payout collection", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Payout" } } }, "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Payout" } } }, "text/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Payout" } } }, "text/csv": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Payout" } } }, "text/html": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Payout" } } } } } }, "summary": "Retrieves the collection of Payout resources.", "description": "Retrieves the collection of Payout resources.", "parameters": [ { "name": "page", "in": "query", "description": "The collection page number", "required": false, "deprecated": false, "allowEmptyValue": true, "schema": { "type": "integer", "default": 1 }, "style": "form", "explode": false, "allowReserved": false }, { "name": "itemsPerPage", "in": "query", "description": "The number of items per page", "required": false, "deprecated": false, "allowEmptyValue": true, "schema": { "type": "integer", "default": 100, "minimum": 0, "maximum": 200 }, "style": "form", "explode": false, "allowReserved": false } ], "deprecated": false }, "post": { "operationId": "postPayoutCollection", "tags": [ "Payout" ], "responses": { "201": { "description": "Payout resource created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Payout" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/Payout" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/Payout" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/Payout" } }, "text/html": { "schema": { "$ref": "#/components/schemas/Payout" } } }, "links": { "GetPayoutItem": { "operationId": "getPayoutItem", "parameters": { "id": "$response.body#/id" }, "description": "The `id` value returned in the response can be used as the `id` parameter in `GET /payouts/{id}`." } } }, "400": { "description": "Invalid input" }, "422": { "description": "Unprocessable entity" } }, "summary": "Creates a Payout resource.", "description": "Creates a Payout resource.", "parameters": [], "requestBody": { "description": "The new Payout resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Payout" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/Payout" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/Payout" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/Payout" } }, "text/html": { "schema": { "$ref": "#/components/schemas/Payout" } } }, "required": true }, "deprecated": false }, "parameters": [] }, "/payouts/{id}": { "get": { "operationId": "getPayoutItem", "tags": [ "Payout" ], "responses": { "200": { "description": "Payout resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Payout" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/Payout" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/Payout" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/Payout" } }, "text/html": { "schema": { "$ref": "#/components/schemas/Payout" } } } }, "404": { "description": "Resource not found" } }, "summary": "Retrieves a Payout resource.", "description": "Retrieves a Payout resource.", "parameters": [ { "name": "id", "in": "path", "description": "Resource identifier", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "deprecated": false }, "put": { "operationId": "putPayoutItem", "tags": [ "Payout" ], "responses": { "200": { "description": "Payout resource updated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Payout" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/Payout" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/Payout" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/Payout" } }, "text/html": { "schema": { "$ref": "#/components/schemas/Payout" } } }, "links": { "GetPayoutItem": { "operationId": "getPayoutItem", "parameters": { "id": "$response.body#/id" }, "description": "The `id` value returned in the response can be used as the `id` parameter in `GET /payouts/{id}`." } } }, "400": { "description": "Invalid input" }, "422": { "description": "Unprocessable entity" }, "404": { "description": "Resource not found" } }, "summary": "Replaces the Payout resource.", "description": "Replaces the Payout resource.", "parameters": [ { "name": "id", "in": "path", "description": "Resource identifier", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "requestBody": { "description": "The updated Payout resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Payout" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/Payout" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/Payout" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/Payout" } }, "text/html": { "schema": { "$ref": "#/components/schemas/Payout" } } }, "required": true }, "deprecated": false }, "delete": { "operationId": "deletePayoutItem", "tags": [ "Payout" ], "responses": { "204": { "description": "Payout resource deleted" }, "404": { "description": "Resource not found" } }, "summary": "Removes the Payout resource.", "description": "Removes the Payout resource.", "parameters": [ { "name": "id", "in": "path", "description": "Resource identifier", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "deprecated": false }, "parameters": [] }, "/payroll": { "get": { "operationId": "getPayrollCollection", "tags": [ "Payroll" ], "responses": { "200": { "description": "Payroll collection", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Payroll" } } }, "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Payroll" } } }, "text/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Payroll" } } }, "text/csv": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Payroll" } } }, "text/html": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Payroll" } } } } } }, "summary": "Retrieves the collection of Payroll resources.", "description": "Retrieves the collection of Payroll resources.", "parameters": [], "deprecated": false }, "parameters": [] }, "/plans": { "get": { "operationId": "getPlanCollection", "tags": [ "Plan" ], "responses": { "200": { "description": "Plan collection", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Plan" } } }, "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Plan" } } }, "text/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Plan" } } }, "text/csv": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Plan" } } }, "text/html": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Plan" } } } } } }, "summary": "Retrieves the collection of Plan resources.", "description": "Retrieves the collection of Plan resources.", "parameters": [ { "name": "page", "in": "query", "description": "The collection page number", "required": false, "deprecated": false, "allowEmptyValue": true, "schema": { "type": "integer", "default": 1 }, "style": "form", "explode": false, "allowReserved": false }, { "name": "itemsPerPage", "in": "query", "description": "The number of items per page", "required": false, "deprecated": false, "allowEmptyValue": true, "schema": { "type": "integer", "default": 100, "minimum": 0, "maximum": 200 }, "style": "form", "explode": false, "allowReserved": false } ], "deprecated": false }, "parameters": [] }, "/plans/{id}": { "get": { "operationId": "getPlanItem", "tags": [ "Plan" ], "responses": { "200": { "description": "Plan resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Plan" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/Plan" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/Plan" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/Plan" } }, "text/html": { "schema": { "$ref": "#/components/schemas/Plan" } } } }, "404": { "description": "Resource not found" } }, "summary": "Retrieves a Plan resource.", "description": "Retrieves a Plan resource.", "parameters": [ { "name": "id", "in": "path", "description": "Resource identifier", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "deprecated": false }, "parameters": [] }, "/products": { "get": { "operationId": "getProductCollection", "tags": [ "Product" ], "responses": { "200": { "description": "Product collection", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Product" } } }, "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Product" } } }, "text/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Product" } } }, "text/csv": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Product" } } }, "text/html": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Product" } } } } } }, "summary": "Retrieves the collection of Product resources.", "description": "Retrieves the collection of Product resources.", "parameters": [ { "name": "page", "in": "query", "description": "The collection page number", "required": false, "deprecated": false, "allowEmptyValue": true, "schema": { "type": "integer", "default": 1 }, "style": "form", "explode": false, "allowReserved": false }, { "name": "itemsPerPage", "in": "query", "description": "The number of items per page", "required": false, "deprecated": false, "allowEmptyValue": true, "schema": { "type": "integer", "default": 100, "minimum": 0, "maximum": 200 }, "style": "form", "explode": false, "allowReserved": false } ], "deprecated": false }, "post": { "operationId": "postProductCollection", "tags": [ "Product" ], "responses": { "201": { "description": "Product resource created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Product" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/Product" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/Product" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/Product" } }, "text/html": { "schema": { "$ref": "#/components/schemas/Product" } } }, "links": { "GetProductItem": { "operationId": "getProductItem", "parameters": { "id": "$response.body#/id" }, "description": "The `id` value returned in the response can be used as the `id` parameter in `GET /products/{id}`." } } }, "400": { "description": "Invalid input" }, "422": { "description": "Unprocessable entity" } }, "summary": "Creates a Product resource.", "description": "Creates a Product resource.", "parameters": [], "requestBody": { "description": "The new Product resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Product" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/Product" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/Product" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/Product" } }, "text/html": { "schema": { "$ref": "#/components/schemas/Product" } } }, "required": true }, "deprecated": false }, "parameters": [] }, "/products/{id}": { "get": { "operationId": "getProductItem", "tags": [ "Product" ], "responses": { "200": { "description": "Product resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Product" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/Product" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/Product" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/Product" } }, "text/html": { "schema": { "$ref": "#/components/schemas/Product" } } } }, "404": { "description": "Resource not found" } }, "summary": "Retrieves a Product resource.", "description": "Retrieves a Product resource.", "parameters": [ { "name": "id", "in": "path", "description": "Resource identifier", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "deprecated": false }, "put": { "operationId": "putProductItem", "tags": [ "Product" ], "responses": { "200": { "description": "Product resource updated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Product" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/Product" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/Product" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/Product" } }, "text/html": { "schema": { "$ref": "#/components/schemas/Product" } } }, "links": { "GetProductItem": { "operationId": "getProductItem", "parameters": { "id": "$response.body#/id" }, "description": "The `id` value returned in the response can be used as the `id` parameter in `GET /products/{id}`." } } }, "400": { "description": "Invalid input" }, "422": { "description": "Unprocessable entity" }, "404": { "description": "Resource not found" } }, "summary": "Replaces the Product resource.", "description": "Replaces the Product resource.", "parameters": [ { "name": "id", "in": "path", "description": "Resource identifier", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "requestBody": { "description": "The updated Product resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Product" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/Product" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/Product" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/Product" } }, "text/html": { "schema": { "$ref": "#/components/schemas/Product" } } }, "required": true }, "deprecated": false }, "delete": { "operationId": "deleteProductItem", "tags": [ "Product" ], "responses": { "204": { "description": "Product resource deleted" }, "404": { "description": "Resource not found" } }, "summary": "Removes the Product resource.", "description": "Removes the Product resource.", "parameters": [ { "name": "id", "in": "path", "description": "Resource identifier", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "deprecated": false }, "parameters": [] }, "/profit_and_loss": { "get": { "operationId": "getProfitAndLossItem", "tags": [ "ProfitAndLoss" ], "responses": { "200": { "description": "ProfitAndLoss resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProfitAndLoss" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ProfitAndLoss" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ProfitAndLoss" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/ProfitAndLoss" } }, "text/html": { "schema": { "$ref": "#/components/schemas/ProfitAndLoss" } } } }, "404": { "description": "Resource not found" } }, "summary": "Retrieves a ProfitAndLoss resource.", "description": "Retrieves a ProfitAndLoss resource.", "parameters": [ { "name": "start", "in": "query", "description": "YYYY-MM-DD", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string", "format": "date-time" }, "style": "form", "explode": false, "allowReserved": false, "example": "2022-11-01" }, { "name": "end", "in": "query", "description": "YYYY-MM-DD", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string", "format": "date-time" }, "style": "form", "explode": false, "allowReserved": false, "example": "2022-11-30" }, { "name": "accounting_method", "in": "query", "description": "The Accounting Method", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string", "enum": [ "cash", "accrual" ] }, "style": "form", "explode": false, "allowReserved": false, "example": "accrual" } ], "deprecated": false }, "parameters": [] }, "/profit_and_loss_excel": { "get": { "operationId": "getProfitAndLossExcelItem", "tags": [ "ProfitAndLossExcel" ], "responses": { "200": { "description": "ProfitAndLossExcel resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProfitAndLossExcel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ProfitAndLossExcel" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ProfitAndLossExcel" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/ProfitAndLossExcel" } }, "text/html": { "schema": { "$ref": "#/components/schemas/ProfitAndLossExcel" } } } }, "404": { "description": "Resource not found" } }, "summary": "Retrieves an excel workbook of a series of profit and loss reports", "description": "Retrieves an excel workbook of a series of profit and loss reports", "parameters": [ { "name": "start", "in": "query", "description": "YYYY-MM-DD", "required": false, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string", "format": "date-time" }, "style": "form", "explode": false, "allowReserved": false, "example": "2022-07-01" }, { "name": "end", "in": "query", "description": "YYYY-MM-DD", "required": false, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string", "format": "date-time" }, "style": "form", "explode": false, "allowReserved": false, "example": "2022-08-31" }, { "name": "refresh", "in": "query", "description": "If refresh is set, data will be fetched from the source application even when cached data is available", "required": false, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "form", "explode": false, "allowReserved": false, "example": "true" } ], "deprecated": false }, "parameters": [] }, "/profit_and_loss_report": { "get": { "operationId": "getProfitAndLossReportItem", "tags": [ "ProfitAndLossReport" ], "responses": { "200": { "description": "ProfitAndLossReport resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProfitAndLossReport" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ProfitAndLossReport" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ProfitAndLossReport" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/ProfitAndLossReport" } }, "text/html": { "schema": { "$ref": "#/components/schemas/ProfitAndLossReport" } } } }, "404": { "description": "Resource not found" } }, "summary": "Retrieves a mapped profit and loss report", "description": "Retrieves a mapped profit and loss report", "parameters": [ { "name": "start", "in": "query", "description": "YYYY-MM-DD", "required": false, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string", "format": "date-time" }, "style": "form", "explode": false, "allowReserved": false, "example": "2022-01-01" }, { "name": "end", "in": "query", "description": "YYYY-MM-DD", "required": false, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string", "format": "date-time" }, "style": "form", "explode": false, "allowReserved": false, "example": "2022-01-31" }, { "name": "refresh", "in": "query", "description": "If refresh is set, data will be fetched from the source application even when cached data is available", "required": false, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "form", "explode": false, "allowReserved": false, "example": "true" } ], "deprecated": false }, "parameters": [] }, "/projects": { "get": { "operationId": "getProjectCollection", "tags": [ "Project" ], "responses": { "200": { "description": "Project collection", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Project" } } }, "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Project" } } }, "text/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Project" } } }, "text/csv": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Project" } } }, "text/html": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Project" } } } } } }, "summary": "Retrieves the collection of Project resources.", "description": "Retrieves the collection of Project resources.", "parameters": [ { "name": "page", "in": "query", "description": "The collection page number", "required": false, "deprecated": false, "allowEmptyValue": true, "schema": { "type": "integer", "default": 1 }, "style": "form", "explode": false, "allowReserved": false }, { "name": "itemsPerPage", "in": "query", "description": "The number of items per page", "required": false, "deprecated": false, "allowEmptyValue": true, "schema": { "type": "integer", "default": 100, "minimum": 0, "maximum": 200 }, "style": "form", "explode": false, "allowReserved": false } ], "deprecated": false }, "parameters": [] }, "/projects/{id}": { "get": { "operationId": "getProjectItem", "tags": [ "Project" ], "responses": { "200": { "description": "Project resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Project" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/Project" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/Project" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/Project" } }, "text/html": { "schema": { "$ref": "#/components/schemas/Project" } } } }, "404": { "description": "Resource not found" } }, "summary": "Retrieves a Project resource.", "description": "Retrieves a Project resource.", "parameters": [ { "name": "id", "in": "path", "description": "Resource identifier", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "deprecated": false }, "parameters": [] }, "/proxy_request": { "get": { "operationId": "getProxyRequestCollection", "tags": [ "ProxyRequest" ], "responses": { "200": { "description": "ProxyRequest collection", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ProxyRequest" } } }, "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ProxyRequest" } } }, "text/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ProxyRequest" } } }, "text/csv": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ProxyRequest" } } }, "text/html": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ProxyRequest" } } } } } }, "summary": "make a GET request to a specific API endpoint", "description": "Retrieves the collection of ProxyRequest resources.", "parameters": [ { "name": "key", "in": "query", "description": "The key of the application you would like to request. ", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "form", "explode": false, "allowReserved": false, "example": "quickbooks" }, { "name": "url", "in": "query", "description": "The url of the application you would like to request. ", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "form", "explode": false, "allowReserved": false, "example": "https://sandbox-quickbooks.api.intuit.com/v3/company/16208146365078362930/query" } ], "deprecated": false }, "post": { "operationId": "postProxyRequestCollection", "tags": [ "ProxyRequest" ], "responses": { "201": { "description": "ProxyRequest resource created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProxyRequest" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ProxyRequest" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ProxyRequest" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/ProxyRequest" } }, "text/html": { "schema": { "$ref": "#/components/schemas/ProxyRequest" } } }, "links": {} }, "400": { "description": "Invalid input" }, "422": { "description": "Unprocessable entity" } }, "summary": "make a POST request to a specific API endpoint", "description": "Creates a ProxyRequest resource.", "parameters": [ { "name": "key", "in": "query", "description": "The key of the application you would like to request. ", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "form", "explode": false, "allowReserved": false, "example": "quickbooks" }, { "name": "url", "in": "query", "description": "The url of the application endpoint you would like to request. ", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "form", "explode": false, "allowReserved": false, "example": "https://sandbox-quickbooks.api.intuit.com/v3/company/16208146365078362930/query" } ], "requestBody": { "description": "The new ProxyRequest resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProxyRequest" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ProxyRequest" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ProxyRequest" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/ProxyRequest" } }, "text/html": { "schema": { "$ref": "#/components/schemas/ProxyRequest" } } }, "required": true }, "deprecated": false }, "parameters": [] }, "/publishing_channels": { "get": { "operationId": "getPublishingChannelCollection", "tags": [ "PublishingChannel" ], "responses": { "200": { "description": "PublishingChannel collection", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PublishingChannel" } } }, "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PublishingChannel" } } }, "text/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PublishingChannel" } } }, "text/csv": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PublishingChannel" } } }, "text/html": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PublishingChannel" } } } } } }, "summary": "Retrieves the collection of PublishingChannel resources.", "description": "Retrieves the collection of PublishingChannel resources.", "parameters": [ { "name": "page", "in": "query", "description": "The collection page number", "required": false, "deprecated": false, "allowEmptyValue": true, "schema": { "type": "integer", "default": 1 }, "style": "form", "explode": false, "allowReserved": false }, { "name": "itemsPerPage", "in": "query", "description": "The number of items per page", "required": false, "deprecated": false, "allowEmptyValue": true, "schema": { "type": "integer", "default": 100, "minimum": 0, "maximum": 200 }, "style": "form", "explode": false, "allowReserved": false } ], "deprecated": false }, "parameters": [] }, "/publishing_channels/{id}": { "get": { "operationId": "getPublishingChannelItem", "tags": [ "PublishingChannel" ], "responses": { "200": { "description": "PublishingChannel resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublishingChannel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/PublishingChannel" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/PublishingChannel" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/PublishingChannel" } }, "text/html": { "schema": { "$ref": "#/components/schemas/PublishingChannel" } } } }, "404": { "description": "Resource not found" } }, "summary": "Retrieves a PublishingChannel resource.", "description": "Retrieves a PublishingChannel resource.", "parameters": [ { "name": "id", "in": "path", "description": "Resource identifier", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "deprecated": false }, "parameters": [] }, "/purchase_credit_notes": { "get": { "operationId": "getPurchaseCreditNoteCollection", "tags": [ "PurchaseCreditNote" ], "responses": { "200": { "description": "PurchaseCreditNote collection", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PurchaseCreditNote" } } }, "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PurchaseCreditNote" } } }, "text/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PurchaseCreditNote" } } }, "text/csv": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PurchaseCreditNote" } } }, "text/html": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PurchaseCreditNote" } } } } } }, "summary": "Retrieves the collection of PurchaseCreditNote resources.", "description": "Retrieves the collection of PurchaseCreditNote resources.", "parameters": [ { "name": "page", "in": "query", "description": "The collection page number", "required": false, "deprecated": false, "allowEmptyValue": true, "schema": { "type": "integer", "default": 1 }, "style": "form", "explode": false, "allowReserved": false }, { "name": "itemsPerPage", "in": "query", "description": "The number of items per page", "required": false, "deprecated": false, "allowEmptyValue": true, "schema": { "type": "integer", "default": 100, "minimum": 0, "maximum": 200 }, "style": "form", "explode": false, "allowReserved": false } ], "deprecated": false }, "parameters": [] }, "/purchase_credit_notes/{id}": { "get": { "operationId": "getPurchaseCreditNoteItem", "tags": [ "PurchaseCreditNote" ], "responses": { "200": { "description": "PurchaseCreditNote resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PurchaseCreditNote" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/PurchaseCreditNote" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/PurchaseCreditNote" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/PurchaseCreditNote" } }, "text/html": { "schema": { "$ref": "#/components/schemas/PurchaseCreditNote" } } } }, "404": { "description": "Resource not found" } }, "summary": "Retrieves a PurchaseCreditNote resource.", "description": "Retrieves a PurchaseCreditNote resource.", "parameters": [ { "name": "id", "in": "path", "description": "Resource identifier", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "deprecated": false }, "parameters": [] }, "/purchase_orders": { "get": { "operationId": "getPurchaseOrderCollection", "tags": [ "PurchaseOrder" ], "responses": { "200": { "description": "PurchaseOrder collection", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PurchaseOrder" } } }, "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PurchaseOrder" } } }, "text/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PurchaseOrder" } } }, "text/csv": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PurchaseOrder" } } }, "text/html": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PurchaseOrder" } } } } } }, "summary": "Retrieves the collection of PurchaseOrder resources.", "description": "Retrieves the collection of PurchaseOrder resources.", "parameters": [ { "name": "page", "in": "query", "description": "The collection page number", "required": false, "deprecated": false, "allowEmptyValue": true, "schema": { "type": "integer", "default": 1 }, "style": "form", "explode": false, "allowReserved": false }, { "name": "itemsPerPage", "in": "query", "description": "The number of items per page", "required": false, "deprecated": false, "allowEmptyValue": true, "schema": { "type": "integer", "default": 100, "minimum": 0, "maximum": 200 }, "style": "form", "explode": false, "allowReserved": false } ], "deprecated": false }, "parameters": [] }, "/purchase_orders/{id}": { "get": { "operationId": "getPurchaseOrderItem", "tags": [ "PurchaseOrder" ], "responses": { "200": { "description": "PurchaseOrder resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PurchaseOrder" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/PurchaseOrder" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/PurchaseOrder" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/PurchaseOrder" } }, "text/html": { "schema": { "$ref": "#/components/schemas/PurchaseOrder" } } } }, "404": { "description": "Resource not found" } }, "summary": "Retrieves a PurchaseOrder resource.", "description": "Retrieves a PurchaseOrder resource.", "parameters": [ { "name": "id", "in": "path", "description": "Resource identifier", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "deprecated": false }, "parameters": [] }, "/purchases": { "get": { "operationId": "getPurchaseCollection", "tags": [ "Purchase" ], "responses": { "200": { "description": "Purchase collection", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Purchase" } } }, "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Purchase" } } }, "text/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Purchase" } } }, "text/csv": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Purchase" } } }, "text/html": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Purchase" } } } } } }, "summary": "Retrieves the collection of Purchase resources.", "description": "Retrieves the collection of Purchase resources.", "parameters": [ { "name": "page", "in": "query", "description": "The collection page number", "required": false, "deprecated": false, "allowEmptyValue": true, "schema": { "type": "integer", "default": 1 }, "style": "form", "explode": false, "allowReserved": false }, { "name": "itemsPerPage", "in": "query", "description": "The number of items per page", "required": false, "deprecated": false, "allowEmptyValue": true, "schema": { "type": "integer", "default": 100, "minimum": 0, "maximum": 200 }, "style": "form", "explode": false, "allowReserved": false } ], "deprecated": false }, "parameters": [] }, "/purchases/{id}": { "get": { "operationId": "getPurchaseItem", "tags": [ "Purchase" ], "responses": { "200": { "description": "Purchase resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Purchase" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/Purchase" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/Purchase" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/Purchase" } }, "text/html": { "schema": { "$ref": "#/components/schemas/Purchase" } } } }, "404": { "description": "Resource not found" } }, "summary": "Retrieves a Purchase resource.", "description": "Retrieves a Purchase resource.", "parameters": [ { "name": "id", "in": "path", "description": "Resource identifier", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "deprecated": false }, "parameters": [] }, "/quotes": { "get": { "operationId": "getQuoteCollection", "tags": [ "Quote" ], "responses": { "200": { "description": "Quote collection", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Quote" } } }, "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Quote" } } }, "text/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Quote" } } }, "text/csv": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Quote" } } }, "text/html": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Quote" } } } } } }, "summary": "Retrieves the collection of Quote resources.", "description": "Retrieves the collection of Quote resources.", "parameters": [ { "name": "page", "in": "query", "description": "The collection page number", "required": false, "deprecated": false, "allowEmptyValue": true, "schema": { "type": "integer", "default": 1 }, "style": "form", "explode": false, "allowReserved": false }, { "name": "itemsPerPage", "in": "query", "description": "The number of items per page", "required": false, "deprecated": false, "allowEmptyValue": true, "schema": { "type": "integer", "default": 100, "minimum": 0, "maximum": 200 }, "style": "form", "explode": false, "allowReserved": false } ], "deprecated": false }, "post": { "operationId": "postQuoteCollection", "tags": [ "Quote" ], "responses": { "201": { "description": "Quote resource created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Quote" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/Quote" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/Quote" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/Quote" } }, "text/html": { "schema": { "$ref": "#/components/schemas/Quote" } } }, "links": { "GetQuoteItem": { "operationId": "getQuoteItem", "parameters": { "id": "$response.body#/id" }, "description": "The `id` value returned in the response can be used as the `id` parameter in `GET /quotes/{id}`." } } }, "400": { "description": "Invalid input" }, "422": { "description": "Unprocessable entity" } }, "summary": "Creates a Quote resource.", "description": "Creates a Quote resource.", "parameters": [], "requestBody": { "description": "The new Quote resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Quote" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/Quote" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/Quote" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/Quote" } }, "text/html": { "schema": { "$ref": "#/components/schemas/Quote" } } }, "required": true }, "deprecated": false }, "parameters": [] }, "/quotes/{id}": { "get": { "operationId": "getQuoteItem", "tags": [ "Quote" ], "responses": { "200": { "description": "Quote resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Quote" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/Quote" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/Quote" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/Quote" } }, "text/html": { "schema": { "$ref": "#/components/schemas/Quote" } } } }, "404": { "description": "Resource not found" } }, "summary": "Retrieves a Quote resource.", "description": "Retrieves a Quote resource.", "parameters": [ { "name": "id", "in": "path", "description": "Resource identifier", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "deprecated": false }, "put": { "operationId": "putQuoteItem", "tags": [ "Quote" ], "responses": { "200": { "description": "Quote resource updated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Quote" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/Quote" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/Quote" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/Quote" } }, "text/html": { "schema": { "$ref": "#/components/schemas/Quote" } } }, "links": { "GetQuoteItem": { "operationId": "getQuoteItem", "parameters": { "id": "$response.body#/id" }, "description": "The `id` value returned in the response can be used as the `id` parameter in `GET /quotes/{id}`." } } }, "400": { "description": "Invalid input" }, "422": { "description": "Unprocessable entity" }, "404": { "description": "Resource not found" } }, "summary": "Replaces the Quote resource.", "description": "Replaces the Quote resource.", "parameters": [ { "name": "id", "in": "path", "description": "Resource identifier", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "requestBody": { "description": "The updated Quote resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Quote" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/Quote" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/Quote" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/Quote" } }, "text/html": { "schema": { "$ref": "#/components/schemas/Quote" } } }, "required": true }, "deprecated": false }, "delete": { "operationId": "deleteQuoteItem", "tags": [ "Quote" ], "responses": { "204": { "description": "Quote resource deleted" }, "404": { "description": "Resource not found" } }, "summary": "Removes the Quote resource.", "description": "Removes the Quote resource.", "parameters": [ { "name": "id", "in": "path", "description": "Resource identifier", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "deprecated": false }, "parameters": [] }, "/recurring_charges": { "get": { "operationId": "getRecurringChargeCollection", "tags": [ "RecurringCharge" ], "responses": { "200": { "description": "RecurringCharge collection", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/RecurringCharge" } } }, "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/RecurringCharge" } } }, "text/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/RecurringCharge" } } }, "text/csv": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/RecurringCharge" } } }, "text/html": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/RecurringCharge" } } } } } }, "summary": "Retrieves the collection of RecurringCharge resources.", "description": "Retrieves the collection of RecurringCharge resources.", "parameters": [ { "name": "page", "in": "query", "description": "The collection page number", "required": false, "deprecated": false, "allowEmptyValue": true, "schema": { "type": "integer", "default": 1 }, "style": "form", "explode": false, "allowReserved": false }, { "name": "itemsPerPage", "in": "query", "description": "The number of items per page", "required": false, "deprecated": false, "allowEmptyValue": true, "schema": { "type": "integer", "default": 100, "minimum": 0, "maximum": 200 }, "style": "form", "explode": false, "allowReserved": false } ], "deprecated": false }, "post": { "operationId": "postRecurringChargeCollection", "tags": [ "RecurringCharge" ], "responses": { "201": { "description": "RecurringCharge resource created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RecurringCharge" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/RecurringCharge" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/RecurringCharge" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/RecurringCharge" } }, "text/html": { "schema": { "$ref": "#/components/schemas/RecurringCharge" } } }, "links": { "GetRecurringChargeItem": { "operationId": "getRecurringChargeItem", "parameters": { "id": "$response.body#/id" }, "description": "The `id` value returned in the response can be used as the `id` parameter in `GET /recurring_charges/{id}`." } } }, "400": { "description": "Invalid input" }, "422": { "description": "Unprocessable entity" } }, "summary": "Creates a RecurringCharge resource.", "description": "Creates a RecurringCharge resource.", "parameters": [], "requestBody": { "description": "The new RecurringCharge resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RecurringCharge" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/RecurringCharge" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/RecurringCharge" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/RecurringCharge" } }, "text/html": { "schema": { "$ref": "#/components/schemas/RecurringCharge" } } }, "required": true }, "deprecated": false }, "parameters": [] }, "/recurring_charges/{id}": { "get": { "operationId": "getRecurringChargeItem", "tags": [ "RecurringCharge" ], "responses": { "200": { "description": "RecurringCharge resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RecurringCharge" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/RecurringCharge" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/RecurringCharge" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/RecurringCharge" } }, "text/html": { "schema": { "$ref": "#/components/schemas/RecurringCharge" } } } }, "404": { "description": "Resource not found" } }, "summary": "Retrieves a RecurringCharge resource.", "description": "Retrieves a RecurringCharge resource.", "parameters": [ { "name": "id", "in": "path", "description": "Resource identifier", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "deprecated": false }, "put": { "operationId": "putRecurringChargeItem", "tags": [ "RecurringCharge" ], "responses": { "200": { "description": "RecurringCharge resource updated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RecurringCharge" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/RecurringCharge" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/RecurringCharge" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/RecurringCharge" } }, "text/html": { "schema": { "$ref": "#/components/schemas/RecurringCharge" } } }, "links": { "GetRecurringChargeItem": { "operationId": "getRecurringChargeItem", "parameters": { "id": "$response.body#/id" }, "description": "The `id` value returned in the response can be used as the `id` parameter in `GET /recurring_charges/{id}`." } } }, "400": { "description": "Invalid input" }, "422": { "description": "Unprocessable entity" }, "404": { "description": "Resource not found" } }, "summary": "Replaces the RecurringCharge resource.", "description": "Replaces the RecurringCharge resource.", "parameters": [ { "name": "id", "in": "path", "description": "Resource identifier", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "requestBody": { "description": "The updated RecurringCharge resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RecurringCharge" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/RecurringCharge" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/RecurringCharge" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/RecurringCharge" } }, "text/html": { "schema": { "$ref": "#/components/schemas/RecurringCharge" } } }, "required": true }, "deprecated": false }, "delete": { "operationId": "deleteRecurringChargeItem", "tags": [ "RecurringCharge" ], "responses": { "204": { "description": "RecurringCharge resource deleted" }, "404": { "description": "Resource not found" } }, "summary": "Removes the RecurringCharge resource.", "description": "Removes the RecurringCharge resource.", "parameters": [ { "name": "id", "in": "path", "description": "Resource identifier", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "deprecated": false }, "parameters": [] }, "/recurring_expenses": { "get": { "operationId": "getRecurringExpenseCollection", "tags": [ "RecurringExpense" ], "responses": { "200": { "description": "RecurringExpense collection", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/RecurringExpense" } } }, "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/RecurringExpense" } } }, "text/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/RecurringExpense" } } }, "text/csv": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/RecurringExpense" } } }, "text/html": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/RecurringExpense" } } } } } }, "summary": "Retrieves the collection of RecurringExpense resources.", "description": "Retrieves the collection of RecurringExpense resources.", "parameters": [ { "name": "page", "in": "query", "description": "The collection page number", "required": false, "deprecated": false, "allowEmptyValue": true, "schema": { "type": "integer", "default": 1 }, "style": "form", "explode": false, "allowReserved": false }, { "name": "itemsPerPage", "in": "query", "description": "The number of items per page", "required": false, "deprecated": false, "allowEmptyValue": true, "schema": { "type": "integer", "default": 100, "minimum": 0, "maximum": 200 }, "style": "form", "explode": false, "allowReserved": false } ], "deprecated": false }, "post": { "operationId": "postRecurringExpenseCollection", "tags": [ "RecurringExpense" ], "responses": { "201": { "description": "RecurringExpense resource created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RecurringExpense" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/RecurringExpense" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/RecurringExpense" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/RecurringExpense" } }, "text/html": { "schema": { "$ref": "#/components/schemas/RecurringExpense" } } }, "links": { "GetRecurringExpenseItem": { "operationId": "getRecurringExpenseItem", "parameters": { "id": "$response.body#/id" }, "description": "The `id` value returned in the response can be used as the `id` parameter in `GET /recurring_expenses/{id}`." } } }, "400": { "description": "Invalid input" }, "422": { "description": "Unprocessable entity" } }, "summary": "Creates a RecurringExpense resource.", "description": "Creates a RecurringExpense resource.", "parameters": [], "requestBody": { "description": "The new RecurringExpense resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RecurringExpense" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/RecurringExpense" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/RecurringExpense" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/RecurringExpense" } }, "text/html": { "schema": { "$ref": "#/components/schemas/RecurringExpense" } } }, "required": true }, "deprecated": false }, "parameters": [] }, "/recurring_expenses/{id}": { "get": { "operationId": "getRecurringExpenseItem", "tags": [ "RecurringExpense" ], "responses": { "200": { "description": "RecurringExpense resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RecurringExpense" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/RecurringExpense" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/RecurringExpense" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/RecurringExpense" } }, "text/html": { "schema": { "$ref": "#/components/schemas/RecurringExpense" } } } }, "404": { "description": "Resource not found" } }, "summary": "Retrieves a RecurringExpense resource.", "description": "Retrieves a RecurringExpense resource.", "parameters": [ { "name": "id", "in": "path", "description": "Resource identifier", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "deprecated": false }, "put": { "operationId": "putRecurringExpenseItem", "tags": [ "RecurringExpense" ], "responses": { "200": { "description": "RecurringExpense resource updated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RecurringExpense" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/RecurringExpense" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/RecurringExpense" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/RecurringExpense" } }, "text/html": { "schema": { "$ref": "#/components/schemas/RecurringExpense" } } }, "links": { "GetRecurringExpenseItem": { "operationId": "getRecurringExpenseItem", "parameters": { "id": "$response.body#/id" }, "description": "The `id` value returned in the response can be used as the `id` parameter in `GET /recurring_expenses/{id}`." } } }, "400": { "description": "Invalid input" }, "422": { "description": "Unprocessable entity" }, "404": { "description": "Resource not found" } }, "summary": "Replaces the RecurringExpense resource.", "description": "Replaces the RecurringExpense resource.", "parameters": [ { "name": "id", "in": "path", "description": "Resource identifier", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "requestBody": { "description": "The updated RecurringExpense resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RecurringExpense" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/RecurringExpense" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/RecurringExpense" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/RecurringExpense" } }, "text/html": { "schema": { "$ref": "#/components/schemas/RecurringExpense" } } }, "required": true }, "deprecated": false }, "delete": { "operationId": "deleteRecurringExpenseItem", "tags": [ "RecurringExpense" ], "responses": { "204": { "description": "RecurringExpense resource deleted" }, "404": { "description": "Resource not found" } }, "summary": "Removes the RecurringExpense resource.", "description": "Removes the RecurringExpense resource.", "parameters": [ { "name": "id", "in": "path", "description": "Resource identifier", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "deprecated": false }, "parameters": [] }, "/refunds": { "get": { "operationId": "getRefundCollection", "tags": [ "Refund" ], "responses": { "200": { "description": "Refund collection", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Refund" } } }, "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Refund" } } }, "text/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Refund" } } }, "text/csv": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Refund" } } }, "text/html": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Refund" } } } } } }, "summary": "Retrieves the collection of Refund resources.", "description": "Retrieves the collection of Refund resources.", "parameters": [ { "name": "page", "in": "query", "description": "The collection page number", "required": false, "deprecated": false, "allowEmptyValue": true, "schema": { "type": "integer", "default": 1 }, "style": "form", "explode": false, "allowReserved": false }, { "name": "itemsPerPage", "in": "query", "description": "The number of items per page", "required": false, "deprecated": false, "allowEmptyValue": true, "schema": { "type": "integer", "default": 100, "minimum": 0, "maximum": 200 }, "style": "form", "explode": false, "allowReserved": false } ], "deprecated": false }, "post": { "operationId": "postRefundCollection", "tags": [ "Refund" ], "responses": { "201": { "description": "Refund resource created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Refund" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/Refund" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/Refund" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/Refund" } }, "text/html": { "schema": { "$ref": "#/components/schemas/Refund" } } }, "links": { "GetRefundItem": { "operationId": "getRefundItem", "parameters": { "id": "$response.body#/id" }, "description": "The `id` value returned in the response can be used as the `id` parameter in `GET /refunds/{id}`." } } }, "400": { "description": "Invalid input" }, "422": { "description": "Unprocessable entity" } }, "summary": "Creates a Refund resource.", "description": "Creates a Refund resource.", "parameters": [], "requestBody": { "description": "The new Refund resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Refund" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/Refund" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/Refund" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/Refund" } }, "text/html": { "schema": { "$ref": "#/components/schemas/Refund" } } }, "required": true }, "deprecated": false }, "parameters": [] }, "/refunds/{id}": { "get": { "operationId": "getRefundItem", "tags": [ "Refund" ], "responses": { "200": { "description": "Refund resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Refund" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/Refund" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/Refund" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/Refund" } }, "text/html": { "schema": { "$ref": "#/components/schemas/Refund" } } } }, "404": { "description": "Resource not found" } }, "summary": "Retrieves a Refund resource.", "description": "Retrieves a Refund resource.", "parameters": [ { "name": "id", "in": "path", "description": "Resource identifier", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "deprecated": false }, "put": { "operationId": "putRefundItem", "tags": [ "Refund" ], "responses": { "200": { "description": "Refund resource updated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Refund" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/Refund" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/Refund" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/Refund" } }, "text/html": { "schema": { "$ref": "#/components/schemas/Refund" } } }, "links": { "GetRefundItem": { "operationId": "getRefundItem", "parameters": { "id": "$response.body#/id" }, "description": "The `id` value returned in the response can be used as the `id` parameter in `GET /refunds/{id}`." } } }, "400": { "description": "Invalid input" }, "422": { "description": "Unprocessable entity" }, "404": { "description": "Resource not found" } }, "summary": "Replaces the Refund resource.", "description": "Replaces the Refund resource.", "parameters": [ { "name": "id", "in": "path", "description": "Resource identifier", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "requestBody": { "description": "The updated Refund resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Refund" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/Refund" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/Refund" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/Refund" } }, "text/html": { "schema": { "$ref": "#/components/schemas/Refund" } } }, "required": true }, "deprecated": false }, "delete": { "operationId": "deleteRefundItem", "tags": [ "Refund" ], "responses": { "204": { "description": "Refund resource deleted" }, "404": { "description": "Resource not found" } }, "summary": "Removes the Refund resource.", "description": "Removes the Refund resource.", "parameters": [ { "name": "id", "in": "path", "description": "Resource identifier", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "deprecated": false }, "parameters": [] }, "/repeating_invoices": { "get": { "operationId": "getRepeatingInvoiceCollection", "tags": [ "RepeatingInvoice" ], "responses": { "200": { "description": "RepeatingInvoice collection", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/RepeatingInvoice" } } }, "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/RepeatingInvoice" } } }, "text/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/RepeatingInvoice" } } }, "text/csv": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/RepeatingInvoice" } } }, "text/html": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/RepeatingInvoice" } } } } } }, "summary": "Retrieves the collection of RepeatingInvoice resources.", "description": "Retrieves the collection of RepeatingInvoice resources.", "parameters": [ { "name": "page", "in": "query", "description": "The collection page number", "required": false, "deprecated": false, "allowEmptyValue": true, "schema": { "type": "integer", "default": 1 }, "style": "form", "explode": false, "allowReserved": false }, { "name": "itemsPerPage", "in": "query", "description": "The number of items per page", "required": false, "deprecated": false, "allowEmptyValue": true, "schema": { "type": "integer", "default": 100, "minimum": 0, "maximum": 200 }, "style": "form", "explode": false, "allowReserved": false } ], "deprecated": false }, "post": { "operationId": "postRepeatingInvoiceCollection", "tags": [ "RepeatingInvoice" ], "responses": { "201": { "description": "RepeatingInvoice resource created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RepeatingInvoice" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/RepeatingInvoice" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/RepeatingInvoice" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/RepeatingInvoice" } }, "text/html": { "schema": { "$ref": "#/components/schemas/RepeatingInvoice" } } }, "links": { "GetRepeatingInvoiceItem": { "operationId": "getRepeatingInvoiceItem", "parameters": { "id": "$response.body#/id" }, "description": "The `id` value returned in the response can be used as the `id` parameter in `GET /repeating_invoices/{id}`." } } }, "400": { "description": "Invalid input" }, "422": { "description": "Unprocessable entity" } }, "summary": "Creates a RepeatingInvoice resource.", "description": "Creates a RepeatingInvoice resource.", "parameters": [], "requestBody": { "description": "The new RepeatingInvoice resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RepeatingInvoice" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/RepeatingInvoice" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/RepeatingInvoice" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/RepeatingInvoice" } }, "text/html": { "schema": { "$ref": "#/components/schemas/RepeatingInvoice" } } }, "required": true }, "deprecated": false }, "parameters": [] }, "/repeating_invoices/{id}": { "get": { "operationId": "getRepeatingInvoiceItem", "tags": [ "RepeatingInvoice" ], "responses": { "200": { "description": "RepeatingInvoice resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RepeatingInvoice" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/RepeatingInvoice" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/RepeatingInvoice" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/RepeatingInvoice" } }, "text/html": { "schema": { "$ref": "#/components/schemas/RepeatingInvoice" } } } }, "404": { "description": "Resource not found" } }, "summary": "Retrieves a RepeatingInvoice resource.", "description": "Retrieves a RepeatingInvoice resource.", "parameters": [ { "name": "id", "in": "path", "description": "Resource identifier", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "deprecated": false }, "put": { "operationId": "putRepeatingInvoiceItem", "tags": [ "RepeatingInvoice" ], "responses": { "200": { "description": "RepeatingInvoice resource updated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RepeatingInvoice" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/RepeatingInvoice" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/RepeatingInvoice" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/RepeatingInvoice" } }, "text/html": { "schema": { "$ref": "#/components/schemas/RepeatingInvoice" } } }, "links": { "GetRepeatingInvoiceItem": { "operationId": "getRepeatingInvoiceItem", "parameters": { "id": "$response.body#/id" }, "description": "The `id` value returned in the response can be used as the `id` parameter in `GET /repeating_invoices/{id}`." } } }, "400": { "description": "Invalid input" }, "422": { "description": "Unprocessable entity" }, "404": { "description": "Resource not found" } }, "summary": "Replaces the RepeatingInvoice resource.", "description": "Replaces the RepeatingInvoice resource.", "parameters": [ { "name": "id", "in": "path", "description": "Resource identifier", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "requestBody": { "description": "The updated RepeatingInvoice resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RepeatingInvoice" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/RepeatingInvoice" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/RepeatingInvoice" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/RepeatingInvoice" } }, "text/html": { "schema": { "$ref": "#/components/schemas/RepeatingInvoice" } } }, "required": true }, "deprecated": false }, "delete": { "operationId": "deleteRepeatingInvoiceItem", "tags": [ "RepeatingInvoice" ], "responses": { "204": { "description": "RepeatingInvoice resource deleted" }, "404": { "description": "Resource not found" } }, "summary": "Removes the RepeatingInvoice resource.", "description": "Removes the RepeatingInvoice resource.", "parameters": [ { "name": "id", "in": "path", "description": "Resource identifier", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "deprecated": false }, "parameters": [] }, "/reports": { "get": { "operationId": "getReportCollection", "tags": [ "Report" ], "responses": { "200": { "description": "Report collection", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Report" } } }, "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Report" } } }, "text/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Report" } } }, "text/csv": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Report" } } }, "text/html": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Report" } } } } } }, "summary": "Retrieves the collection of Report resources.", "description": "Retrieves the collection of Report resources.", "parameters": [ { "name": "page", "in": "query", "description": "The collection page number", "required": false, "deprecated": false, "allowEmptyValue": true, "schema": { "type": "integer", "default": 1 }, "style": "form", "explode": false, "allowReserved": false }, { "name": "itemsPerPage", "in": "query", "description": "The number of items per page", "required": false, "deprecated": false, "allowEmptyValue": true, "schema": { "type": "integer", "default": 100, "minimum": 0, "maximum": 200 }, "style": "form", "explode": false, "allowReserved": false } ], "deprecated": false }, "parameters": [] }, "/reports/{id}": { "get": { "operationId": "getReportItem", "tags": [ "Report" ], "responses": { "200": { "description": "Report resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Report" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/Report" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/Report" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/Report" } }, "text/html": { "schema": { "$ref": "#/components/schemas/Report" } } } }, "404": { "description": "Resource not found" } }, "summary": "Retrieves a Report resource.", "description": "Retrieves a Report resource.", "parameters": [ { "name": "id", "in": "path", "description": "Resource identifier", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "deprecated": false }, "parameters": [] }, "/reservations": { "get": { "operationId": "getReservationCollection", "tags": [ "Reservation" ], "responses": { "200": { "description": "Reservation collection", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Reservation" } } }, "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Reservation" } } }, "text/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Reservation" } } }, "text/csv": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Reservation" } } }, "text/html": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Reservation" } } } } } }, "summary": "Retrieves the collection of Reservation resources.", "description": "Retrieves the collection of Reservation resources.", "parameters": [ { "name": "page", "in": "query", "description": "The collection page number", "required": false, "deprecated": false, "allowEmptyValue": true, "schema": { "type": "integer", "default": 1 }, "style": "form", "explode": false, "allowReserved": false }, { "name": "itemsPerPage", "in": "query", "description": "The number of items per page", "required": false, "deprecated": false, "allowEmptyValue": true, "schema": { "type": "integer", "default": 100, "minimum": 0, "maximum": 200 }, "style": "form", "explode": false, "allowReserved": false } ], "deprecated": false }, "parameters": [] }, "/reservations/{id}": { "get": { "operationId": "getReservationItem", "tags": [ "Reservation" ], "responses": { "200": { "description": "Reservation resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Reservation" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/Reservation" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/Reservation" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/Reservation" } }, "text/html": { "schema": { "$ref": "#/components/schemas/Reservation" } } } }, "404": { "description": "Resource not found" } }, "summary": "Retrieves a Reservation resource.", "description": "Retrieves a Reservation resource.", "parameters": [ { "name": "id", "in": "path", "description": "Resource identifier", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "deprecated": false }, "parameters": [] }, "/revenue_stats": { "get": { "operationId": "getRevenueStatCollection", "tags": [ "RevenueStat" ], "responses": { "200": { "description": "RevenueStat collection", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/RevenueStat" } } }, "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/RevenueStat" } } }, "text/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/RevenueStat" } } }, "text/csv": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/RevenueStat" } } }, "text/html": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/RevenueStat" } } } } } }, "summary": "Retrieves the collection of RevenueStat resources.", "description": "Retrieves the collection of RevenueStat resources.", "parameters": [ { "name": "page", "in": "query", "description": "The collection page number", "required": false, "deprecated": false, "allowEmptyValue": true, "schema": { "type": "integer", "default": 1 }, "style": "form", "explode": false, "allowReserved": false }, { "name": "itemsPerPage", "in": "query", "description": "The number of items per page", "required": false, "deprecated": false, "allowEmptyValue": true, "schema": { "type": "integer", "default": 100, "minimum": 0, "maximum": 200 }, "style": "form", "explode": false, "allowReserved": false } ], "deprecated": false }, "parameters": [] }, "/revenue_stats/{id}": { "get": { "operationId": "getRevenueStatItem", "tags": [ "RevenueStat" ], "responses": { "200": { "description": "RevenueStat resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RevenueStat" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/RevenueStat" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/RevenueStat" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/RevenueStat" } }, "text/html": { "schema": { "$ref": "#/components/schemas/RevenueStat" } } } }, "404": { "description": "Resource not found" } }, "summary": "Retrieves a RevenueStat resource.", "description": "Retrieves a RevenueStat resource.", "parameters": [ { "name": "id", "in": "path", "description": "Resource identifier", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "deprecated": false }, "parameters": [] }, "/sales_orders": { "get": { "operationId": "getSalesOrderCollection", "tags": [ "SalesOrder" ], "responses": { "200": { "description": "SalesOrder collection", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SalesOrder" } } }, "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SalesOrder" } } }, "text/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SalesOrder" } } }, "text/csv": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SalesOrder" } } }, "text/html": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SalesOrder" } } } } } }, "summary": "Retrieves the collection of SalesOrder resources.", "description": "Retrieves the collection of SalesOrder resources.", "parameters": [ { "name": "page", "in": "query", "description": "The collection page number", "required": false, "deprecated": false, "allowEmptyValue": true, "schema": { "type": "integer", "default": 1 }, "style": "form", "explode": false, "allowReserved": false }, { "name": "itemsPerPage", "in": "query", "description": "The number of items per page", "required": false, "deprecated": false, "allowEmptyValue": true, "schema": { "type": "integer", "default": 100, "minimum": 0, "maximum": 200 }, "style": "form", "explode": false, "allowReserved": false } ], "deprecated": false }, "parameters": [] }, "/sales_orders/{id}": { "get": { "operationId": "getSalesOrderItem", "tags": [ "SalesOrder" ], "responses": { "200": { "description": "SalesOrder resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SalesOrder" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/SalesOrder" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/SalesOrder" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/SalesOrder" } }, "text/html": { "schema": { "$ref": "#/components/schemas/SalesOrder" } } } }, "404": { "description": "Resource not found" } }, "summary": "Retrieves a SalesOrder resource.", "description": "Retrieves a SalesOrder resource.", "parameters": [ { "name": "id", "in": "path", "description": "Resource identifier", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "deprecated": false }, "parameters": [] }, "/site_events": { "get": { "operationId": "getSiteEventCollection", "tags": [ "SiteEvent" ], "responses": { "200": { "description": "SiteEvent collection", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SiteEvent" } } }, "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SiteEvent" } } }, "text/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SiteEvent" } } }, "text/csv": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SiteEvent" } } }, "text/html": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SiteEvent" } } } } } }, "summary": "Retrieves the collection of SiteEvent resources.", "description": "Retrieves the collection of SiteEvent resources.", "parameters": [ { "name": "page", "in": "query", "description": "The collection page number", "required": false, "deprecated": false, "allowEmptyValue": true, "schema": { "type": "integer", "default": 1 }, "style": "form", "explode": false, "allowReserved": false }, { "name": "itemsPerPage", "in": "query", "description": "The number of items per page", "required": false, "deprecated": false, "allowEmptyValue": true, "schema": { "type": "integer", "default": 100, "minimum": 0, "maximum": 200 }, "style": "form", "explode": false, "allowReserved": false } ], "deprecated": false }, "parameters": [] }, "/site_events/{id}": { "get": { "operationId": "getSiteEventItem", "tags": [ "SiteEvent" ], "responses": { "200": { "description": "SiteEvent resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SiteEvent" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/SiteEvent" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/SiteEvent" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/SiteEvent" } }, "text/html": { "schema": { "$ref": "#/components/schemas/SiteEvent" } } } }, "404": { "description": "Resource not found" } }, "summary": "Retrieves a SiteEvent resource.", "description": "Retrieves a SiteEvent resource.", "parameters": [ { "name": "id", "in": "path", "description": "Resource identifier", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "deprecated": false }, "parameters": [] }, "/statements": { "get": { "operationId": "getStatementCollection", "tags": [ "Statement" ], "responses": { "200": { "description": "Statement collection", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Statement" } } }, "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Statement" } } }, "text/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Statement" } } }, "text/csv": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Statement" } } }, "text/html": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Statement" } } } } } }, "summary": "Retrieves the collection of Statement resources.", "description": "Retrieves the collection of Statement resources.", "parameters": [ { "name": "page", "in": "query", "description": "The collection page number", "required": false, "deprecated": false, "allowEmptyValue": true, "schema": { "type": "integer", "default": 1 }, "style": "form", "explode": false, "allowReserved": false }, { "name": "itemsPerPage", "in": "query", "description": "The number of items per page", "required": false, "deprecated": false, "allowEmptyValue": true, "schema": { "type": "integer", "default": 100, "minimum": 0, "maximum": 200 }, "style": "form", "explode": false, "allowReserved": false } ], "deprecated": false }, "parameters": [] }, "/statements/{id}": { "get": { "operationId": "getStatementItem", "tags": [ "Statement" ], "responses": { "200": { "description": "Statement resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Statement" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/Statement" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/Statement" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/Statement" } }, "text/html": { "schema": { "$ref": "#/components/schemas/Statement" } } } }, "404": { "description": "Resource not found" } }, "summary": "Retrieves a Statement resource.", "description": "Retrieves a Statement resource.", "parameters": [ { "name": "id", "in": "path", "description": "Resource identifier", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "deprecated": false }, "parameters": [] }, "/subscriber_locations": { "get": { "operationId": "getSubscriberLocationCollection", "tags": [ "SubscriberLocation" ], "responses": { "200": { "description": "SubscriberLocation collection", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SubscriberLocation" } } }, "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SubscriberLocation" } } }, "text/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SubscriberLocation" } } }, "text/csv": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SubscriberLocation" } } }, "text/html": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SubscriberLocation" } } } } } }, "summary": "Retrieves the collection of SubscriberLocation resources.", "description": "Retrieves the collection of SubscriberLocation resources.", "parameters": [ { "name": "page", "in": "query", "description": "The collection page number", "required": false, "deprecated": false, "allowEmptyValue": true, "schema": { "type": "integer", "default": 1 }, "style": "form", "explode": false, "allowReserved": false }, { "name": "itemsPerPage", "in": "query", "description": "The number of items per page", "required": false, "deprecated": false, "allowEmptyValue": true, "schema": { "type": "integer", "default": 100, "minimum": 0, "maximum": 200 }, "style": "form", "explode": false, "allowReserved": false } ], "deprecated": false }, "parameters": [] }, "/subscriber_locations/{id}": { "get": { "operationId": "getSubscriberLocationItem", "tags": [ "SubscriberLocation" ], "responses": { "200": { "description": "SubscriberLocation resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SubscriberLocation" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/SubscriberLocation" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/SubscriberLocation" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/SubscriberLocation" } }, "text/html": { "schema": { "$ref": "#/components/schemas/SubscriberLocation" } } } }, "404": { "description": "Resource not found" } }, "summary": "Retrieves a SubscriberLocation resource.", "description": "Retrieves a SubscriberLocation resource.", "parameters": [ { "name": "id", "in": "path", "description": "Resource identifier", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "deprecated": false }, "parameters": [] }, "/subscriptions": { "get": { "operationId": "getSubscriptionCollection", "tags": [ "Subscription" ], "responses": { "200": { "description": "Subscription collection", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Subscription" } } }, "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Subscription" } } }, "text/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Subscription" } } }, "text/csv": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Subscription" } } }, "text/html": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Subscription" } } } } } }, "summary": "Retrieves the collection of Subscription resources.", "description": "Retrieves the collection of Subscription resources.", "parameters": [ { "name": "page", "in": "query", "description": "The collection page number", "required": false, "deprecated": false, "allowEmptyValue": true, "schema": { "type": "integer", "default": 1 }, "style": "form", "explode": false, "allowReserved": false }, { "name": "itemsPerPage", "in": "query", "description": "The number of items per page", "required": false, "deprecated": false, "allowEmptyValue": true, "schema": { "type": "integer", "default": 100, "minimum": 0, "maximum": 200 }, "style": "form", "explode": false, "allowReserved": false } ], "deprecated": false }, "post": { "operationId": "postSubscriptionCollection", "tags": [ "Subscription" ], "responses": { "201": { "description": "Subscription resource created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Subscription" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/Subscription" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/Subscription" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/Subscription" } }, "text/html": { "schema": { "$ref": "#/components/schemas/Subscription" } } }, "links": { "GetSubscriptionItem": { "operationId": "getSubscriptionItem", "parameters": { "id": "$response.body#/id" }, "description": "The `id` value returned in the response can be used as the `id` parameter in `GET /subscriptions/{id}`." } } }, "400": { "description": "Invalid input" }, "422": { "description": "Unprocessable entity" } }, "summary": "Creates a Subscription resource.", "description": "Creates a Subscription resource.", "parameters": [], "requestBody": { "description": "The new Subscription resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Subscription" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/Subscription" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/Subscription" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/Subscription" } }, "text/html": { "schema": { "$ref": "#/components/schemas/Subscription" } } }, "required": true }, "deprecated": false }, "parameters": [] }, "/subscriptions/{id}": { "get": { "operationId": "getSubscriptionItem", "tags": [ "Subscription" ], "responses": { "200": { "description": "Subscription resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Subscription" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/Subscription" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/Subscription" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/Subscription" } }, "text/html": { "schema": { "$ref": "#/components/schemas/Subscription" } } } }, "404": { "description": "Resource not found" } }, "summary": "Retrieves a Subscription resource.", "description": "Retrieves a Subscription resource.", "parameters": [ { "name": "id", "in": "path", "description": "Resource identifier", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "deprecated": false }, "put": { "operationId": "putSubscriptionItem", "tags": [ "Subscription" ], "responses": { "200": { "description": "Subscription resource updated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Subscription" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/Subscription" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/Subscription" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/Subscription" } }, "text/html": { "schema": { "$ref": "#/components/schemas/Subscription" } } }, "links": { "GetSubscriptionItem": { "operationId": "getSubscriptionItem", "parameters": { "id": "$response.body#/id" }, "description": "The `id` value returned in the response can be used as the `id` parameter in `GET /subscriptions/{id}`." } } }, "400": { "description": "Invalid input" }, "422": { "description": "Unprocessable entity" }, "404": { "description": "Resource not found" } }, "summary": "Replaces the Subscription resource.", "description": "Replaces the Subscription resource.", "parameters": [ { "name": "id", "in": "path", "description": "Resource identifier", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "requestBody": { "description": "The updated Subscription resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Subscription" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/Subscription" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/Subscription" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/Subscription" } }, "text/html": { "schema": { "$ref": "#/components/schemas/Subscription" } } }, "required": true }, "deprecated": false }, "delete": { "operationId": "deleteSubscriptionItem", "tags": [ "Subscription" ], "responses": { "204": { "description": "Subscription resource deleted" }, "404": { "description": "Resource not found" } }, "summary": "Removes the Subscription resource.", "description": "Removes the Subscription resource.", "parameters": [ { "name": "id", "in": "path", "description": "Resource identifier", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "deprecated": false }, "parameters": [] }, "/support_tickets": { "get": { "operationId": "getSupportTicketCollection", "tags": [ "SupportTicket" ], "responses": { "200": { "description": "SupportTicket collection", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SupportTicket" } } }, "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SupportTicket" } } }, "text/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SupportTicket" } } }, "text/csv": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SupportTicket" } } }, "text/html": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SupportTicket" } } } } } }, "summary": "Retrieves the collection of SupportTicket resources.", "description": "Retrieves the collection of SupportTicket resources.", "parameters": [ { "name": "page", "in": "query", "description": "The collection page number", "required": false, "deprecated": false, "allowEmptyValue": true, "schema": { "type": "integer", "default": 1 }, "style": "form", "explode": false, "allowReserved": false }, { "name": "itemsPerPage", "in": "query", "description": "The number of items per page", "required": false, "deprecated": false, "allowEmptyValue": true, "schema": { "type": "integer", "default": 100, "minimum": 0, "maximum": 200 }, "style": "form", "explode": false, "allowReserved": false } ], "deprecated": false }, "parameters": [] }, "/support_tickets/{id}": { "get": { "operationId": "getSupportTicketItem", "tags": [ "SupportTicket" ], "responses": { "200": { "description": "SupportTicket resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SupportTicket" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/SupportTicket" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/SupportTicket" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/SupportTicket" } }, "text/html": { "schema": { "$ref": "#/components/schemas/SupportTicket" } } } }, "404": { "description": "Resource not found" } }, "summary": "Retrieves a SupportTicket resource.", "description": "Retrieves a SupportTicket resource.", "parameters": [ { "name": "id", "in": "path", "description": "Resource identifier", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "deprecated": false }, "parameters": [] }, "/tasks": { "get": { "operationId": "getTaskCollection", "tags": [ "Task" ], "responses": { "200": { "description": "Task collection", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Task" } } }, "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Task" } } }, "text/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Task" } } }, "text/csv": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Task" } } }, "text/html": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Task" } } } } } }, "summary": "Retrieves the collection of Task resources.", "description": "Retrieves the collection of Task resources.", "parameters": [ { "name": "page", "in": "query", "description": "The collection page number", "required": false, "deprecated": false, "allowEmptyValue": true, "schema": { "type": "integer", "default": 1 }, "style": "form", "explode": false, "allowReserved": false }, { "name": "itemsPerPage", "in": "query", "description": "The number of items per page", "required": false, "deprecated": false, "allowEmptyValue": true, "schema": { "type": "integer", "default": 100, "minimum": 0, "maximum": 200 }, "style": "form", "explode": false, "allowReserved": false } ], "deprecated": false }, "parameters": [] }, "/tasks/{id}": { "get": { "operationId": "getTaskItem", "tags": [ "Task" ], "responses": { "200": { "description": "Task resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Task" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/Task" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/Task" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/Task" } }, "text/html": { "schema": { "$ref": "#/components/schemas/Task" } } } }, "404": { "description": "Resource not found" } }, "summary": "Retrieves a Task resource.", "description": "Retrieves a Task resource.", "parameters": [ { "name": "id", "in": "path", "description": "Resource identifier", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "deprecated": false }, "parameters": [] }, "/tax_agencies": { "get": { "operationId": "getTaxAgencyCollection", "tags": [ "TaxAgency" ], "responses": { "200": { "description": "TaxAgency collection", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TaxAgency" } } }, "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TaxAgency" } } }, "text/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TaxAgency" } } }, "text/csv": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TaxAgency" } } }, "text/html": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TaxAgency" } } } } } }, "summary": "Retrieves the collection of TaxAgency resources.", "description": "Retrieves the collection of TaxAgency resources.", "parameters": [ { "name": "page", "in": "query", "description": "The collection page number", "required": false, "deprecated": false, "allowEmptyValue": true, "schema": { "type": "integer", "default": 1 }, "style": "form", "explode": false, "allowReserved": false }, { "name": "itemsPerPage", "in": "query", "description": "The number of items per page", "required": false, "deprecated": false, "allowEmptyValue": true, "schema": { "type": "integer", "default": 100, "minimum": 0, "maximum": 200 }, "style": "form", "explode": false, "allowReserved": false } ], "deprecated": false }, "parameters": [] }, "/tax_agencies/{id}": { "get": { "operationId": "getTaxAgencyItem", "tags": [ "TaxAgency" ], "responses": { "200": { "description": "TaxAgency resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TaxAgency" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/TaxAgency" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/TaxAgency" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/TaxAgency" } }, "text/html": { "schema": { "$ref": "#/components/schemas/TaxAgency" } } } }, "404": { "description": "Resource not found" } }, "summary": "Retrieves a TaxAgency resource.", "description": "Retrieves a TaxAgency resource.", "parameters": [ { "name": "id", "in": "path", "description": "Resource identifier", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "deprecated": false }, "parameters": [] }, "/tax_rates": { "get": { "operationId": "getTaxRateCollection", "tags": [ "TaxRate" ], "responses": { "200": { "description": "TaxRate collection", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TaxRate" } } }, "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TaxRate" } } }, "text/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TaxRate" } } }, "text/csv": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TaxRate" } } }, "text/html": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TaxRate" } } } } } }, "summary": "Retrieves the collection of TaxRate resources.", "description": "Retrieves the collection of TaxRate resources.", "parameters": [ { "name": "page", "in": "query", "description": "The collection page number", "required": false, "deprecated": false, "allowEmptyValue": true, "schema": { "type": "integer", "default": 1 }, "style": "form", "explode": false, "allowReserved": false }, { "name": "itemsPerPage", "in": "query", "description": "The number of items per page", "required": false, "deprecated": false, "allowEmptyValue": true, "schema": { "type": "integer", "default": 100, "minimum": 0, "maximum": 200 }, "style": "form", "explode": false, "allowReserved": false } ], "deprecated": false }, "parameters": [] }, "/tax_rates/{id}": { "get": { "operationId": "getTaxRateItem", "tags": [ "TaxRate" ], "responses": { "200": { "description": "TaxRate resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TaxRate" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/TaxRate" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/TaxRate" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/TaxRate" } }, "text/html": { "schema": { "$ref": "#/components/schemas/TaxRate" } } } }, "404": { "description": "Resource not found" } }, "summary": "Retrieves a TaxRate resource.", "description": "Retrieves a TaxRate resource.", "parameters": [ { "name": "id", "in": "path", "description": "Resource identifier", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "deprecated": false }, "parameters": [] }, "/terms": { "get": { "operationId": "getTermCollection", "tags": [ "Term" ], "responses": { "200": { "description": "Term collection", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Term" } } }, "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Term" } } }, "text/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Term" } } }, "text/csv": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Term" } } }, "text/html": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Term" } } } } } }, "summary": "Retrieves the collection of Term resources.", "description": "Retrieves the collection of Term resources.", "parameters": [ { "name": "page", "in": "query", "description": "The collection page number", "required": false, "deprecated": false, "allowEmptyValue": true, "schema": { "type": "integer", "default": 1 }, "style": "form", "explode": false, "allowReserved": false }, { "name": "itemsPerPage", "in": "query", "description": "The number of items per page", "required": false, "deprecated": false, "allowEmptyValue": true, "schema": { "type": "integer", "default": 100, "minimum": 0, "maximum": 200 }, "style": "form", "explode": false, "allowReserved": false } ], "deprecated": false }, "parameters": [] }, "/terms/{id}": { "get": { "operationId": "getTermItem", "tags": [ "Term" ], "responses": { "200": { "description": "Term resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Term" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/Term" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/Term" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/Term" } }, "text/html": { "schema": { "$ref": "#/components/schemas/Term" } } } }, "404": { "description": "Resource not found" } }, "summary": "Retrieves a Term resource.", "description": "Retrieves a Term resource.", "parameters": [ { "name": "id", "in": "path", "description": "Resource identifier", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "deprecated": false }, "parameters": [] }, "/tracking_categories": { "get": { "operationId": "getTrackingCategoryCollection", "tags": [ "TrackingCategory" ], "responses": { "200": { "description": "TrackingCategory collection", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TrackingCategory" } } }, "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TrackingCategory" } } }, "text/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TrackingCategory" } } }, "text/csv": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TrackingCategory" } } }, "text/html": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TrackingCategory" } } } } } }, "summary": "Retrieves the collection of TrackingCategory resources.", "description": "Retrieves the collection of TrackingCategory resources.", "parameters": [ { "name": "page", "in": "query", "description": "The collection page number", "required": false, "deprecated": false, "allowEmptyValue": true, "schema": { "type": "integer", "default": 1 }, "style": "form", "explode": false, "allowReserved": false }, { "name": "itemsPerPage", "in": "query", "description": "The number of items per page", "required": false, "deprecated": false, "allowEmptyValue": true, "schema": { "type": "integer", "default": 100, "minimum": 0, "maximum": 200 }, "style": "form", "explode": false, "allowReserved": false } ], "deprecated": false }, "parameters": [] }, "/tracking_categories/{id}": { "get": { "operationId": "getTrackingCategoryItem", "tags": [ "TrackingCategory" ], "responses": { "200": { "description": "TrackingCategory resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TrackingCategory" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/TrackingCategory" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/TrackingCategory" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/TrackingCategory" } }, "text/html": { "schema": { "$ref": "#/components/schemas/TrackingCategory" } } } }, "404": { "description": "Resource not found" } }, "summary": "Retrieves a TrackingCategory resource.", "description": "Retrieves a TrackingCategory resource.", "parameters": [ { "name": "id", "in": "path", "description": "Resource identifier", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "deprecated": false }, "parameters": [] }, "/transaction_match_report": { "get": { "operationId": "getTransactionMatchReportItem", "tags": [ "TransactionMatchReport" ], "responses": { "200": { "description": "TransactionMatchReport resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TransactionMatchReport" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/TransactionMatchReport" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/TransactionMatchReport" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/TransactionMatchReport" } }, "text/html": { "schema": { "$ref": "#/components/schemas/TransactionMatchReport" } } } }, "404": { "description": "Resource not found" } }, "summary": "Retrieves a transaction match report which includes a details array and a summary", "description": "Retrieves a TransactionMatchReport resource.", "parameters": [ { "name": "start", "in": "query", "description": "YYYY-MM-DD", "required": false, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string", "format": "date-time" }, "style": "form", "explode": false, "allowReserved": false, "example": "2022-07-01" }, { "name": "end", "in": "query", "description": "YYYY-MM-DD", "required": false, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string", "format": "date-time" }, "style": "form", "explode": false, "allowReserved": false, "example": "2022-08-31" }, { "name": "refresh", "in": "query", "description": "If refresh is set, data will be fetched from the source application even when cached data is available", "required": false, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "form", "explode": false, "allowReserved": false, "example": "true" } ], "deprecated": false }, "parameters": [] }, "/transaction_match_series": { "get": { "operationId": "getTransactionMatchSeriesItem", "tags": [ "TransactionMatchSeries" ], "responses": { "200": { "description": "TransactionMatchSeries resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TransactionMatchSeries" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/TransactionMatchSeries" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/TransactionMatchSeries" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/TransactionMatchSeries" } }, "text/html": { "schema": { "$ref": "#/components/schemas/TransactionMatchSeries" } } } }, "404": { "description": "Resource not found" } }, "summary": "Retrieves a monthly series of transaction match reports which include details arrays and summaries", "description": "Retrieves a TransactionMatchSeries resource.", "parameters": [ { "name": "start", "in": "query", "description": "YYYY-MM-DD", "required": false, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string", "format": "date-time" }, "style": "form", "explode": false, "allowReserved": false, "example": "2022-07-01" }, { "name": "end", "in": "query", "description": "YYYY-MM-DD", "required": false, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string", "format": "date-time" }, "style": "form", "explode": false, "allowReserved": false, "example": "2022-08-31" }, { "name": "refresh", "in": "query", "description": "If refresh is set, data will be fetched from the source application even when cached data is available", "required": false, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "form", "explode": false, "allowReserved": false, "example": "true" } ], "deprecated": false }, "parameters": [] }, "/transactions": { "get": { "operationId": "getTransactionCollection", "tags": [ "Transaction" ], "responses": { "200": { "description": "Transaction collection", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Transaction" } } }, "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Transaction" } } }, "text/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Transaction" } } }, "text/csv": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Transaction" } } }, "text/html": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Transaction" } } } } } }, "summary": "Retrieves a Collection of transaction resources", "description": "Retrieves a Collection of transaction resources", "parameters": [ { "name": "start", "in": "query", "description": "YYYY-MM-DD", "required": false, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string", "format": "date-time" }, "style": "form", "explode": false, "allowReserved": false, "example": "2022-07-01" }, { "name": "end", "in": "query", "description": "YYYY-MM-DD", "required": false, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string", "format": "date-time" }, "style": "form", "explode": false, "allowReserved": false, "example": "2022-08-31" }, { "name": "page", "in": "query", "description": "The collection page number", "required": false, "deprecated": false, "allowEmptyValue": true, "schema": { "type": "integer", "default": 1 }, "style": "form", "explode": false, "allowReserved": false }, { "name": "itemsPerPage", "in": "query", "description": "The number of items per page", "required": false, "deprecated": false, "allowEmptyValue": true, "schema": { "type": "integer", "default": 100, "minimum": 0, "maximum": 200 }, "style": "form", "explode": false, "allowReserved": false } ], "deprecated": false }, "parameters": [] }, "/transactions/{id}": { "get": { "operationId": "getTransactionItem", "tags": [ "Transaction" ], "responses": { "200": { "description": "Transaction resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Transaction" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/Transaction" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/Transaction" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/Transaction" } }, "text/html": { "schema": { "$ref": "#/components/schemas/Transaction" } } } }, "404": { "description": "Resource not found" } }, "summary": "Retrieves a Transaction resource.", "description": "Retrieves a Transaction resource.", "parameters": [ { "name": "id", "in": "path", "description": "Resource identifier", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "deprecated": false }, "parameters": [] }, "/trial_balances": { "get": { "operationId": "getTrialBalanceItem", "tags": [ "TrialBalance" ], "responses": { "200": { "description": "TrialBalance resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TrialBalance" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/TrialBalance" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/TrialBalance" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/TrialBalance" } }, "text/html": { "schema": { "$ref": "#/components/schemas/TrialBalance" } } } }, "404": { "description": "Resource not found" } }, "summary": "Retrieves a TrialBalance resource.", "description": "Retrieves a TrialBalance resource.", "parameters": [ { "name": "end", "in": "query", "description": "YYYY-MM-DD", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string", "format": "date-time" }, "style": "form", "explode": false, "allowReserved": false, "example": "2022-11-30" }, { "name": "accounting_method", "in": "query", "description": "The Accounting Method", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string", "enum": [ "cash", "accrual" ] }, "style": "form", "explode": false, "allowReserved": false, "example": "accrual" } ], "deprecated": false }, "parameters": [] }, "/unbilled_charges": { "get": { "operationId": "getUnbilledChargeCollection", "tags": [ "UnbilledCharge" ], "responses": { "200": { "description": "UnbilledCharge collection", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/UnbilledCharge" } } }, "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/UnbilledCharge" } } }, "text/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/UnbilledCharge" } } }, "text/csv": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/UnbilledCharge" } } }, "text/html": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/UnbilledCharge" } } } } } }, "summary": "Retrieves the collection of UnbilledCharge resources.", "description": "Retrieves the collection of UnbilledCharge resources.", "parameters": [ { "name": "page", "in": "query", "description": "The collection page number", "required": false, "deprecated": false, "allowEmptyValue": true, "schema": { "type": "integer", "default": 1 }, "style": "form", "explode": false, "allowReserved": false }, { "name": "itemsPerPage", "in": "query", "description": "The number of items per page", "required": false, "deprecated": false, "allowEmptyValue": true, "schema": { "type": "integer", "default": 100, "minimum": 0, "maximum": 200 }, "style": "form", "explode": false, "allowReserved": false } ], "deprecated": false }, "parameters": [] }, "/unbilled_charges/{id}": { "get": { "operationId": "getUnbilledChargeItem", "tags": [ "UnbilledCharge" ], "responses": { "200": { "description": "UnbilledCharge resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnbilledCharge" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/UnbilledCharge" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/UnbilledCharge" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/UnbilledCharge" } }, "text/html": { "schema": { "$ref": "#/components/schemas/UnbilledCharge" } } } }, "404": { "description": "Resource not found" } }, "summary": "Retrieves a UnbilledCharge resource.", "description": "Retrieves a UnbilledCharge resource.", "parameters": [ { "name": "id", "in": "path", "description": "Resource identifier", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "deprecated": false }, "parameters": [] }, "/users": { "get": { "operationId": "getUserCollection", "tags": [ "User" ], "responses": { "200": { "description": "User collection", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/User" } } }, "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/User" } } }, "text/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/User" } } }, "text/csv": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/User" } } }, "text/html": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/User" } } } } } }, "summary": "Retrieves the collection of User resources.", "description": "Retrieves the collection of User resources.", "parameters": [ { "name": "page", "in": "query", "description": "The collection page number", "required": false, "deprecated": false, "allowEmptyValue": true, "schema": { "type": "integer", "default": 1 }, "style": "form", "explode": false, "allowReserved": false }, { "name": "itemsPerPage", "in": "query", "description": "The number of items per page", "required": false, "deprecated": false, "allowEmptyValue": true, "schema": { "type": "integer", "default": 100, "minimum": 0, "maximum": 200 }, "style": "form", "explode": false, "allowReserved": false } ], "deprecated": false }, "parameters": [] }, "/users/{id}": { "get": { "operationId": "getUserItem", "tags": [ "User" ], "responses": { "200": { "description": "User resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/User" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/User" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/User" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/User" } }, "text/html": { "schema": { "$ref": "#/components/schemas/User" } } } }, "404": { "description": "Resource not found" } }, "summary": "Retrieves a User resource.", "description": "Retrieves a User resource.", "parameters": [ { "name": "id", "in": "path", "description": "Resource identifier", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "deprecated": false }, "parameters": [] }, "/vendor_credits": { "get": { "operationId": "getVendorCreditCollection", "tags": [ "VendorCredit" ], "responses": { "200": { "description": "VendorCredit collection", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/VendorCredit" } } }, "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/VendorCredit" } } }, "text/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/VendorCredit" } } }, "text/csv": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/VendorCredit" } } }, "text/html": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/VendorCredit" } } } } } }, "summary": "Retrieves the collection of VendorCredit resources.", "description": "Retrieves the collection of VendorCredit resources.", "parameters": [ { "name": "page", "in": "query", "description": "The collection page number", "required": false, "deprecated": false, "allowEmptyValue": true, "schema": { "type": "integer", "default": 1 }, "style": "form", "explode": false, "allowReserved": false }, { "name": "itemsPerPage", "in": "query", "description": "The number of items per page", "required": false, "deprecated": false, "allowEmptyValue": true, "schema": { "type": "integer", "default": 100, "minimum": 0, "maximum": 200 }, "style": "form", "explode": false, "allowReserved": false } ], "deprecated": false }, "post": { "operationId": "postVendorCreditCollection", "tags": [ "VendorCredit" ], "responses": { "201": { "description": "VendorCredit resource created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VendorCredit" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/VendorCredit" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/VendorCredit" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/VendorCredit" } }, "text/html": { "schema": { "$ref": "#/components/schemas/VendorCredit" } } }, "links": { "GetVendorCreditItem": { "operationId": "getVendorCreditItem", "parameters": { "id": "$response.body#/id" }, "description": "The `id` value returned in the response can be used as the `id` parameter in `GET /vendor_credits/{id}`." } } }, "400": { "description": "Invalid input" }, "422": { "description": "Unprocessable entity" } }, "summary": "Creates a VendorCredit resource.", "description": "Creates a VendorCredit resource.", "parameters": [], "requestBody": { "description": "The new VendorCredit resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VendorCredit" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/VendorCredit" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/VendorCredit" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/VendorCredit" } }, "text/html": { "schema": { "$ref": "#/components/schemas/VendorCredit" } } }, "required": true }, "deprecated": false }, "parameters": [] }, "/vendor_credits/{id}": { "get": { "operationId": "getVendorCreditItem", "tags": [ "VendorCredit" ], "responses": { "200": { "description": "VendorCredit resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VendorCredit" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/VendorCredit" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/VendorCredit" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/VendorCredit" } }, "text/html": { "schema": { "$ref": "#/components/schemas/VendorCredit" } } } }, "404": { "description": "Resource not found" } }, "summary": "Retrieves a VendorCredit resource.", "description": "Retrieves a VendorCredit resource.", "parameters": [ { "name": "id", "in": "path", "description": "Resource identifier", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "deprecated": false }, "put": { "operationId": "putVendorCreditItem", "tags": [ "VendorCredit" ], "responses": { "200": { "description": "VendorCredit resource updated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VendorCredit" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/VendorCredit" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/VendorCredit" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/VendorCredit" } }, "text/html": { "schema": { "$ref": "#/components/schemas/VendorCredit" } } }, "links": { "GetVendorCreditItem": { "operationId": "getVendorCreditItem", "parameters": { "id": "$response.body#/id" }, "description": "The `id` value returned in the response can be used as the `id` parameter in `GET /vendor_credits/{id}`." } } }, "400": { "description": "Invalid input" }, "422": { "description": "Unprocessable entity" }, "404": { "description": "Resource not found" } }, "summary": "Replaces the VendorCredit resource.", "description": "Replaces the VendorCredit resource.", "parameters": [ { "name": "id", "in": "path", "description": "Resource identifier", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "requestBody": { "description": "The updated VendorCredit resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VendorCredit" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/VendorCredit" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/VendorCredit" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/VendorCredit" } }, "text/html": { "schema": { "$ref": "#/components/schemas/VendorCredit" } } }, "required": true }, "deprecated": false }, "delete": { "operationId": "deleteVendorCreditItem", "tags": [ "VendorCredit" ], "responses": { "204": { "description": "VendorCredit resource deleted" }, "404": { "description": "Resource not found" } }, "summary": "Removes the VendorCredit resource.", "description": "Removes the VendorCredit resource.", "parameters": [ { "name": "id", "in": "path", "description": "Resource identifier", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "deprecated": false }, "parameters": [] }, "/vendor_payments": { "get": { "operationId": "getVendorPaymentCollection", "tags": [ "VendorPayment" ], "responses": { "200": { "description": "VendorPayment collection", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/VendorPayment" } } }, "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/VendorPayment" } } }, "text/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/VendorPayment" } } }, "text/csv": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/VendorPayment" } } }, "text/html": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/VendorPayment" } } } } } }, "summary": "Retrieves the collection of VendorPayment resources.", "description": "Retrieves the collection of VendorPayment resources.", "parameters": [ { "name": "page", "in": "query", "description": "The collection page number", "required": false, "deprecated": false, "allowEmptyValue": true, "schema": { "type": "integer", "default": 1 }, "style": "form", "explode": false, "allowReserved": false }, { "name": "itemsPerPage", "in": "query", "description": "The number of items per page", "required": false, "deprecated": false, "allowEmptyValue": true, "schema": { "type": "integer", "default": 100, "minimum": 0, "maximum": 200 }, "style": "form", "explode": false, "allowReserved": false } ], "deprecated": false }, "post": { "operationId": "postVendorPaymentCollection", "tags": [ "VendorPayment" ], "responses": { "201": { "description": "VendorPayment resource created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VendorPayment" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/VendorPayment" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/VendorPayment" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/VendorPayment" } }, "text/html": { "schema": { "$ref": "#/components/schemas/VendorPayment" } } }, "links": { "GetVendorPaymentItem": { "operationId": "getVendorPaymentItem", "parameters": { "id": "$response.body#/id" }, "description": "The `id` value returned in the response can be used as the `id` parameter in `GET /vendor_payments/{id}`." } } }, "400": { "description": "Invalid input" }, "422": { "description": "Unprocessable entity" } }, "summary": "Creates a VendorPayment resource.", "description": "Creates a VendorPayment resource.", "parameters": [], "requestBody": { "description": "The new VendorPayment resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VendorPayment" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/VendorPayment" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/VendorPayment" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/VendorPayment" } }, "text/html": { "schema": { "$ref": "#/components/schemas/VendorPayment" } } }, "required": true }, "deprecated": false }, "parameters": [] }, "/vendor_payments/{id}": { "get": { "operationId": "getVendorPaymentItem", "tags": [ "VendorPayment" ], "responses": { "200": { "description": "VendorPayment resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VendorPayment" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/VendorPayment" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/VendorPayment" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/VendorPayment" } }, "text/html": { "schema": { "$ref": "#/components/schemas/VendorPayment" } } } }, "404": { "description": "Resource not found" } }, "summary": "Retrieves a VendorPayment resource.", "description": "Retrieves a VendorPayment resource.", "parameters": [ { "name": "id", "in": "path", "description": "Resource identifier", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "deprecated": false }, "put": { "operationId": "putVendorPaymentItem", "tags": [ "VendorPayment" ], "responses": { "200": { "description": "VendorPayment resource updated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VendorPayment" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/VendorPayment" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/VendorPayment" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/VendorPayment" } }, "text/html": { "schema": { "$ref": "#/components/schemas/VendorPayment" } } }, "links": { "GetVendorPaymentItem": { "operationId": "getVendorPaymentItem", "parameters": { "id": "$response.body#/id" }, "description": "The `id` value returned in the response can be used as the `id` parameter in `GET /vendor_payments/{id}`." } } }, "400": { "description": "Invalid input" }, "422": { "description": "Unprocessable entity" }, "404": { "description": "Resource not found" } }, "summary": "Replaces the VendorPayment resource.", "description": "Replaces the VendorPayment resource.", "parameters": [ { "name": "id", "in": "path", "description": "Resource identifier", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "requestBody": { "description": "The updated VendorPayment resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VendorPayment" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/VendorPayment" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/VendorPayment" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/VendorPayment" } }, "text/html": { "schema": { "$ref": "#/components/schemas/VendorPayment" } } }, "required": true }, "deprecated": false }, "delete": { "operationId": "deleteVendorPaymentItem", "tags": [ "VendorPayment" ], "responses": { "204": { "description": "VendorPayment resource deleted" }, "404": { "description": "Resource not found" } }, "summary": "Removes the VendorPayment resource.", "description": "Removes the VendorPayment resource.", "parameters": [ { "name": "id", "in": "path", "description": "Resource identifier", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "deprecated": false }, "parameters": [] }, "/vendors": { "get": { "operationId": "getVendorCollection", "tags": [ "Vendor" ], "responses": { "200": { "description": "Vendor collection", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Vendor" } } }, "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Vendor" } } }, "text/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Vendor" } } }, "text/csv": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Vendor" } } }, "text/html": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Vendor" } } } } } }, "summary": "Retrieves the collection of Vendor resources.", "description": "Retrieves the collection of Vendor resources.", "parameters": [ { "name": "page", "in": "query", "description": "The collection page number", "required": false, "deprecated": false, "allowEmptyValue": true, "schema": { "type": "integer", "default": 1 }, "style": "form", "explode": false, "allowReserved": false }, { "name": "itemsPerPage", "in": "query", "description": "The number of items per page", "required": false, "deprecated": false, "allowEmptyValue": true, "schema": { "type": "integer", "default": 100, "minimum": 0, "maximum": 200 }, "style": "form", "explode": false, "allowReserved": false } ], "deprecated": false }, "post": { "operationId": "postVendorCollection", "tags": [ "Vendor" ], "responses": { "201": { "description": "Vendor resource created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Vendor" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/Vendor" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/Vendor" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/Vendor" } }, "text/html": { "schema": { "$ref": "#/components/schemas/Vendor" } } }, "links": { "GetVendorItem": { "operationId": "getVendorItem", "parameters": { "id": "$response.body#/id" }, "description": "The `id` value returned in the response can be used as the `id` parameter in `GET /vendors/{id}`." } } }, "400": { "description": "Invalid input" }, "422": { "description": "Unprocessable entity" } }, "summary": "Creates a Vendor resource.", "description": "Creates a Vendor resource.", "parameters": [], "requestBody": { "description": "The new Vendor resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Vendor" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/Vendor" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/Vendor" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/Vendor" } }, "text/html": { "schema": { "$ref": "#/components/schemas/Vendor" } } }, "required": true }, "deprecated": false }, "parameters": [] }, "/vendors/{id}": { "get": { "operationId": "getVendorItem", "tags": [ "Vendor" ], "responses": { "200": { "description": "Vendor resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Vendor" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/Vendor" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/Vendor" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/Vendor" } }, "text/html": { "schema": { "$ref": "#/components/schemas/Vendor" } } } }, "404": { "description": "Resource not found" } }, "summary": "Retrieves a Vendor resource.", "description": "Retrieves a Vendor resource.", "parameters": [ { "name": "id", "in": "path", "description": "Resource identifier", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "deprecated": false }, "put": { "operationId": "putVendorItem", "tags": [ "Vendor" ], "responses": { "200": { "description": "Vendor resource updated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Vendor" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/Vendor" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/Vendor" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/Vendor" } }, "text/html": { "schema": { "$ref": "#/components/schemas/Vendor" } } }, "links": { "GetVendorItem": { "operationId": "getVendorItem", "parameters": { "id": "$response.body#/id" }, "description": "The `id` value returned in the response can be used as the `id` parameter in `GET /vendors/{id}`." } } }, "400": { "description": "Invalid input" }, "422": { "description": "Unprocessable entity" }, "404": { "description": "Resource not found" } }, "summary": "Replaces the Vendor resource.", "description": "Replaces the Vendor resource.", "parameters": [ { "name": "id", "in": "path", "description": "Resource identifier", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "requestBody": { "description": "The updated Vendor resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Vendor" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/Vendor" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/Vendor" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/Vendor" } }, "text/html": { "schema": { "$ref": "#/components/schemas/Vendor" } } }, "required": true }, "deprecated": false }, "delete": { "operationId": "deleteVendorItem", "tags": [ "Vendor" ], "responses": { "204": { "description": "Vendor resource deleted" }, "404": { "description": "Resource not found" } }, "summary": "Removes the Vendor resource.", "description": "Removes the Vendor resource.", "parameters": [ { "name": "id", "in": "path", "description": "Resource identifier", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "deprecated": false }, "parameters": [] }, "/workflows": { "get": { "operationId": "getWorkflowCollection", "tags": [ "Workflow" ], "responses": { "200": { "description": "Workflow collection", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Workflow" } } }, "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Workflow" } } }, "text/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Workflow" } } }, "text/csv": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Workflow" } } }, "text/html": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Workflow" } } } } } }, "summary": "Retrieves the collection of Workflow resources.", "description": "Retrieves the collection of Workflow resources.", "parameters": [ { "name": "page", "in": "query", "description": "The collection page number", "required": false, "deprecated": false, "allowEmptyValue": true, "schema": { "type": "integer", "default": 1 }, "style": "form", "explode": false, "allowReserved": false }, { "name": "itemsPerPage", "in": "query", "description": "The number of items per page", "required": false, "deprecated": false, "allowEmptyValue": true, "schema": { "type": "integer", "default": 100, "minimum": 0, "maximum": 200 }, "style": "form", "explode": false, "allowReserved": false } ], "deprecated": false }, "parameters": [] }, "/workflows/{id}": { "get": { "operationId": "getWorkflowItem", "tags": [ "Workflow" ], "responses": { "200": { "description": "Workflow resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Workflow" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/Workflow" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/Workflow" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/Workflow" } }, "text/html": { "schema": { "$ref": "#/components/schemas/Workflow" } } } }, "404": { "description": "Resource not found" } }, "summary": "Retrieves a Workflow resource.", "description": "Retrieves a Workflow resource.", "parameters": [ { "name": "id", "in": "path", "description": "Resource identifier", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "deprecated": false }, "parameters": [] } }, "components": { "schemas": { "Account": { "type": "object", "description": "Accounting chart of accounts", "properties": { "id": { "example": "quickbooks-726", "nullable": false, "readOnly": true, "description": "unique identifier for this account\nnote that no particular pattern in this field is guaranteed, only that this field is unique\ne.g. \"quickbooks-726\"", "type": "string" }, "integration": { "example": "quickbooks", "nullable": false, "description": "The key of the integration source\ne.g. \"quickbooks\", or \"xero\"", "type": "string" }, "code": { "example": "400", "nullable": true, "description": "customer defined code for the account\ne.g. \"400\"\ne.g. \"SALES\"", "type": "string" }, "taxType": { "example": "TAX001", "nullable": true, "description": "a tax code used for the account\ne.g. \"TAX001\"", "type": "string" }, "bankAccountNumber": { "example": "823772-2828773-09826", "nullable": true, "description": "a code used to identify a bank account, only applies to accounts directly linked to a bank account\ne.g. \"823772-2828773-09826\"", "type": "string" }, "bankAccountType": { "example": "CREDITCARD", "nullable": true, "description": "indicates the type of bank account being used\ne.g. \"BANK\"\ne.g. \"CREDITCARD\"\ne.g. \"PAYPAL\"", "type": "string" }, "currencyCode": { "example": "USD", "nullable": true, "description": "the currency code\ne.g. \"USD\"", "type": "string" }, "fullyQualifiedName": { "example": "Short Term Cash", "nullable": true, "description": "full canonical name for the account\ne.g. Short term cash", "type": "string" }, "name": { "example": "Sandra's Bank Account", "nullable": true, "description": "short name for the account\ne.g. \"Sandra's Bank Account\"", "type": "string" }, "classification": { "example": "Asset", "nullable": true, "description": "The accounting classification of the account, typically one of Asset, Liability, Equity, Revenue, or Expense.", "type": "string" }, "accountSubType": { "example": "BANK", "nullable": true, "description": "application based classification of the account\ne.g. \"BANK\"", "type": "string" }, "currentBalanceWithSubAccounts": { "example": "387687", "nullable": true, "description": "represents the total value of the account including any sub accounts in cents", "type": "string" }, "created": { "example": "2021-06-24 22:35:07", "nullable": true, "description": "when the account was created", "type": "string", "format": "date-time" }, "modified": { "example": "2021-06-24 22:35:07", "nullable": true, "description": "when any user modifiable attributes of the object were last changed", "type": "string", "format": "date-time" }, "accountType": { "example": "ASSET", "nullable": true, "description": "the type or class of the account\ne.g. \"ASSET\"", "type": "string" }, "currentBalance": { "example": "29872", "nullable": true, "description": "the value of the account excluding any sub accounts in cents", "type": "string" }, "active": { "example": true, "nullable": true, "description": "whether or not the account is active and should be included in calculations", "type": "boolean" }, "subAccount": { "example": false, "nullable": true, "description": "whether this account is actually a subaccount of another account", "type": "boolean" }, "description": { "example": "This is the main company account for income and expenses", "nullable": true, "description": "a user definable long form description of the account\ne.g. \"This is the main company account for income and expenses\"", "type": "string" }, "srcId": { "example": "GH2JK-67283H-YW82KHX-2883KK-KS78S", "nullable": true, "description": "the unique identifier of the source 3rd party integration\ne.g. \"GH2JK-67283H-YW82KHX-2883KK-KS78S\"", "type": "string" }, "parentAccountId": { "example": "JS882-67283H-YW82KHX-2883KK-DJ3SK", "nullable": true, "description": "if this is a subaccount then the id of the parent account\ne.g. \"JS882-67283H-YW82KHX-2883KK-DJ3SK\"", "type": "string" }, "deleted": { "example": false, "nullable": true, "description": "whether or not the account is active", "type": "boolean" } }, "required": [ "name" ] }, "AccountingTransaction": { "type": "object", "description": "", "properties": { "id": { "example": "quickbooks-34", "nullable": false, "description": "unique identifier for this invoice\nnote that no particular pattern in this field is guaranteed, only that this field is unique\ne.g. \"quickbooks-34\"", "type": "string" }, "integration": { "example": "quickbooks", "nullable": false, "description": "The key of the integration source\ne.g. \"quickbooks\", or \"xero\"", "type": "string" }, "srcId": { "description": "The unique identifier of the source 3rd party integration", "type": "string" }, "transactionId": { "description": "Transaction type\ne.g. Payment", "type": "string", "nullable": true }, "transactionType": { "description": "Transaction type\ne.g. Payment", "type": "string", "nullable": true }, "transactionNumber": { "description": "Transaction number\ne.g. Payment", "type": "string", "nullable": true }, "transactionDate": { "description": "Transaction date", "type": "string", "format": "date-time", "nullable": true }, "ContactId": { "type": "string", "nullable": true }, "ContactName": { "type": "string", "nullable": true }, "location": { "type": "string", "nullable": true }, "description": { "description": "Transaction description", "type": "string", "nullable": true }, "accountId": { "type": "string", "nullable": true }, "accountNumber": { "type": "string", "nullable": true }, "accountType": { "type": "string", "nullable": true }, "accountName": { "type": "string", "nullable": true }, "subAccountName": { "type": "string", "nullable": true }, "taxAmount": { "description": "Amount of the transaction in cents\ne.g: 870", "type": "integer", "nullable": true }, "taxType": { "description": "Amount of the transaction in cents\ne.g: 870", "type": "string", "nullable": true }, "totalAmount": { "description": "Amount of the transaction in cents\ne.g: 870", "type": "integer", "nullable": true }, "created": { "example": "2021-06-24 22:35:07", "nullable": true, "type": "string", "format": "date-time" }, "modified": { "example": "2021-06-24 22:35:07", "nullable": true, "type": "string", "format": "date-time" }, "contactId": {}, "contactName": {} } }, "Activity": { "type": "object", "description": "", "properties": { "id": { "readOnly": true, "type": "string" }, "integration": { "example": "quickbooks", "nullable": false, "description": "The key of the integration source\ne.g. \"quickbooks\", or \"xero\"", "type": "string" }, "srcId": { "type": "string" }, "date": { "type": "string", "format": "date-time", "nullable": true }, "emailsSent": { "type": "integer", "nullable": true }, "totalItems": { "type": "integer", "nullable": true } } }, "AgedPayablesExcel": { "type": "object", "description": "provides an excel workbook of an aged payables report", "properties": { "asOf": { "example": "This endpoint returns an .xlsx file." } } }, "AgedPayablesReport": { "type": "object", "description": "Provides an Aged Payables Report", "properties": { "asOf": { "type": "string", "format": "date", "example": "2021-06-30" }, "summary": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "current": { "type": "number", "format": "float" }, "1to30": { "type": "number", "format": "float" }, "31to60": { "type": "number", "format": "float" }, "61to90": { "type": "number", "format": "float" }, "91andOver": { "type": "number", "format": "float" }, "total": { "type": "number", "format": "float" } } }, "example": [ { "id": "32", "name": "Cal Telephone", "current": 0, "1to30": 56.5, "31to60": 0, "61to90": 0, "91andOver": 0, "total": 56.5 }, { "id": "48", "name": "PG&E", "current": 86.44, "1to30": 0, "31to60": 0, "61to90": 0, "91andOver": 0, "total": 86.44 }, { "name": "TOTAL", "current": 86.44, "1to30": 56.5, "31to60": 0, "61to90": 0, "91andOver": 0, "total": 142.94 } ] }, "lastReconciled": { "type": "string", "format": "date", "example": "2021-01-31", "nullable": true }, "isReconciled": { "type": "boolean", "example": false }, "sources": { "type": "array", "items": { "type": "string" }, "example": [ "xero" ] } } }, "AgedReceivablesExcel": { "type": "object", "description": "provides an excel workbook of an aged receivables report", "properties": { "file": { "example": "This endpoint returns an .xlsx file." } } }, "AgedReceivablesReport": { "type": "object", "description": "Provides an Aged Receivables Report", "properties": { "asOf": { "type": "string", "format": "date", "example": "2021-06-30" }, "summary": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "current": { "type": "number", "format": "float" }, "1to30": { "type": "number", "format": "float" }, "31to60": { "type": "number", "format": "float" }, "61to90": { "type": "number", "format": "float" }, "91andOver": { "type": "number", "format": "float" }, "total": { "type": "number", "format": "float" } } }, "example": [ { "id": "1", "name": "Amy's Bird Sanctuary", "current": 0, "1to30": 0, "31to60": 239, "61to90": 0, "91andOver": 0, "total": 239 }, { "id": "2", "name": "Bill's Windsurf Shop", "current": 0, "1to30": 0, "31to60": 85, "61to90": 0, "91andOver": 0, "total": 85 }, { "id": "8", "name": "Freeman Sporting Goods|0969 Ocean View Road", "current": 0, "1to30": 477.5, "31to60": 0, "61to90": 0, "91andOver": 0, "total": 477.5 }, { "id": "9", "name": "Freeman Sporting Goods|55 Twin Lane", "current": 0, "1to30": 4, "31to60": 81, "61to90": 0, "91andOver": 0, "total": 85 }, { "id": "10", "name": "Geeta Kalapatapu", "current": 0, "1to30": 629.1, "31to60": 0, "61to90": 0, "91andOver": 0, "total": 629.1 }, { "id": "12", "name": "Jeff's Jalopies", "current": 0, "1to30": 0, "31to60": 81, "61to90": 0, "91andOver": 0, "total": 81 }, { "id": "13", "name": "John Melton", "current": 0, "1to30": 0, "31to60": 450, "61to90": 0, "91andOver": 0, "total": 450 }, { "id": "16", "name": "Kookies by Kathy", "current": 0, "1to30": 0, "31to60": 0, "61to90": 75, "91andOver": 0, "total": 75 }, { "id": "17", "name": "Mark Cho", "current": 0, "1to30": 314.28, "31to60": 0, "61to90": 0, "91andOver": 0, "total": 314.28 }, { "id": "18", "name": "Paulsen Medical Supplies", "current": 0, "1to30": 954.75, "31to60": 0, "61to90": 0, "91andOver": 0, "total": 954.75 }, { "id": "20", "name": "Red Rock Diner", "current": 0, "1to30": 70, "31to60": 0, "61to90": 156, "91andOver": 0, "total": 226 }, { "id": "21", "name": "Rondonuwu Fruit and Vegi", "current": 0, "1to30": 78.6, "31to60": 0, "61to90": 0, "91andOver": 0, "total": 78.6 }, { "id": "23", "name": "Shara Barnett|Barnett Design", "current": 0, "1to30": 274.5, "31to60": 0, "61to90": 0, "91andOver": 0, "total": 274.5 }, { "id": "24", "name": "Sonnenschein Family Store", "current": 0, "1to30": 362.07, "31to60": 0, "61to90": 0, "91andOver": 0, "total": 362.07 }, { "id": "25", "name": "Sushi by Katsuyuki", "current": 0, "1to30": 160, "31to60": 0, "61to90": 0, "91andOver": 0, "total": 160 }, { "id": "26", "name": "Travis Waldron", "current": 0, "1to30": 414.72, "31to60": 0, "61to90": 0, "91andOver": 0, "total": 414.72 }, { "id": "29", "name": "Weiskopf Consulting", "current": 0, "1to30": 375, "31to60": 0, "61to90": 0, "91andOver": 0, "total": 375 }, { "name": "TOTAL", "current": 0, "1to30": 4114.52, "31to60": 936, "61to90": 231, "91andOver": 0, "total": 5281.52 } ] }, "lastReconciled": { "type": "string", "format": "date", "example": "2021-01-31", "nullable": true }, "isReconciled": { "type": "boolean", "example": false }, "sources": { "type": "array", "items": { "type": "string" }, "example": [ "xero" ] } } }, "ApplicationCharge": { "type": "object", "description": "A one time charge within an application", "properties": { "id": { "readOnly": true, "type": "string" }, "integration": { "example": "quickbooks", "nullable": false, "description": "The key of the integration source\ne.g. \"quickbooks\", or \"xero\"", "type": "string" }, "srcId": { "description": "Unique identifier for each charge", "type": "string" }, "name": { "description": "Name of the application charge", "type": "string" }, "apiClientId": { "description": "The API key for the app", "type": "string" }, "price": { "description": "The price of the application charge", "type": "integer" }, "status": { "description": "The status of the application charge\ne.g. \"pending\"\ne.g. \"accepted\"\ne.g. \"active\"", "type": "string", "nullable": true }, "returnUrl": { "description": "The URL the merchant is redirected after accepting a charge", "type": "string", "nullable": true }, "created": { "description": "The date and time the application charge was created", "type": "string" }, "modified": { "description": "The date and time the application charge was modified", "type": "string", "nullable": true }, "chargeType": { "description": "The type of charge induced", "type": "string", "nullable": true }, "decoratedReturnUrl": { "description": "The display URL where the merchant is redirected after accepting a charge", "type": "string", "nullable": true } } }, "ApplicationCredit": { "type": "object", "description": "Application credit represents credits issued to merchants that can be used towards future app purchases", "properties": { "id": { "readOnly": true, "type": "string" }, "integration": { "example": "quickbooks", "nullable": false, "readOnly": true, "description": "The key of the integration source\ne.g. \"quickbooks\", or \"xero\"", "type": "string" }, "srcId": { "description": "Unique identifier for each application credit", "type": "string" }, "amount": { "description": "Amount refunded by the application credit", "type": "integer" }, "description": { "description": "A description of the application credit", "type": "string", "nullable": true } } }, "Asset": { "type": "object", "description": "", "properties": { "id": { "readOnly": true, "type": "string" }, "integration": { "example": "quickbooks", "nullable": false, "description": "The key of the integration source\ne.g. \"quickbooks\", or \"xero\"", "type": "string" }, "srcId": { "description": "The unique identifier of the source 3rd party integration", "type": "string" }, "name": { "description": "Asset name", "type": "string" }, "organizationId": { "description": "Id of the organization the asset belongs to", "type": "string", "nullable": true }, "description": { "description": "Additional details about the asset", "type": "string", "nullable": true }, "price": { "description": "Price of the asset", "type": "string", "nullable": true }, "productId": { "description": "Product ID", "type": "string", "nullable": true }, "purchaseDate": { "description": "Date of asset purchase", "type": "string", "format": "date-time", "nullable": true }, "quantity": { "description": "Unit number of the product", "type": "integer", "nullable": true } } }, "BalanceHistory": { "type": "object", "description": "Balance history represents charges that have contributed to the account balance e.g. charges & transfers", "properties": { "id": { "readOnly": true, "type": "string" }, "integration": { "example": "quickbooks", "nullable": false, "description": "The key of the integration source\ne.g. \"quickbooks\", or \"xero\"", "type": "string" }, "srcId": { "description": "Unique identifier for balance history", "type": "string" }, "amount": { "description": "The amount of the transaction", "type": "integer" }, "availableOn": { "description": "The date and time the transaction's net funds will be available in the account balance", "type": "string", "nullable": true }, "created": { "description": "The date and time the transaction was created", "type": "string" }, "currency": { "description": "The currency the transaction was made in", "type": "string" }, "balanceDescription": { "description": "A description of the transaction", "type": "string", "nullable": true }, "exchangeRate": { "description": "The exchange rate represented as a decimal", "type": "integer", "nullable": true }, "fee": { "description": "The amount of fees paid for the transaction", "type": "integer", "nullable": true }, "feeType": { "description": "The type of fee incurred\ne.g. \"application fee\"", "type": "string", "nullable": true }, "net": { "description": "The net amount of the transaction after deducting all fees, tax and discounts", "type": "integer" }, "balanceStatus": { "description": "Whether the transaction is available in the account balance yet\ne.g. \"available\", \"pending\"", "type": "string", "nullable": true }, "balanceType": { "description": "The type of transaction\ne.g. \"Charge\"\ne.g. \"Refund\"", "type": "string", "nullable": true } } }, "BalanceSheet": { "type": "object", "description": "", "properties": { "id": { "readOnly": true, "type": "string" }, "integration": { "example": "quickbooks", "nullable": false, "description": "The key of the integration source\ne.g. \"quickbooks\", or \"xero\"", "type": "string" }, "reportTitle": { "example": "Balance Sheet", "nullable": true, "description": "e.g: BalanceSheet", "type": "string" }, "companyName": { "example": "Flux Capacitors Inc", "nullable": true, "description": "e.g: the company legal name", "type": "string" }, "columns": { "description": "columns in balance sheet statement", "type": "array", "items": { "type": "string" }, "nullable": true }, "rows": { "description": "rows in balance sheet statement", "type": "array", "items": { "type": "string" }, "nullable": true }, "accountingMethod": { "example": "cash", "nullable": false, "description": "accounting method: a set of rules under which revenues and expenses are reported in financial statements\ne.g: cash", "type": "string" }, "start": { "example": "2021-01-01", "nullable": true, "description": "start datetime of the balancesheet coverage", "type": "string", "format": "date-time" }, "end": { "example": "2021-01-31", "nullable": true, "description": "end datetime of the balancesheet coverage", "type": "string", "format": "date-time" }, "currencyCode": { "example": "USD", "nullable": true, "type": "string" }, "totalAssets": { "example": "2786282", "nullable": true, "description": "Total assets in cents", "type": "integer" }, "totalLiabilities": { "example": "287622", "nullable": true, "description": "Total liabilities in cents", "type": "integer" }, "totalCurrentAssets": { "example": "89792", "nullable": true, "description": "Total current assets in cents", "type": "integer" }, "totalCurrentLiabilities": { "example": "198339", "nullable": true, "description": "Total current liabilities in cents", "type": "integer" }, "totalEquity": { "example": "625282", "nullable": true, "description": "Total equity in cents", "type": "integer" }, "netIncome": { "type": "integer", "nullable": true } } }, "BalanceSheetExcel": { "type": "object", "description": "provides an excel workbook of a series of mapped balance sheets", "properties": { "file": { "example": "This endpoint returns an .xlsx file." } } }, "BalanceSheetReport": { "type": "object", "description": "provides a mapped balance sheet", "properties": { "totals": { "type": "object", "properties": { "assets": { "type": "number", "format": "float" }, "liabilities": { "type": "number", "format": "float" }, "assets_current": { "type": "number", "format": "float" }, "liabilities_current": { "type": "number", "format": "float" }, "equity": { "type": "number", "format": "float" }, "net_income": { "type": "number", "format": "float" } }, "example": { "assets": 342650.6, "liabilities": 65386.34, "assets_current": 342650.6, "liabilities_current": 40386.34, "equity": 277264.26, "net_income": 277264.26 } }, "details": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "value": { "type": "string" }, "mapping": { "type": "number", "format": "float" } } }, "example": [ { "id": "56", "name": "Cash on hand", "value": 279325.6, "mapping": "Assets - Cash" }, { "id": "59", "name": "Accounts Receivable (A/R)", "value": 59325, "mapping": "Assets - AR" }, { "id": "54", "name": "Inventory Asset", "value": 4000, "mapping": "Assets - Inventory" }, { "id": "62", "name": "Accounts Payable (A/P)", "value": 0, "mapping": "Liabilities - AP" }, { "id": "57", "name": "GST/HST Payable", "value": 40386.34, "mapping": "Liabilities - Taxes" }, { "id": "61", "name": "Bank loans", "value": 25000 }, { "id": "55", "name": "Opening Balance Equity", "value": -5000, "mapping": "Equity - Investment" }, { "id": "50", "name": "Retained Earnings", "value": 142324.26, "mapping": "Equity - Investment" } ], "nullable": true }, "asOf": { "type": "string", "format": "date", "example": "2021-06-30" }, "lastReconciled": { "type": "string", "format": "date", "example": "2021-01-31", "nullable": true }, "isReconciled": { "type": "boolean", "example": false }, "hasCompleteData": { "type": "boolean", "example": true }, "sources": { "type": "array", "items": { "type": "string" }, "example": [ "xero" ] } } }, "BankAccount": { "type": "object", "description": "", "properties": { "id": { "readOnly": true, "type": "string" }, "integration": { "example": "quickbooks", "nullable": false, "description": "The key of the integration source\ne.g. \"quickbooks\", or \"xero\"", "type": "string" }, "srcId": { "description": "the unique identifier of the source 3rd party integration", "type": "string" }, "created": { "description": "The datetime when the item was created", "type": "string", "format": "date-time", "nullable": true }, "modified": { "description": "The datetime when the item was last modified", "type": "string", "format": "date-time", "nullable": true }, "name": { "description": "The name of the bank account", "type": "string", "nullable": true }, "number": { "type": "string", "nullable": true }, "type": { "description": "Unique identifier for the type of account", "type": "string", "nullable": true }, "balance": { "description": "Bank account balance", "type": "integer", "nullable": true }, "bankName": { "type": "string", "nullable": true }, "bankConnectionId": { "type": "string", "nullable": true }, "subtype": { "type": "string", "nullable": true }, "deleted": { "type": "boolean" }, "currencyCode": { "type": "string", "nullable": true }, "isAsset": { "type": "boolean", "nullable": true } } }, "BankOpeningBalance": { "type": "object", "description": "", "properties": { "id": { "readOnly": true, "type": "string" }, "integration": { "example": "quickbooks", "nullable": false, "description": "The key of the integration source\ne.g. \"quickbooks\", or \"xero\"", "type": "string" }, "srcId": { "description": "the unique identifier of the source 3rd party integration", "type": "string" }, "created": { "description": "The datetime when the item was created", "type": "string", "format": "date-time", "nullable": true }, "modified": { "description": "The datetime when the item was last updated", "type": "string", "format": "date-time", "nullable": true }, "bankAccountId": { "description": "Unique identifier for the bank account", "type": "string", "nullable": true }, "openingDate": { "description": "The date of the opening balance", "type": "string", "nullable": true }, "debit": { "description": "The debit amount of the opening balance", "type": "integer", "nullable": true }, "credit": { "description": "The credit amount of the credit balance", "type": "integer", "nullable": true } } }, "BankReconciliation": { "type": "object", "description": "", "properties": { "id": { "readOnly": true, "type": "string" }, "integration": { "example": "quickbooks", "nullable": false, "description": "The key of the integration source\ne.g. \"quickbooks\", or \"xero\"", "type": "string" }, "srcId": { "description": "The unique identifier of the source 3rd party integration", "type": "string" }, "created": { "description": "The datetime when the item was created", "type": "string", "format": "date-time", "nullable": true }, "modified": { "description": "The datetime when the item wsa last modified", "type": "string", "format": "date-time", "nullable": true }, "bankAccountId": { "description": "Unique identifier for the bank account", "type": "string", "nullable": true }, "reconciliationDate": { "description": "Date of bank reconciliation", "type": "string", "nullable": true }, "reconciliationEndBalance": { "description": "The statement end balance for the reconciliation", "type": "integer", "nullable": true }, "totalReceived": { "description": "The total amount received", "type": "integer", "nullable": true }, "totalPaid": { "description": "Total amount paid", "type": "integer", "nullable": true }, "startingBalance": { "description": "The starting balance of the bank reconciliation", "type": "integer", "nullable": true }, "closingBalance": { "description": "The closing balance of the bank reconciliation", "type": "integer", "nullable": true }, "reconciledBalance": { "description": "The reconciled balance of the bank reconciliation", "type": "integer", "nullable": true }, "balanceDifference": { "description": "The difference between the statement end balance and reconciled balance", "type": "integer", "nullable": true }, "status": { "description": "Bank reconciliation status", "type": "string", "nullable": true } } }, "BankSummary": { "type": "object", "description": "", "properties": { "id": { "readOnly": true, "type": "string" }, "integration": { "example": "quickbooks", "nullable": false, "description": "The key of the integration source\ne.g. \"quickbooks\", or \"xero\"", "type": "string" }, "report_id": { "readOnly": true, "description": "Report ID\ne.g: BankSummary", "type": "string", "nullable": true }, "name": { "description": "Report Name\ne.g: Bank Summary", "type": "string", "nullable": true }, "columns": { "description": "columns in bank summary statement", "type": "array", "items": { "type": "string" }, "nullable": true }, "rows": { "description": "rows in bank summary statement", "type": "array", "items": { "type": "string" }, "nullable": true }, "start": { "description": "start datetime of the bank summary coverage", "type": "string", "format": "date-time", "nullable": true }, "end": { "description": "end datetime of the bank summary coverage", "type": "string", "format": "date-time", "nullable": true }, "reportId": { "type": "string", "nullable": true } } }, "BankTransaction": { "type": "object", "description": "Bank transaction represents spend and receive money transactions, overpayments and prepayments", "properties": { "id": { "readOnly": true, "type": "string" }, "integration": { "example": "quickbooks", "nullable": false, "description": "The key of the integration source\ne.g. \"quickbooks\", or \"xero\"", "type": "string" }, "srcId": { "description": "Unique identifier for each bank transaction", "type": "string" }, "contactId": { "description": "ID of the associated contact", "type": "string", "nullable": true }, "contactName": { "description": "Full name of contact", "type": "string", "nullable": true }, "date": { "description": "Transaction date", "type": "string", "nullable": true }, "status": { "description": "Status of bank transaction\ne.g. \"RECEIVE\"\ne.g. \"RECEIVE-OVERPAYMENT\"", "type": "string", "nullable": true }, "lineAmountTypes": { "description": "The type of line amount\ne.g. \"Exclusive\"\ne.g. \"Inclusive\"\ne.g. \"NoTax\"", "type": "string", "nullable": true }, "lineItemDescription": { "description": "A description of the line item", "type": "string", "nullable": true }, "lineItemUnitAmount": { "description": "Unit amount of line item", "type": "integer", "nullable": true }, "lineItemTaxType": { "description": "Type of tax applied to the line item\ne.g. \"INPUT\"\ne.g. \"OUTPUT\ne.g. \"GSTONIMPORTS\"", "type": "string", "nullable": true }, "lineItemTaxAmount": { "description": "The amount taxed for the line item", "type": "integer", "nullable": true }, "lineAmount": { "description": "The total of the line including discount", "type": "integer", "nullable": true }, "lineItemAccountCode": { "description": "Account code of line item", "type": "string", "nullable": true }, "lineItemQuantity": { "description": "Quantity of line item", "type": "integer", "nullable": true }, "lineItemId": { "description": "ID for the line item", "type": "string", "nullable": true }, "subtotal": { "description": "Total of bank transaction excluding taxes", "type": "integer", "nullable": true }, "totalTax": { "description": "Total tax of bank transaction", "type": "integer", "nullable": true }, "total": { "description": "Total of bank transaction", "type": "integer", "nullable": true }, "modified": { "description": "Date and time the bank transaction was last updated", "type": "string", "nullable": true }, "currencyCode": { "description": "The currency the bank transaction has been raised in", "type": "string", "nullable": true }, "accountId": { "description": "ID of the bank account", "type": "string", "nullable": true }, "bankAccountCode": { "description": "Bank account code", "type": "string", "nullable": true }, "bankAccountName": { "description": "Name of the bank account", "type": "string", "nullable": true }, "type": { "description": "Transaction Type", "type": "string", "nullable": true }, "reference": { "description": "Reference for the transaction", "type": "string", "nullable": true }, "isReconciled": { "description": "Whether the transaction is reconciled", "type": "boolean", "nullable": true }, "fromAccountId": { "description": "Account ID from which money will be transferred", "type": "string", "nullable": true }, "toAccountId": { "description": "Account ID to which money will be transferred", "type": "string", "nullable": true }, "paymentMode": { "description": "Mode of payment for the transaction", "type": "string", "nullable": true }, "customerId": { "description": "ID of customer", "type": "string", "nullable": true }, "vendorId": { "description": "ID of vendor", "type": "string", "nullable": true }, "created": { "type": "string", "format": "date-time", "nullable": true }, "txnId": { "description": "Transaction ID", "type": "string", "nullable": true }, "category": { "type": "string", "nullable": true }, "merchant": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true } } }, "BankTransfer": { "type": "object", "description": "The transfer of money from one bank account to another", "properties": { "id": { "readOnly": true, "type": "string" }, "integration": { "example": "quickbooks", "nullable": false, "description": "The key of the integration source\ne.g. \"quickbooks\", or \"xero\"", "type": "string" }, "srcId": { "description": "Unique identifier of each bank transfer", "type": "string" }, "created": { "description": "Date the bank transfer was created", "type": "string", "nullable": true }, "transferDate": { "description": "Date of the transfer", "type": "string", "nullable": true }, "fromBankAccountId": { "description": "The ID of the source bank account", "type": "string" }, "fromBankAccountName": { "description": "The name of the source bank account", "type": "string" }, "toBankAccountId": { "description": "The ID of the destination bank account", "type": "string" }, "toBankAccountName": { "description": "The name of the destination bank account", "type": "string" }, "amount": { "description": "The amount being transferred", "type": "integer" }, "fromBankTransactionId": { "description": "The bank transaction ID for the source account", "type": "string", "nullable": true }, "toBankTransactionId": { "description": "The bank transaction ID for the destination account", "type": "string", "nullable": true }, "modified": { "description": "Date the bank transfer was last modified", "type": "string", "nullable": true }, "type": { "description": "Transaction type", "type": "string", "nullable": true } } }, "BatchPayment": { "type": "object", "description": "Batch payment represents a single payment transaction that includes multiple bills or invoices", "properties": { "id": { "readOnly": true, "type": "string" }, "integration": { "example": "quickbooks", "nullable": false, "description": "The key of the integration source\ne.g. \"quickbooks\", or \"xero\"", "type": "string" }, "srcId": { "description": "Unique identifier for each batch payment", "type": "string" }, "accountId": { "description": "ID of the account used to make the payment", "type": "string" }, "date": { "description": "Date the payment is being made", "type": "string" }, "paymentId": { "description": "The ID of the payment", "type": "string", "nullable": true }, "paymentAmount": { "description": "The amount being paid for", "type": "integer", "nullable": true }, "type": { "description": "The type of batch payment\ne.g. \"PAYBATCH\"\ne.g. \"RECBATCH\"", "type": "string", "nullable": true }, "status": { "description": "Status of the batch payment\ne.g. \"authorised\"\ne.g. \"deleted\"", "type": "string" }, "totalAmount": { "description": "Total of the payments that make up the batch", "type": "integer" }, "modified": { "description": "The date and time the batch payment was last modified", "type": "string", "nullable": true }, "isReconciled": { "description": "Whether the batch payment has been reconciled", "type": "boolean", "nullable": true } } }, "Bill": { "type": "object", "description": "", "properties": { "id": { "example": "quickbooks-345", "nullable": false, "readOnly": true, "description": "Unique identifier for this bill\nnote that no particular pattern in this field is guaranteed, only that this field is unique\ne.g. \"quickbooks-345\"", "type": "string" }, "integration": { "example": "quickbooks", "nullable": false, "description": "The key of the integration source\ne.g. \"quickbooks\", or \"xero\"", "type": "string" }, "vendorId": { "example": "15", "nullable": false, "description": "Vendor Id\ne.g. \"15\"", "type": "string" }, "vendorName": { "example": "Acme Corp", "nullable": true, "description": "Vendor full name\ne.g. \"Acme Corp\"", "type": "string" }, "currency": { "example": "USD", "nullable": true, "description": "Currency code\ne.g. \"USD\"", "type": "string" }, "balance": { "example": 70000, "nullable": false, "description": "Total balance of the bill in cents\ne.g. 70000", "type": "integer" }, "txnDate": { "example": "2021-05-12", "nullable": true, "description": "Transaction date\ne.g. \"2021-05-12\"", "type": "string", "format": "date-time" }, "totalAmount": { "example": 550000, "nullable": false, "description": "Total amount of the bill in cents\ne.g. 550000", "type": "integer" }, "apAccountId": { "example": "15", "nullable": true, "description": "Account Id\ne.g. \"15\"", "type": "string" }, "apAccountName": { "example": "Accounts Payable", "nullable": true, "description": "Account full name\ne.g. \"Accounts Payable\"", "type": "string" }, "modified": { "example": "2013-12-18T02:17:40.080Z", "nullable": false, "description": "Date entry was last modified\ne.g. \"2013-11-18T02:17:40.080Z\"", "type": "string", "format": "date-time" }, "created": { "example": "2013-11-18T02:17:40.080Z", "nullable": true, "description": "Date entry was created\ne.g. \"2013-11-18T02:17:40.080Z\"", "type": "string", "format": "date-time" }, "srcId": { "example": "GH2JK-67283H-YW82KHX-2883KK-KS78S", "nullable": false, "description": "The unique identifier of the source 3rd party integration\ne.g. \"GH2JK-67283H-YW82KHX-2883KK-KS78S\"", "type": "string" }, "status": { "example": "Paid", "nullable": true, "description": "Bill status\ne.g. \"Paid\"", "type": "string" }, "identifier": { "example": "4560", "nullable": true, "description": "The bill number\ne.g. \"4560\"", "type": "string" }, "referenceNumber": { "example": "1234", "nullable": true, "description": "Reference number\ne.g. \"1234\"", "type": "string" }, "dueDate": { "example": "2021-05-30", "nullable": true, "description": "Date bill is due\ne.g. \"2021-05-30\"", "type": "string", "format": "date-time" }, "subtotal": { "example": 65000, "nullable": true, "description": "Bill subtotal in cents\ne.g. 65000", "type": "integer" }, "taxAmount": { "example": 12000, "nullable": true, "description": "Bill tax amount in cents\ne.g. 12000", "type": "integer" } } }, "BillPayment": { "type": "object", "description": "", "properties": { "id": { "example": "quickbooks-321", "nullable": false, "readOnly": true, "type": "string" }, "integration": { "example": "quickbooks", "nullable": false, "description": "The key of the integration source\ne.g. \"quickbooks\", or \"xero\"", "type": "string" }, "srcId": { "example": "460000000053219", "nullable": false, "description": "the unique identifier of the source 3rd party integration\ne.g. \"460000000053219\"", "type": "string" }, "billId": { "example": "34", "nullable": false, "description": "The source ID of the bill being paid", "type": "string" }, "vendorPaymentId": { "example": "quickbooks-34", "nullable": true, "description": "The Boss Insights identifier for the Vendor Payment that this Bill Payment belongs to (if it belongs to one)\nNote that no particular pattern in this field is guaranteed, only that this field is unique", "type": "string" }, "vendorId": { "example": "460000000026049", "nullable": true, "description": "Unique identifier for the vendor of the bill\ne.g. \"460000000026049\"", "type": "string" }, "vendorName": { "example": "Bowman and Co", "nullable": true, "description": "Name of the vendor of the bill\ne.g. \"Bowman and Co\"", "type": "string" }, "paymentMode": { "example": "Stripe", "nullable": true, "description": "Mode of payment\ne.g. \"Stripe\"", "type": "string" }, "txnDate": { "example": "2013-10-07", "nullable": true, "description": "Date the payment is made\ne.g. \"2013-10-07\"", "type": "string", "format": "date-time" }, "referenceNumber": { "example": "REF#912300", "nullable": true, "description": "Reference number for the payment recorded\ne.g. REF#912300", "type": "string" }, "amount": { "example": 12500, "nullable": false, "description": "Total amount of the payment in cents\ne.g. 12500", "type": "integer" }, "currency": { "example": "USD", "nullable": true, "description": "Currency code\ne.g. \"USD\"", "type": "string" }, "created": { "example": "2016-12-16T00:18:42-0500", "nullable": true, "description": "Creation time of the payment\ne.g. 2016-12-16T00:18:42-0500", "type": "string", "format": "date-time" }, "modified": { "example": "2016-12-16T00:18:42-0500", "nullable": true, "description": "Last modified time of the payment\ne.g. 2016-12-16T00:18:42-0500", "type": "string", "format": "date-time" } } }, "Blog": { "type": "object", "description": "A blog.", "properties": { "id": { "type": "string" }, "integration": { "example": "quickbooks", "nullable": false, "description": "The key of the integration source\ne.g. \"quickbooks\", or \"xero\"", "type": "string" }, "srcId": { "description": "Unique identifier for the blog", "type": "string" }, "url": { "description": "The web address to the blog", "type": "string", "nullable": true }, "categoryId": { "description": "The ID of the category the blog is under", "type": "string", "nullable": true }, "created": { "description": "The date and time the blog was created", "type": "string" }, "description": { "description": "A description of the blog", "type": "string", "nullable": true }, "name": { "description": "The name of the blog", "type": "string" }, "updated": { "description": "The date and time the blog was last modified", "type": "string", "nullable": true } } }, "BlogPosting": { "type": "object", "description": "A blog post.", "properties": { "id": { "type": "string" }, "integration": { "example": "quickbooks", "nullable": false, "description": "The key of the integration source\ne.g. \"quickbooks\", or \"xero\"", "type": "string" }, "srcId": { "description": "Unique identifier for a blog post", "type": "string" }, "created": { "description": "The date and time the blog post was created", "type": "string" }, "author": { "description": "The author of the blog post", "type": "string", "nullable": true }, "authorId": { "description": "The unique identifier for the author of the blog post", "type": "string", "nullable": true }, "authorEmail": { "description": "The email address associated with the author", "type": "string", "nullable": true }, "campaignName": { "description": "The name of the campaign the blog post is associated with", "type": "string", "nullable": true }, "commentCount": { "description": "The number of comments made on the blog post", "type": "integer", "nullable": true }, "title": { "description": "The title of the blog post", "type": "string", "nullable": true }, "url": { "description": "The web address to the blog post", "type": "string", "nullable": true }, "updated": { "description": "The date and time the blog post was last modified", "type": "string", "nullable": true } } }, "BudgetSummary": { "type": "object", "description": "", "properties": { "id": { "readOnly": true, "type": "string" }, "integration": { "example": "quickbooks", "nullable": false, "description": "The key of the integration source\ne.g. \"quickbooks\", or \"xero\"", "type": "string" }, "report_id": { "readOnly": true, "description": "Report ID\ne.g: BudgetSummary", "type": "string", "nullable": true }, "name": { "description": "Report name\ne.g: Budget Summary", "type": "string", "nullable": true }, "columns": { "description": "column in budget summary statement", "type": "array", "items": { "type": "string" }, "nullable": true }, "rows": { "description": "rows in budget summary statement", "type": "array", "items": { "type": "string" }, "nullable": true }, "end": { "description": "end datetime of the budget summary coverage", "type": "string", "format": "date-time", "nullable": true }, "reportId": { "type": "string", "nullable": true } } }, "Call": { "type": "object", "description": "", "properties": { "id": { "readOnly": true, "type": "string" }, "integration": { "example": "quickbooks", "nullable": false, "description": "The key of the integration source\ne.g. \"quickbooks\", or \"xero\"", "type": "string" }, "srcId": { "description": "the unique identifier of the source 3rd party integration", "type": "string" }, "callOwner": { "description": "the user the call is to or from", "type": "string", "nullable": true }, "callContact": { "description": "the customer or lead the call is to or from", "type": "string", "nullable": true }, "callDuration": { "description": "duration of the call", "type": "integer", "nullable": true }, "callPurpose": { "description": "purpose of the call", "type": "string", "nullable": true }, "callStartTime": { "description": "when the call starts", "type": "string", "format": "date-time", "nullable": true }, "callResult": { "description": "result of the call", "type": "string", "nullable": true }, "description": { "description": "details about the call", "type": "string", "nullable": true }, "created": { "description": "when the call information is created", "type": "string", "format": "date-time", "nullable": true }, "modified": { "description": "when the call objects are modified", "type": "string", "format": "date-time", "nullable": true }, "callresult": { "type": "string", "nullable": true } } }, "Campaign": { "type": "object", "description": "", "properties": { "id": { "readOnly": true, "type": "string" }, "integration": { "example": "quickbooks", "nullable": false, "description": "The key of the integration source\ne.g. \"quickbooks\", or \"xero\"", "type": "string" }, "srcId": { "description": "the unique identifier of the source 3rd party integration", "type": "string" }, "campaignName": { "description": "name of the campaign", "type": "string", "nullable": true }, "campaignOwner": { "description": "name of the person the campaign responsibility is assigned to", "type": "string", "nullable": true }, "description": { "description": "details about the campaign", "type": "string", "nullable": true }, "startDate": { "description": "campaign start time date", "type": "string", "format": "date-time", "nullable": true }, "endDate": { "description": "campaign end time date", "type": "string", "format": "date-time", "nullable": true }, "budgetedCost": { "description": "planned amount to spent on the campaign", "type": "string", "nullable": true }, "actualCost": { "description": "actual amount spent on the campaign", "type": "string", "nullable": true }, "expectedRevenue": { "description": "expected revenue from the campaign", "type": "string", "nullable": true }, "status": { "description": "status of the campaign\ne.g:done", "type": "string", "nullable": true }, "created": { "description": "when the campaign is created", "type": "string", "format": "date-time", "nullable": true }, "modified": { "description": "when the campaign attributes is modified", "type": "string", "format": "date-time", "nullable": true }, "nExpectedResponse": { "type": "integer", "nullable": true } } }, "CampaignReport": { "type": "object", "description": "", "properties": { "id": { "readOnly": true, "type": "string" }, "integration": { "example": "quickbooks", "nullable": false, "description": "The key of the integration source\ne.g. \"quickbooks\", or \"xero\"", "type": "string" }, "srcId": { "type": "string" }, "campaignName": { "type": "string", "nullable": true }, "type": { "type": "string", "nullable": true }, "emailsSent": { "type": "integer", "nullable": true }, "unsubscribed": { "type": "integer", "nullable": true }, "sendTime": { "type": "string", "format": "date-time", "nullable": true }, "hardBounces": { "type": "integer", "nullable": true }, "softBounces": { "type": "integer", "nullable": true }, "totalOpens": { "type": "integer", "nullable": true }, "uniqueOpens": { "type": "integer", "nullable": true }, "openRate": { "type": "string", "nullable": true }, "totalClicks": { "type": "integer", "nullable": true }, "uniqueClicks": { "type": "integer", "nullable": true }, "fowards": { "type": "integer", "nullable": true } } }, "Charge": { "type": "object", "description": "Charge represents charges made to a debit or credit card", "properties": { "id": { "readOnly": true, "type": "string" }, "integration": { "example": "quickbooks", "nullable": false, "description": "The key of the integration source\ne.g. \"quickbooks\", or \"xero\"", "type": "string" }, "srcId": { "description": "Unique identifier for a charge", "type": "string" }, "amount": { "description": "The amount charged", "type": "integer" }, "amountRefunded": { "description": "The amount refunded", "type": "integer", "nullable": true }, "applicationId": { "description": "ID of the application that created the charge", "type": "string", "nullable": true }, "applicationFeeAmount": { "description": "The application fee for the charge", "type": "integer", "nullable": true }, "balanceTransactionId": { "description": "ID of the balance transaction that describes the impact of the charge on the account balance", "type": "string", "nullable": true }, "billingAddress": { "description": "The billing address for the payment", "type": "string", "nullable": true }, "billingEmail": { "description": "The email address associated with the charge", "type": "string", "nullable": true }, "billingName": { "description": "The full name of the customer the charge is for", "type": "string", "nullable": true }, "billingPhone": { "description": "The phone number of the customer the charge is for", "type": "string", "nullable": true }, "created": { "description": "The date and time the charge was created", "type": "string", "format": "date-time", "nullable": true }, "currency": { "description": "The currency the charge was made in", "type": "string" }, "customerId": { "description": "The ID associated with the customer in which the charge is for", "type": "string", "nullable": true }, "chargeDescription": { "description": "A description of the charge", "type": "string", "nullable": true }, "invoiceId": { "description": "The ID of the invoice this charge is for", "type": "string", "nullable": true }, "receiptNumber": { "description": "The transaction number that appears on email receipts sent for this charge", "type": "string", "nullable": true }, "refunded": { "description": "Whether the charge has been fully refunded", "type": "string", "nullable": true }, "status": { "description": "The status of the charge\ne.g. \"succeeded\"\ne.g. \"pending\"\ne.g. \"failed\"", "type": "string", "nullable": true }, "shippingAddress": { "description": "The shipping address associated with the charge", "type": "string", "nullable": true }, "shippingName": { "description": "Recipient name", "type": "string", "nullable": true }, "shippingPhone": { "description": "Recipient phone number", "type": "string", "nullable": true }, "shippingTrackingNumber": { "description": "The tracking number for a physical product, obtained from the delivery service", "type": "string", "nullable": true } } }, "Client": { "type": "object", "description": "", "properties": { "id": { "readOnly": true, "type": "string" }, "integration": { "example": "quickbooks", "nullable": false, "description": "The key of the integration source\ne.g. \"quickbooks\", or \"xero\"", "type": "string" }, "srcId": { "type": "string" }, "emailClient": { "type": "string", "nullable": true }, "numMembers": { "type": "integer", "nullable": true }, "totalItems": { "type": "integer", "nullable": true } } }, "Company": { "type": "object", "description": "Company represents any type of organization", "properties": { "id": { "readOnly": true, "type": "string" }, "integration": { "example": "quickbooks", "nullable": false, "description": "The key of the integration source\ne.g. \"quickbooks\", or \"xero\"", "type": "string" }, "srcId": { "description": "Unique identifier for the company", "type": "string" }, "name": { "description": "Company name", "type": "string" }, "isActive": { "description": "A boolean indicating whether the company is active or not", "type": "boolean", "nullable": true }, "url": { "description": "The web address of the company", "type": "string", "nullable": true } } }, "ContactGroup": { "type": "object", "description": "Contact groups represent contacts that are segmented into groups based on specific characteristics", "properties": { "id": { "readOnly": true, "type": "string" }, "integration": { "example": "quickbooks", "nullable": false, "description": "The key of the integration source\ne.g. \"quickbooks\", or \"xero\"", "type": "string" }, "srcId": { "description": "Unique identifier for each contact group", "type": "string" }, "name": { "description": "The name of the contact group", "type": "string" }, "contactId": { "description": "The ID of a contact within the contact group", "type": "string", "nullable": true }, "contactName": { "description": "The name of a contact within the contact group", "type": "string", "nullable": true }, "isActive": { "description": "Whether the contact group is active or not", "type": "boolean", "nullable": true } } }, "Contract": { "type": "object", "description": "", "properties": { "id": { "readOnly": true, "type": "string" }, "integration": { "example": "quickbooks", "nullable": false, "description": "The key of the integration source\ne.g. \"quickbooks\", or \"xero\"", "type": "string" }, "srcId": { "description": "the unique identifier of the source 3rd party integration", "type": "string" }, "contractName": { "description": "contract name", "type": "string", "nullable": true }, "customer": { "description": "customer related to the contract", "type": "string", "nullable": true }, "contractDate": { "description": "when the contract is signed", "type": "string", "format": "date-time", "nullable": true }, "startDate": { "description": "when the contract will start", "type": "string", "format": "date-time", "nullable": true }, "endDate": { "description": "when the contract will end", "type": "string", "format": "date-time", "nullable": true }, "description": { "description": "additional details about the contract", "type": "string", "nullable": true }, "status": { "description": "status of the contract\ne.g: activated, draft", "type": "string", "nullable": true } } }, "Conversion": { "type": "object", "description": "", "properties": { "id": { "readOnly": true, "description": "identifier", "type": "integer" }, "type": { "description": "type of conversion e.g. 'financial-statement'", "type": "string" }, "url": { "description": "url or subtype of conversion, e.g. 'other-accounting'", "type": "string" }, "status": { "readOnly": true, "description": "conversion processing status", "type": "string" }, "file": { "description": "name of file", "type": "string" } } }, "CreditNote": { "type": "object", "description": "", "properties": { "id": { "example": "quickbooks-726", "nullable": false, "readOnly": true, "type": "string" }, "integration": { "example": "quickbooks", "nullable": false, "description": "The key of the integration source\ne.g. \"quickbooks\", or \"xero\"", "type": "string" }, "srcId": { "example": "90300000072369", "nullable": true, "description": "Unique identifier of the source 3rd party integration", "type": "string" }, "creditnoteNumber": { "example": "CN-29", "nullable": true, "description": "Unique number generated (starts with CN) which will be displayed in the interface and credit notes\neg. CN-29", "type": "string" }, "date": { "example": "2016-06-05", "nullable": true, "description": "The date on which credit note is raised. Format [yyyy-mm-dd]\neg. \"2016-06-05\"", "type": "string" }, "status": { "example": "open", "nullable": true, "description": "Status of the credit note. This can be open, closed or void\neg. \"open\"", "type": "string" }, "customerId": { "example": "903000000000099", "nullable": true, "description": "Customer ID of the customer for whom the credit note is raised\neg. 903000000000099", "type": "string" }, "customerName": { "example": "Bowman Furniture", "nullable": true, "description": "Name of the customer to whom the credit note is raised. Max-Length [100]\neg. \"Bowman Furniture\"", "type": "string" }, "referenceNumber": { "example": "INV-384", "nullable": true, "description": "Reference number generated for the payment. A string of your choice can also be used as the reference number. Max-Length [100]\neg. \"INV-384\"", "type": "string" }, "totalAmount": { "example": "400", "nullable": true, "description": "Total of credit note\neg. \"400\"", "type": "string" }, "balance": { "example": 10, "nullable": true, "description": "Unapplied credits\neg. 10", "type": "integer" }, "currency": { "example": "USD", "nullable": true, "description": "Customers currency code\neg. \"USD\"", "type": "string" }, "notes": { "example": "Offer for the referral", "nullable": true, "description": "Notes on the credit notes\neg. \"Offer for the referral\"", "type": "string" }, "created": { "example": "2013-11-18T02:17:40.080Z", "nullable": true, "description": "Time at which the recurring invoice was created\neg. \"2013-11-18T02:17:40.080Z\"", "type": "string", "format": "date-time" }, "modified": { "example": "2013-11-18T02:17:40.080Z", "nullable": true, "description": "Time at which the recurring invoice was last updated\neg. \"2013-11-18T02:17:40.080Z\"", "type": "string", "format": "date-time" } } }, "Customer": { "type": "object", "description": "", "properties": { "id": { "example": "stripe-5050", "nullable": false, "readOnly": true, "description": "Unique identifier for this customer\nnote that no particular pattern in this field is guaranteed, only that this field is unique\ne.g. \"stripe-5050\"", "type": "string" }, "integration": { "example": "quickbooks", "nullable": false, "description": "The key of the integration source\ne.g. \"quickbooks\", or \"xero\"", "type": "string" }, "srcId": { "example": "50", "nullable": false, "description": "The unique identifier of the source 3rd party integration\ne.g. \"50\"", "type": "string" }, "email": { "example": "janedoe@email.com", "nullable": true, "description": "Email address for the customer\ne.g. \"janedoe@email.com\"", "type": "string" }, "name": { "example": "Jane Doe", "nullable": true, "description": "Full name of the customer\ne.g. \"Jane Doe\"", "type": "string" }, "givenName": { "example": "Jane", "nullable": true, "description": "First name of the customer\ne.g. \"Jane\"", "type": "string" }, "familyName": { "example": "Doe", "nullable": true, "description": "Last name of the customer\ne.g. \"Doe\"", "type": "string" }, "companyName": { "example": "Acme Corp.", "nullable": true, "description": "Name of the company the customer is working on\ne.g. \"Acme Corp.\"", "type": "string" }, "fullyQualifiedName": { "example": "Acme Corporation", "nullable": true, "description": "Fully qualified name of the company the customer is working on\ne.g. \"Acme Corporation\"", "type": "string" }, "address": { "example": "708 Woodland Avenue", "nullable": true, "description": "First line of customer address\ne.g. \"708 Woodland Avenue\"", "type": "string" }, "addressLine2": { "example": "Unit 105", "nullable": true, "description": "Second line of customer address\ne.g. \"Unit 105\"", "type": "string" }, "city": { "example": "St Paul", "nullable": true, "description": "City of the address\ne.g. \"St Paul\"", "type": "string" }, "postalCode": { "example": "99660", "nullable": true, "description": "Postal code of the address\n\t * e.g. \"99660\"", "type": "string" }, "country": { "example": "United States", "nullable": true, "description": "Country of the address\n\t * e.g. \"United States\"", "type": "string" }, "billingAddress": { "example": "4348 Candlelight Drive", "nullable": true, "description": "Billing address line 1\n\te.g. \"4348 Candlelight Drive\"", "type": "string" }, "billingAddressLine2": { "example": "Apartment 78", "nullable": true, "description": "Billing address line 2\n\te.g. \"Apartment 78\"", "type": "string" }, "billingCity": { "example": "Panama City", "nullable": true, "description": "Billing address city\n\te.g. \"Panama City\"", "type": "string" }, "billingState": { "example": "Florida", "nullable": true, "description": "Billing address state or province\n\te.g. \"Florida\"", "type": "string" }, "billingPostalCode": { "example": "32417", "nullable": true, "description": "Billing address postal code\n\te.g. \"32417\"", "type": "string" }, "billingCountry": { "example": "United States", "nullable": true, "description": "Billing address country\n\te.g. \"United States\"", "type": "string" }, "phone": { "example": "281-381-4241", "nullable": true, "description": "Phone number\n\te.g. \"281-381-4241\"", "type": "string" }, "mobile": { "example": "786-258-0182", "nullable": true, "description": "Mobile number\n\te.g. \"786-258-0182\"", "type": "string" }, "fax": { "example": "281-381-4255", "nullable": true, "description": "Fax number\n\te.g. \"281-381-4255\"", "type": "string" }, "ddi": { "example": "5050", "nullable": true, "description": "Direct dial number\n\te.g. \"5050\"", "type": "string" }, "balance": { "example": 19999, "nullable": true, "description": "Balance owed by customer in cents\n\te.g. 19999", "type": "integer" }, "currency": { "example": "USD", "nullable": true, "description": "Currency used by customer\ne.g. \"USD\"", "type": "string" }, "taxable": { "example": true, "nullable": true, "description": "Taxable status", "type": "boolean" }, "customerAccountStatus": { "example": "Enabled", "nullable": true, "description": "Accounting status of the customer\ne.g. \"Enabled\"", "type": "string" }, "monthlyRecurringRevenue": { "example": 4500000, "nullable": true, "description": "Monthly recurring revenue in cents\ne.g. 4500000", "type": "integer" }, "netMonthlyRecurringRevenue": { "example": 2500000, "nullable": true, "description": "Net monthly recurring revenue\ne.g. 2500000", "type": "integer" }, "created": { "example": "2013-11-18T02:17:40.080Z", "nullable": true, "description": "Date of customer account creation\ne.g. \"2013-11-18T02:17:40.080Z\"", "type": "string", "format": "date-time" }, "modified": { "example": "2013-11-22T02:17:40.080Z", "nullable": true, "description": "Date entry was last modified\ne.g. \"2013-11-22T02:17:40.080Z\"", "type": "string", "format": "date-time" }, "title": { "example": "Manager", "nullable": true, "description": "Job title of the customer\ne.g. \"Manager\"", "type": "string" }, "department": { "example": "Administrative office", "nullable": true, "description": "Department where customer works in\ne.g. \"Administrative office\"", "type": "string" }, "customerOwner": { "example": "josh_jameson", "nullable": true, "description": "User in touch with the customer\ne.g. \"josh_jameson\"", "type": "string" }, "description": { "example": "Great customer", "nullable": true, "description": "A note about the customer\ne.g. \"Great customer\"", "type": "string" }, "totalSpent": { "example": 76000, "nullable": true, "description": "Total spent by customer in cents\ne.g. 76000", "type": "integer" }, "acceptsMarketing": { "example": true, "nullable": true, "description": "Whether the customer has consented to receiving promotional emails", "type": "boolean" }, "username": { "example": "jane_doe123", "nullable": true, "description": "Username of the customer\ne.g. \"jane_doe123\"", "type": "string" }, "taxType": { "example": "Global", "nullable": true, "description": "Tax type applied for the customer\ne.g. \"Global\"", "type": "string" }, "bankAccountName": { "example": "Business Bank Account", "nullable": true, "description": "Bank account name for the customer\ne.g. \"Business Bank Account\"", "type": "string" }, "bankAccountNumber": { "example": "123654", "nullable": true, "description": "Bank account number for the customer\ne.g. \"123654\"", "type": "string" }, "termId": { "example": "1d80716b-427e-4cad-80c6-c4b3a18eb23d", "nullable": true, "description": "Reference to a Term object (payment terms) associated with this Customer\ne.g. \"1d80716b-427e-4cad-80c6-c4b3a18eb23d\"", "type": "string" }, "termDays": { "example": "15", "nullable": true, "description": "The days value of the payment terms for this Customer\ne.g. \"15\"", "type": "integer" }, "termType": { "example": "DAYSAFTERBILLDATE", "nullable": true, "description": "The type of the payment terms for this Customer\ne.g. \"DAYSAFTERBILLDATE\"", "type": "string" } } }, "CustomerOpeningBalance": { "type": "object", "description": "", "properties": { "id": { "readOnly": true, "type": "string" }, "integration": { "example": "quickbooks", "nullable": false, "description": "The key of the integration source\ne.g. \"quickbooks\", or \"xero\"", "type": "string" }, "srcId": { "description": "The unique identifier of the source 3rd party integration", "type": "string" }, "created": { "description": "The datetime when the item was created", "type": "string", "format": "date-time", "nullable": true }, "modified": { "description": "The datetime when the item was last modified", "type": "string", "format": "date-time", "nullable": true }, "openingBalanceType": { "description": "Unique identifier for the opening balance type", "type": "string", "nullable": true }, "customerId": { "description": "Unique identifier for the customer", "type": "string", "nullable": true }, "openingDate": { "description": "The date of the opening balance", "type": "string", "nullable": true }, "description": { "description": "A description of the opening balance", "type": "string", "nullable": true }, "totalAmount": { "description": "The total amount of the opening balance", "type": "integer", "nullable": true }, "currency": { "description": "Currency of the account", "type": "string", "nullable": true } } }, "DataSync": { "type": "object", "description": "", "properties": { "message": { "type": "string", "example": "xero synced successfully" } } }, "Deal": { "type": "object", "description": "", "properties": { "id": { "example": "quickbooks-726", "nullable": false, "readOnly": true, "type": "string" }, "integration": { "example": "quickbooks", "nullable": false, "description": "The key of the integration source\ne.g. \"quickbooks\", or \"xero\"", "type": "string" }, "srcId": { "example": "706f68c5-46b2-43d8-9aa8-41d1cc2a317f", "nullable": false, "type": "string" }, "ownerId": { "description": "User Id of deal responible", "type": "string", "nullable": true }, "ownerName": { "example": "Dave Simpson", "nullable": true, "description": "User name of deal responsible", "type": "string" }, "stage": { "example": "decision", "nullable": true, "description": "Deal's stage\ne.g: decision", "type": "string" }, "dealName": { "description": "name of the deal", "type": "string", "nullable": true }, "description": { "description": "Details about the deal", "type": "string", "nullable": true }, "prospectId": { "description": "Id of the prospect customer the deal is related to", "type": "string", "nullable": true }, "prospectName": { "description": "name of the customer the deal is related to", "type": "string", "nullable": true }, "expectedRevenue": { "description": "expected revenue from the deal", "type": "integer", "nullable": true }, "currency": { "example": "USD", "nullable": true, "description": "currency code of the deal\ne.g: USD", "type": "string" }, "created": { "example": "2021-07-28 00:00:00", "nullable": true, "description": "date and time the deal is first created", "type": "string" }, "closed": { "example": "2021-07-28 00:00:00", "nullable": true, "description": "date and time the deal is closed", "type": "string", "format": "date-time" }, "associatedContactIds": { "description": "A list of contact IDs that are associated with the deal", "type": "array", "items": { "type": "string" }, "nullable": true }, "associatedCompanyIds": { "description": "A list of company IDs that are associated with the deal", "type": "array", "items": { "type": "string" }, "nullable": true }, "numAssociatedContacts": { "example": 5, "nullable": true, "description": "The number of associated contacts", "type": "integer" } } }, "Department": { "type": "object", "description": "A relationship between an organization and a department of that organization, also described as an organization (allowing different urls, logos, opening hours). For example: a store with a pharmacy, or a bakery with a cafe.", "properties": { "id": { "readOnly": true, "type": "string" }, "integration": { "example": "quickbooks", "nullable": false, "description": "The key of the integration source\ne.g. \"quickbooks\", or \"xero\"", "type": "string" }, "name": { "type": "string" }, "directory": { "description": "List the directory of the current department\ne.g. Parent:Department1:SubDepartment1:SubDepartment2", "type": "string", "nullable": true }, "subDepartment": { "description": "Boolean on if this department is a subdepartment", "type": "boolean", "nullable": true }, "active": { "description": "Boolean on if department is currently active", "type": "boolean" }, "created": { "description": "Date entry was created", "type": "string", "format": "date-time", "nullable": true }, "modified": { "description": "Date entry was last modified", "type": "string", "format": "date-time", "nullable": true } } }, "Employee": { "type": "object", "description": "Someone working for this organization.", "properties": { "id": { "example": "quickbooks-726", "nullable": false, "readOnly": true, "type": "string" }, "integration": { "example": "quickbooks", "nullable": false, "description": "The key of the integration source\ne.g. \"quickbooks\", or \"xero\"", "type": "string" }, "srcId": { "example": "706f68c5-46b2-43d8-9aa8-41d1cc2a317f", "nullable": false, "type": "string" }, "firstName": { "example": "Steve", "nullable": true, "description": "First name of employee", "type": "string" }, "lastName": { "example": "James", "nullable": true, "description": "Last name of employee", "type": "string" }, "fullName": { "example": "Steve James", "nullable": true, "type": "string" }, "active": { "example": true, "nullable": false, "type": "boolean" }, "primaryPhone": { "example": "4168769854", "nullable": true, "type": "string" }, "primaryAddr": { "example": "451 Lincoln street", "nullable": true, "type": "string" }, "primaryAddrCity": { "example": "Toronto", "nullable": true, "type": "string" }, "primaryAddrPostalcode": { "example": "L8H Y5F", "nullable": true, "type": "string" }, "primaryAddrState": { "example": "California", "nullable": true, "type": "string" }, "created": { "example": "2021-06-24 22:35:07", "nullable": true, "type": "string", "format": "date-time" }, "modified": { "example": "2021-06-24 22:35:07", "nullable": true, "type": "string", "format": "date-time" }, "link": { "example": "steve.james.com", "nullable": true, "description": "Link to an external resource of the employee", "type": "string" }, "email": { "example": "steve.james@gmail.com", "nullable": true, "type": "string" }, "mobilePhone": { "example": "4167854398", "nullable": true, "type": "string" }, "payRate": { "example": "20", "nullable": true, "type": "string" }, "title": { "example": "Mr", "nullable": true, "type": "string" }, "gender": { "example": "Female", "nullable": true, "type": "string" }, "birthDate": { "example": "2021-06-24", "nullable": true, "type": "string", "format": "date-time" }, "hiredDate": { "example": "2021-06-24", "nullable": true, "type": "string", "format": "date-time" }, "employeeNumber": { "example": "Female", "nullable": true, "type": "string" } } }, "Engagement": { "type": "object", "description": "Engagement represents CRM actions stored as notes, tasks, meetings and calls", "properties": { "id": { "readOnly": true, "type": "string" }, "integration": { "example": "quickbooks", "nullable": false, "description": "The key of the integration source\ne.g. \"quickbooks\", or \"xero\"", "type": "string" }, "srcId": { "description": "Unique identifier for each engagement", "type": "string" }, "isActive": { "description": "Whether an engagement is active or not", "type": "boolean", "nullable": true }, "created": { "description": "The date and time the engagement was created", "type": "string" }, "modified": { "description": "The date and time the engagement was last modified", "type": "string", "nullable": true }, "type": { "description": "The type of engagement\ne.g. \"MEETING\"\ne.g. \"CALL\"", "type": "string", "nullable": true }, "contactIds": { "description": "A list of IDs for associated contacts records", "type": "array", "items": { "type": "string" }, "nullable": true }, "companyId": { "description": "The ID of the associated company", "type": "string", "nullable": true }, "dealIds": { "description": "A list of IDs for associated deal records", "type": "array", "items": { "type": "string" }, "nullable": true } } }, "Estimate": { "type": "object", "description": "", "properties": { "id": { "readOnly": true, "type": "string" }, "integration": { "example": "quickbooks", "nullable": false, "description": "The key of the integration source\ne.g. \"quickbooks\", or \"xero\"", "type": "string" }, "estimateNumber": { "description": "For searching estimates", "type": "string", "nullable": true }, "txnStatus": { "description": "Transaction status\ne.g. Accepted", "type": "string", "nullable": true }, "billingEmail": { "description": "Billing email", "type": "string", "nullable": true }, "txnDate": { "description": "Transaction date", "type": "string", "format": "date-time", "nullable": true }, "totalAmount": { "description": "Estimate total amount", "type": "integer" }, "customerName": { "description": "Customer full name", "type": "string" }, "customerId": { "description": "Customer Id", "type": "string" }, "customerMemo": { "description": "Customer memo", "type": "string", "nullable": true }, "shippingLine1": { "description": "Shipping address line 1", "type": "string", "nullable": true }, "shippingLine2": { "description": "Shipping address line 2", "type": "string", "nullable": true }, "shippingCity": { "description": "Shipping address city", "type": "string", "nullable": true }, "shippingCountry": { "description": "Shipping address country", "type": "string", "nullable": true }, "shippingPostalcode": { "description": "Shipping address postal code", "type": "string", "nullable": true }, "billingLine1": { "description": "Billing address line 1", "type": "string", "nullable": true }, "billingLine2": { "description": "Billing address line 2", "type": "string", "nullable": true }, "billingCity": { "description": "Billing address city", "type": "string", "nullable": true }, "billingCountry": { "description": "Billing address country", "type": "string", "nullable": true }, "billingPostalcode": { "description": "Billing address postal code", "type": "string", "nullable": true }, "totalTax": { "description": "Total tax applied", "type": "integer", "nullable": true }, "created": { "description": "Date entry was created", "type": "string", "format": "date-time", "nullable": true }, "modified": { "description": "Date entry was modified", "type": "string", "format": "date-time", "nullable": true }, "referenceNumber": { "description": "Estimate reference number", "type": "string", "nullable": true }, "currency": { "description": "Currency code", "type": "string", "nullable": true }, "discountAmount": { "description": "Discount amount", "type": "integer", "nullable": true }, "billingState": { "description": "Billing address state/province", "type": "string", "nullable": true }, "shippingState": { "description": "State assocaited with the shipping address", "type": "string", "nullable": true } } }, "Event": { "type": "object", "description": "", "properties": { "id": { "readOnly": true, "type": "string" }, "integration": { "example": "quickbooks", "nullable": false, "description": "The key of the integration source\ne.g. \"quickbooks\", or \"xero\"", "type": "string" }, "srcId": { "description": "the unique identifier of the source 3rd party integration", "type": "string" }, "title": { "description": "title of the event", "type": "string", "nullable": true }, "host": { "description": "host of the event", "type": "string", "nullable": true }, "eventContact": { "description": "related customers or leads to the event", "type": "string", "nullable": true }, "eventStartTime": { "description": "planned start time of the event", "type": "string", "format": "date-time", "nullable": true }, "eventEndTime": { "description": "planned end time of the event", "type": "string", "format": "date-time", "nullable": true }, "location": { "description": "location of the event", "type": "string", "nullable": true }, "description": { "description": "details about the event", "type": "string", "nullable": true }, "created": { "description": "when the event objects are created", "type": "string", "format": "date-time", "nullable": true }, "modified": { "description": "when the event objects are modified", "type": "string", "format": "date-time", "nullable": true }, "status": { "description": "The status of the event\ne.g. \"SCHEDULED\"\ne.g. \"DONE\"", "type": "string", "nullable": true }, "type": { "description": "The type of event\ne.g. \"CONTENT\"\ne.g. \"SOCIAL\"", "type": "string", "nullable": true }, "url": { "description": "Public url for the event", "type": "string", "nullable": true } } }, "ExecutiveSummary": { "type": "object", "description": "", "properties": { "id": { "readOnly": true, "type": "string" }, "integration": { "example": "quickbooks", "nullable": false, "description": "The key of the integration source\ne.g. \"quickbooks\", or \"xero\"", "type": "string" }, "report_id": { "readOnly": true, "description": "Report ID\ne.g: ExecutiveSummary", "type": "string", "nullable": true }, "name": { "description": "Report Name\ne.g: Executive Summary", "type": "string", "nullable": true }, "columns": { "description": "columns in executive summary statement", "type": "array", "items": { "type": "string" }, "nullable": true }, "rows": { "description": "rows in executive summary statement", "type": "array", "items": { "type": "string" }, "nullable": true }, "end": { "description": "end datetime of the executive summary coverage", "type": "string", "format": "date-time", "nullable": true }, "reportId": { "type": "string", "nullable": true } } }, "Expense": { "type": "object", "description": "", "properties": { "id": { "example": "xero-70", "nullable": false, "readOnly": true, "description": "Unique identifier for this customer\nnote that no particular pattern in this field is guaranteed, only that this field is unique\ne.g. \"xero-70\"", "type": "string" }, "integration": { "example": "quickbooks", "nullable": false, "description": "The key of the integration source\ne.g. \"quickbooks\", or \"xero\"", "type": "string" }, "srcId": { "example": "982000000030049", "nullable": false, "description": "The unique identifier of the source 3rd party integration\ne.g. \"982000000030049\"", "type": "string" }, "txnId": { "example": "9856", "nullable": false, "description": "Transaction ID\ne.g. \"9856\"", "type": "string" }, "type": { "example": "expense", "nullable": false, "description": "Type of expense:\ne.g. \"expense\"", "type": "string" }, "accountId": { "example": "1057", "nullable": false, "description": "ID of account associated with expense\ne.g. \"1057\"", "type": "string" }, "currency": { "example": "EUR", "nullable": true, "description": "Currency code\ne.g. \"EUR\"", "type": "string" }, "subtotal": { "example": 9000, "nullable": true, "description": "Subtotal of expense in cents\ne.g. 9000", "type": "integer" }, "totalAmount": { "example": 12000, "nullable": true, "description": "Total of expense in cents\ne.g. 12000", "type": "integer" }, "referenceNumber": { "example": "782364", "nullable": true, "description": "Reference number of the expense, max length of 100\ne.g. \"782364\"", "type": "string" }, "status": { "example": "Unbilled", "nullable": true, "description": "Status of expense\ne.g. \"Unbilled\"", "type": "string" }, "invoiceId": { "example": "460000000028192", "nullable": true, "description": "ID of the invoice\ne.g. \"460000000028192\"", "type": "string" }, "invoiceNumber": { "example": "INV-00003", "nullable": true, "description": "Invoice number\ne.g. \"INV-00003\"", "type": "string" }, "modified": { "example": "2019-05-25T02:17:40.080Z", "nullable": true, "description": "Time at which the expense details were last updated\ne.g. \"2019-05-25T02:17:40.080Z\"", "type": "string", "format": "date-time" }, "accountName": { "example": "Rent", "nullable": true, "description": "Expense account name\ne.g. \"Rent\"", "type": "string" }, "created": { "example": "2019-05-22T02:17:40.080Z", "nullable": true, "description": "Time at which the expense details were created\ne.g. \"2019-05-22T02:17:40.080Z\"", "type": "string", "format": "date-time" }, "accountCode": { "example": "4560", "nullable": true, "description": "Chart of accounts identifier for the account\ne.g. \"4560\"", "type": "string" }, "contactId": { "example": "23", "nullable": true, "description": "Id of the contact which is usually a payee\ne.g. \"23\"", "type": "string" }, "contactName": { "example": "Cool Cars", "nullable": true, "description": "Name of the contact which is usually a payee\ne.g. \"Cool Cars\"", "type": "string" }, "contactType": { "example": "Vendor", "nullable": true, "description": "Type of the contact which can be customer, vendor, or employee", "type": "string" }, "paymentMethodId": { "example": "1d80716b-427e-4cad-80c6-c4b3a18eb23d", "nullable": true, "description": "Reference to the related Payment Method object", "type": "string" }, "date": { "example": "2019-05-22T02:17:40.080Z", "nullable": true, "description": "Date of the expense\ne.g. \"2019-05-22T02:17:40.080Z\"", "type": "string", "format": "date-time" }, "taxAmount": { "example": 3000, "nullable": true, "description": "Total tax amount in cents\ne.g. 3000", "type": "integer" }, "description": { "example": "GPS rent", "nullable": true, "description": "A note, memo, or description for the expense\ne.g. \"GPS rent\"", "type": "string" }, "deleted": { "example": true, "nullable": false, "description": "Indicates if the expense has been deleted", "type": "boolean" } } }, "FinancialMapping": { "type": "object", "description": "Accounting financial mapping", "properties": { "id": {}, "account_id": { "readOnly": true }, "account_type": { "readOnly": true }, "period_id": { "readOnly": true }, "created": {}, "modified": {}, "verified": {}, "accountId": {}, "accountType": {}, "periodId": {} } }, "FinancialPeriod": { "type": "object", "description": "Accounting financial period", "properties": { "id": {}, "name": {}, "start": {}, "integration": {}, "year_end": { "readOnly": true }, "deleted": {}, "created": {}, "modified": {}, "yearEnd": {} } }, "Form": { "type": "object", "description": "Forms are standard website forms that can be used to generate website leads.", "properties": { "id": { "readOnly": true, "type": "string" }, "integration": { "example": "quickbooks", "nullable": false, "description": "The key of the integration source\ne.g. \"quickbooks\", or \"xero\"", "type": "string" }, "srcId": { "description": "Unique identifier for the form", "type": "string" }, "name": { "description": "The name of the form", "type": "string" }, "notifiedRecipients": { "description": "A comma-separated list of user IDs that should receive submission notifications.", "type": "array", "items": { "type": "string" }, "nullable": true }, "created": { "description": "When the form was created.", "type": "string" }, "updated": { "description": "When the form was last modified", "type": "string", "nullable": true } } }, "FormData": { "type": "object", "description": "", "properties": { "formInput1": { "type": "string", "example": "value" }, "formInput2": { "type": "string", "example": "value" }, "formInput3": { "type": "string", "example": "value" }, "formInput4": { "type": "string", "example": "value" } } }, "GrowthHistory": { "type": "object", "description": "", "properties": { "id": { "readOnly": true, "type": "string" }, "integration": { "example": "quickbooks", "nullable": false, "description": "The key of the integration source\ne.g. \"quickbooks\", or \"xero\"", "type": "string" }, "srcId": { "type": "string" }, "date": { "type": "string", "nullable": true }, "existing": { "type": "string", "nullable": true }, "imports": { "type": "integer", "nullable": true }, "totalItems": { "type": "integer", "nullable": true } } }, "IntegrationsList": { "type": "object", "description": "provides a mapped balance sheet", "properties": { "file": { "example": "This endpoint returns an connected integrations" } } }, "Inventory": { "type": "object", "description": "", "properties": { "id": { "readOnly": true, "type": "string" }, "product_name": { "readOnly": true, "type": "string" }, "total_quantity": { "readOnly": true, "type": "integer" }, "sku": { "type": "string", "nullable": true }, "modified": { "type": "string", "format": "date-time", "nullable": true }, "fulfillable_quantity": { "readOnly": true, "type": "string", "nullable": true }, "integration": { "example": "quickbooks", "nullable": false, "description": "The key of the integration source\ne.g. \"quickbooks\", or \"xero\"", "type": "string" }, "productName": { "type": "string" }, "totalQuantity": { "type": "integer" }, "fulfillableQuantity": {} } }, "Invoice": { "type": "object", "description": "A statement of the money due for goods or services; a bill.", "properties": { "id": { "example": "quickbooks-34", "nullable": false, "readOnly": true, "description": "unique identifier for this invoice\nnote that no particular pattern in this field is guaranteed, only that this field is unique\ne.g. \"quickbooks-34\"", "type": "string" }, "integration": { "example": "quickbooks", "nullable": false, "description": "The key of the integration source\ne.g. \"quickbooks\", or \"xero\"", "type": "string" }, "additionalType": { "example": "", "nullable": true, "description": "An additional type for the item. This is a relationship between something and a class that the thing is in.", "type": "string" }, "category": { "example": "Spare Parts Division", "nullable": true, "description": "A category for the item. Greater signs or slashes can be used to informally indicate a category hierarchy.", "type": "string" }, "confirmationNumber": { "example": "2798-2929", "nullable": true, "description": "a number that confirms the given order or payment has been received", "type": "string" }, "customerId": { "example": "672", "nullable": true, "description": "party placing the order or paying the invoice", "type": "string" }, "paymentMethod": { "example": "PayPal", "nullable": true, "description": "the name of the credit card or other method of payment for the order", "type": "string" }, "paymentMethodId": { "example": "3009", "nullable": true, "description": "An identifier for the method of payment used (e.g. the last 4 digits of the credit card).", "type": "string" }, "paymentDueDate": { "example": "2020-10-22T19:30:17.697Z", "nullable": true, "description": "The date the payment is due", "externalDocs": { "url": "http://schema.org/DateTime" }, "type": "string", "format": "date-time" }, "provider": { "example": "Amazon", "nullable": true, "description": "The service provider, service operator, or service performer; the goods producer. Another party (a seller) may offer those services or goods on behalf of the provider. A provider may also serve as the seller.", "type": "string" }, "potentialAction": { "example": "", "nullable": true, "description": "indicates a potential Action, which describes an idealized action in which this thing would play an 'object' role", "type": "string" }, "broker": { "example": "", "nullable": true, "description": "An entity that arranges for an exchange between a buyer and a seller. In most cases a broker never acquires or releases ownership of a product or service involved in an exchange. If it is not clear whether an entity is a broker, seller, or buyer, the latter two terms are preferred.", "type": "string" }, "minimumPaymentDue": { "example": 2000, "nullable": true, "description": "the minimum payment required at this time", "type": "integer" }, "accountId": { "example": "127362", "nullable": true, "description": "the identifier for the account the payment will be applied to", "type": "string" }, "scheduledPaymentDate": { "example": "2021-10-22T19:30:17.697Z", "nullable": true, "description": "the date the invoice is scheduled to be paid", "externalDocs": { "url": "http://schema.org/Date" }, "type": "string", "format": "date-time" }, "billingPeriod": { "example": "P0Y2M0DT12H30M5S", "nullable": true, "description": "the time interval used to compute the invoice in ISO 8601 duration format", "type": "string" }, "status": { "example": "PastDue", "nullable": true, "description": "the status of payment; whether the invoice has been paid or not", "type": "string" }, "paymentStatus": { "type": "string", "nullable": true }, "created": { "example": "2020-09-07T19:58:50.550Z", "nullable": true, "description": "The date and time the invoice was first created", "type": "string", "format": "date-time" }, "modified": { "example": "2020-10-09T14:52:50.550Z", "nullable": true, "description": "The date and time the invoice was last updated", "type": "string", "format": "date-time" }, "subtotal": { "example": 8750, "nullable": true, "description": "Total payment amount, before tax", "type": "integer" }, "taxAmount": { "example": 1225, "nullable": true, "description": "Tax amount", "type": "integer" }, "currencyCode": { "example": "USD", "nullable": true, "description": "Currency code", "type": "string" }, "invoiceNumber": { "example": "BP-27719", "nullable": true, "description": "Invoice number", "type": "string" }, "amountPaid": { "example": 0, "nullable": true, "description": "Amount paid so far", "type": "integer" }, "amountCredited": { "example": 9975, "nullable": true, "description": "The amount remaining that is due", "type": "integer" }, "customerName": { "example": "Bobs Bait Shop", "nullable": true, "description": "The customer's name", "type": "string" }, "customerMemo": { "example": "It's a pleasure doing business with you. Remember, referrals are appreciated!", "nullable": true, "type": "string" }, "billingEmail": { "example": "ben@arima.com", "nullable": true, "description": "The customer's email", "type": "string" }, "billingAddressType": { "example": "HOME", "nullable": true, "type": "string" }, "billingAddressLine1": { "example": "4567 Finch St.", "nullable": true, "description": "* @ApiProperty(\n swaggerContext={\"example\"=\"4567 Finch St.\", \"required\"=false},\n openapiContext={\"example\"=\"4567 Finch St.\", \"nullable\"=true})", "type": "string" }, "billingAddressLine2": { "example": "Apartment 203", "nullable": true, "type": "string" }, "billingCity": { "example": "Beverly Hills", "nullable": true, "type": "string" }, "billingPostalCode": { "example": "90210", "nullable": true, "type": "string" }, "shippingAddressType": { "example": "BUSINESS", "nullable": true, "type": "string" }, "shippingAddressLine1": { "example": "350 S Grand Ave", "nullable": true, "type": "string" }, "shippingAddressLine2": { "example": "Suite 102", "nullable": true, "type": "string" }, "shippingCity": { "example": "Los Angeles", "nullable": true, "type": "string" }, "shippingPostalCode": { "example": "90071", "nullable": true, "type": "string" }, "srcId": { "example": "129", "nullable": false, "description": "the unique identifier of the source 3rd party integration", "type": "string" }, "url": { "example": "https://bobsburger.com", "nullable": true, "description": "Invoice url", "type": "string" }, "txnDate": { "example": "2020-09-07T19:58:50.550Z", "nullable": true, "description": "Transaction date", "type": "string", "format": "date-time" }, "jsonAddress": { "example": "{}", "nullable": true, "description": "Billing address in json format", "type": "string" }, "subscriptionId": { "example": "342", "nullable": true, "description": "The ID of the subscription the invoice was prepared for", "type": "string" }, "referenceNumber": { "example": "B1-7855", "nullable": true, "description": "Reference number of sale order", "type": "string" }, "balance": { "example": "9975", "nullable": true, "description": "Ending customer balance after the invoice is finalized", "type": "integer" }, "accountName": { "example": "Bills Bait Shop", "nullable": true, "description": "The name of the business associated with the invoice", "type": "string" }, "purchaseOrderNum": { "example": "342", "nullable": true, "description": "Purchase order number", "type": "integer" }, "billingCountry": { "example": "United States", "nullable": true, "description": "Billing address country", "type": "string" }, "totalAmount": { "example": 9975, "nullable": true, "description": "Total amount of the invoice", "type": "integer" }, "billingState": { "example": "CA", "nullable": true, "description": "State the billing address is addressed to", "type": "string" }, "shippingCountry": { "example": "United States", "nullable": true, "description": "Country the shipping address is addressed to", "type": "string" }, "shippingState": { "example": "CA", "nullable": true, "description": "State the shipping address is addressed to", "type": "string" }, "amountDue": { "example": 6275, "nullable": true, "description": "The unpaid amount that is due on the invoice", "type": "integer" } } }, "InvoiceItem": { "type": "object", "description": "A line item from an invoice.", "properties": { "id": { "example": "quickbooks-34-1", "nullable": false, "readOnly": true, "description": "Unique identifier for this line e.g. \"quickbooks-34-1\"\nNote that no particular pattern in this field is guaranteed, only that this field is unique", "type": "string" }, "integration": { "example": "quickbooks", "nullable": false, "description": "The key of the integration source\ne.g. \"quickbooks\", or \"xero\"", "type": "string" }, "srcId": { "example": "1", "nullable": false, "description": "Unique identifier for the invoice line, from the source 3rd party integration", "type": "string" }, "invoiceId": { "example": "quickbooks-34", "nullable": false, "description": "The Boss Insights identifier for the invoice that this line belongs to\nNote that no particular pattern in this field is guaranteed, only that this field is unique", "type": "string" }, "description": { "example": "Bag of soil", "nullable": true, "description": "Description of the line item", "type": "string" }, "quantity": { "example": 2.25, "nullable": true, "description": "Number of items for the line", "type": "number" }, "unitPrice": { "example": 18900, "nullable": true, "description": "Unit price of the item in cents", "type": "integer" }, "itemId": { "example": "1002", "nullable": true, "description": "Unique identifier for the item, from the source 3rd party integration", "type": "string" }, "itemName": { "example": "Bag of soil", "nullable": true, "description": "Name of the item", "type": "string" }, "lineAmount": { "example": 42525, "nullable": true, "description": "Amount for the line item in cents", "type": "integer" } } }, "Item": { "type": "object", "description": "", "properties": { "id": { "readOnly": true, "type": "string" }, "integration": { "example": "quickbooks", "nullable": false, "description": "The key of the integration source\ne.g. \"quickbooks\", or \"xero\"", "type": "string" }, "name": { "description": "Name of the item", "type": "string", "nullable": true }, "directory": { "description": "Item directory", "type": "string", "nullable": true }, "type": { "description": "Specifies use of the item\ne.g. Inventory", "type": "string", "nullable": true }, "quantity": { "description": "Number of items in inventory", "type": "string", "nullable": true }, "sku": { "description": "Stock keeping unit", "type": "string", "nullable": true }, "salesTaxIncluded": { "description": "Boolean on if price includes sales tax", "type": "boolean", "nullable": true }, "purchaseTaxIncluded": { "description": "Boolean on if price includes purchase tax", "type": "boolean", "nullable": true }, "description": { "description": "Description of item", "type": "string", "nullable": true }, "active": { "description": "Boolean on if item is in use", "type": "boolean", "nullable": true }, "created": { "description": "Date entry was created", "type": "string", "format": "date-time", "nullable": true }, "modified": { "description": "Date entry was last modified", "type": "string", "format": "date-time", "nullable": true }, "AvailableForSale": { "description": "If the item is available for sale", "type": "string", "nullable": true }, "AvailableForPurchase": { "description": "If the item is available for purchase", "type": "string", "nullable": true }, "UnitpriceSale": { "description": "Price per unit sale", "type": "integer", "nullable": true }, "UnitpricePurchase": { "description": "Price per unit purchase", "type": "integer", "nullable": true }, "TaxtypeSale": { "description": "Tax type per sale", "type": "string", "nullable": true }, "TaxtypePurchase": { "description": "Tax type per purchase", "type": "string", "nullable": true }, "availableForSale": { "type": "string", "nullable": true }, "availableForPurchase": { "type": "string", "nullable": true }, "unitpriceSale": { "type": "integer", "nullable": true }, "unitpricePurchase": { "type": "integer", "nullable": true }, "taxtypeSale": { "type": "string", "nullable": true }, "taxtypePurchase": { "type": "string", "nullable": true } } }, "Journal": { "type": "object", "description": "Journal represents recorded transactions and adjustments to the 3rd party account", "properties": { "id": { "readOnly": true, "type": "string" }, "integration": { "example": "quickbooks", "nullable": false, "description": "The key of the integration source\ne.g. \"quickbooks\", or \"xero\"", "type": "string" }, "srcId": { "description": "Unique identifier for each journal", "type": "string" }, "journalDate": { "description": "Date on which the journal to be recorded", "type": "string", "format": "date-time" }, "journalNumber": { "description": "The reference number of the journal", "type": "string", "nullable": true }, "journalLines": { "description": "JSON lines of the journal", "type": "string", "nullable": true }, "currencyCode": { "description": "Currency code of journal line", "type": "string", "nullable": true }, "created": { "description": "Created date and time of the journal", "type": "string", "format": "date-time", "nullable": true }, "modified": { "description": "Last modified time of the journal", "type": "string", "format": "date-time", "nullable": true } } }, "JournalLine": { "type": "object", "description": "Journal Lines represent a single line of a larger Journal entity", "properties": { "id": { "readOnly": true, "type": "string" }, "integration": { "example": "quickbooks", "nullable": false, "description": "The key of the integration source\ne.g. \"quickbooks\", or \"xero\"", "type": "string" }, "srcId": { "description": "Unique identifier for each journal", "type": "string" }, "journalDate": { "description": "Date on which the journal to be recorded", "type": "string", "format": "date-time" }, "journalNumber": { "description": "The entry number of the journal", "type": "string", "nullable": true }, "accountId": { "description": "ID of the account the journal is logging", "type": "string", "nullable": true }, "accountCode": { "description": "Customer defined alpha numeric account code\ne.g. \"200\"\ne.g. \"SALES", "type": "string", "nullable": true }, "accountType": { "description": "Type of account\ne.g. \"BANK\"\ne.g. \"CURRENT\"\ne.g. \"CURRLIAB\"", "type": "string", "nullable": true }, "accountName": { "description": "Name of account", "type": "string", "nullable": true }, "description": { "description": "A description of line item", "type": "string", "nullable": true }, "totalAmount": { "description": "Total amount of journal line", "type": "integer" }, "debitOrCredit": { "description": "Whether the jounral line amount is a debit or a credit", "type": "string", "nullable": true }, "currencyCode": { "description": "Currency code of journal line", "type": "string", "nullable": true }, "created": { "description": "Created date and time of the journal", "type": "string", "format": "date-time", "nullable": true }, "modified": { "description": "Last modified time of the journal", "type": "string", "format": "date-time", "nullable": true }, "journalId": { "description": "Boss Insights id of the journal this line is a part of", "type": "string" } } }, "Lead": { "type": "object", "description": "", "properties": { "id": { "example": "quickbooks-726", "nullable": false, "readOnly": true, "type": "string" }, "integration": { "example": "quickbooks", "nullable": false, "description": "The key of the integration source\ne.g. \"quickbooks\", or \"xero\"", "type": "string" }, "srcId": { "example": "90300000072369", "nullable": false, "type": "string" }, "email": { "example": "ron.aurthor@gmail.com", "nullable": true, "description": "lead email address", "type": "string" }, "firstName": { "example": "Ronald", "nullable": true, "description": "lead first name", "type": "string" }, "lastName": { "example": "Aurthor", "nullable": true, "description": "lead last anme", "type": "string" }, "primaryPhone": { "example": "416-555-0126", "nullable": true, "description": "lead phone number", "type": "string" }, "addressLine1": { "example": "39 Parliment road", "nullable": true, "description": "line1 address of the lead", "type": "string" }, "city": { "example": "Detroit", "nullable": true, "description": "city address of the lead", "type": "string" }, "country": { "example": "United States", "nullable": true, "description": "country address of the lead", "type": "string" }, "company": { "example": "Ronalds Hot Rods", "nullable": true, "description": "company where lead is working on", "type": "string" }, "postalCode": { "example": "48653", "nullable": true, "description": "postal code of the lead", "type": "string" }, "website": { "example": "https://www.ronshotrods.com", "nullable": true, "description": "website of the lead", "type": "string" }, "industry": { "example": "Automotive", "nullable": true, "description": "the industry lead belongs to", "type": "string" }, "skypeUsername": { "example": "ronaldAurthor0127", "nullable": true, "description": "skype username of the lead", "type": "string" }, "twitter": { "example": "@ronaldAutomotive", "nullable": true, "description": "twitter account of the lead", "type": "string" }, "annualRevenue": { "example": "50000000", "nullable": true, "description": "annual revenue of the company lead is working", "type": "string" }, "employeeCount": { "example": 113, "nullable": true, "description": "number of employees in the company lead works in", "type": "integer" }, "created": { "example": "2021-07-28 00:00:00", "nullable": true, "description": "date and time lead's information is first created", "type": "string", "format": "date-time" }, "modified": { "example": "2021-09-15 00:00:00", "nullable": true, "description": "date and time lead's information is last updated", "type": "string", "format": "date-time" } } }, "LedgerAccountOpeningBalance": { "type": "object", "description": "", "properties": { "id": { "readOnly": true, "type": "string" }, "integration": { "example": "quickbooks", "nullable": false, "description": "The key of the integration source\ne.g. \"quickbooks\", or \"xero\"", "type": "string" }, "srcId": { "description": "the unique identifier of the source 3rd party integration", "type": "string" }, "created": { "type": "string", "format": "date-time", "nullable": true }, "modified": { "description": "The datetime when the item was last updated", "type": "string", "format": "date-time", "nullable": true }, "ledgerAccountId": { "description": "The datetime when the item was last updated", "type": "string", "nullable": true }, "description": { "description": "A description of the opening balance", "type": "string", "nullable": true }, "debit": { "description": "The debit amount of the opening balance", "type": "integer", "nullable": true }, "credit": { "description": "The debit amount of the opening balance", "type": "integer", "nullable": true } } }, "LedgerAccountType": { "type": "object", "description": "", "properties": { "id": { "readOnly": true, "type": "string" }, "integration": { "example": "quickbooks", "nullable": false, "description": "The key of the integration source\ne.g. \"quickbooks\", or \"xero\"", "type": "string" }, "srcId": { "description": "Unique identifier for each ledger account type", "type": "string" }, "created": { "description": "Created date and time of the ledger account type", "type": "string", "format": "date-time", "nullable": true }, "modified": { "description": "Last modified date and time of the ledger account type", "type": "string", "format": "date-time", "nullable": true }, "name": { "description": "Name of ledger account type", "type": "string", "nullable": true } } }, "LedgerAccounts": { "type": "object", "description": "", "properties": { "id": { "readOnly": true, "type": "string" }, "integration": { "example": "quickbooks", "nullable": false, "description": "The key of the integration source\ne.g. \"quickbooks\", or \"xero\"", "type": "string" }, "srcId": { "description": "Unique identifier for each ledger account", "type": "string" }, "created": { "description": "Created date and time of the ledger account", "type": "string", "format": "date-time", "nullable": true }, "modified": { "description": "Last modified date and time of the ledger account", "type": "string", "format": "date-time", "nullable": true }, "ledgerAccountGroup": { "description": "Group of the ledger account", "type": "string", "nullable": true }, "name": { "description": "Name of the ledger account", "type": "string", "nullable": true }, "balance": { "description": "Balance of the ledger account", "type": "integer", "nullable": true }, "credit_or_debit": { "readOnly": true, "description": "Is ledger account debit or credit", "type": "string", "nullable": true }, "credits": { "description": "Credit amount of ledger account", "type": "integer", "nullable": true }, "debits": { "description": "Debit amount of the ledger account", "type": "integer", "nullable": true }, "start": { "description": "Balance calculated from this date", "type": "string", "format": "date-time" }, "end": { "description": "Balance calculated from this date", "type": "string", "format": "date-time" }, "creditOrDebit": { "type": "string", "nullable": true } } }, "LedgerEntry": { "type": "object", "description": "", "properties": { "id": { "readOnly": true, "type": "string" }, "integration": { "example": "quickbooks", "nullable": false, "description": "The key of the integration source\ne.g. \"quickbooks\", or \"xero\"", "type": "string" }, "srcId": { "description": "Unique identifier for each journal", "type": "string" }, "created": { "description": "Created date and time of the entry", "type": "string", "format": "date-time", "nullable": true }, "modified": { "description": "Last modified time of the entry", "type": "string", "format": "date-time", "nullable": true }, "date": { "description": "Date of the ledger entry", "type": "string", "nullable": true }, "credit": { "description": "Credit amount of the ledger entry", "type": "integer", "nullable": true }, "debit": { "description": "Debit amount of the ledger entry", "type": "integer", "nullable": true }, "journalCode": { "description": "Journal code of the entry", "type": "string", "nullable": true }, "description": { "description": "Description of the ledger entry", "type": "string", "nullable": true }, "ledgerAccount": { "description": "Ledger account id", "type": "string", "nullable": true } } }, "LinkedTransaction": { "type": "object", "description": "Linked transaction represent transactions that form part of a single scheme, arrangement or series of transactions between the same vendor and customer", "properties": { "id": { "readOnly": true, "type": "string" }, "integration": { "example": "quickbooks", "nullable": false, "description": "The key of the integration source\ne.g. \"quickbooks\", or \"xero\"", "type": "string" }, "srcId": { "description": "Unique identifier for each linked transaction", "type": "string" }, "sourceTransactionId": { "description": "The ID of the source transaction", "type": "string" }, "sourceLineItemId": { "description": "The ID of the line item from the source transaction", "type": "string" }, "contactId": { "description": "The ID of the contact on the target transaction", "type": "string", "nullable": true }, "targetTransactionId": { "description": "The ID of the target transaction", "type": "string", "nullable": true }, "targetLineItemId": { "description": "The ID of the line item from the target transaction", "type": "string", "nullable": true }, "status": { "description": "The status of the linked transaction", "type": "string", "nullable": true }, "type": { "description": "The type of linked transaction\ne.g. \"BILLABLEEXPENSE\"", "type": "string", "nullable": true }, "modified": { "description": "The last modified date in UTC format", "type": "string", "nullable": true }, "sourceTransactionTypeCode": { "description": "The type of the source transaction\ne.g. \"ACCPAY\"\ne.g. \"SPEND\"", "type": "string", "nullable": true } } }, "Location": { "type": "object", "description": "", "properties": { "id": { "example": "quickbooks-34", "nullable": false, "description": "unique identifier for this invoice\nnote that no particular pattern in this field is guaranteed, only that this field is unique\ne.g. \"square-LH49301JKSV2Y\"", "type": "string" }, "integration": { "example": "square", "nullable": false, "description": "The key of the integration source\ne.g. \"square\"\"", "type": "string" }, "srcId": { "description": "The unique identifier of the source 3rd party integration", "type": "string" }, "created": { "example": "2013-11-18T02:17:40.080Z", "nullable": true, "description": "Date entry was created\ne.g. \"2013-11-18T02:17:40.080Z\"", "type": "string", "format": "date-time" }, "businessName": { "example": "Bowman and Co", "nullable": true, "description": "Name of the business\ne.g. \"Bowman and Co\"", "type": "string" }, "currency": { "example": "USD", "nullable": true, "description": "Currency code\ne.g. \"USD\"", "type": "string" }, "type": { "description": "Type of the Sales term\ne.g. STANDARD", "type": "string", "nullable": true }, "country": { "example": "United States", "nullable": true, "description": "Country of the address\n\t * e.g. \"United States\"", "type": "string" }, "city": { "example": "St Paul", "nullable": true, "description": "City of the address\ne.g. \"St Paul\"", "type": "string" }, "state": { "example": "Alaska", "nullable": true, "description": "Vendor state address\ne.g. \"Alaska\"", "type": "string" }, "postalCode": { "example": "99660", "nullable": true, "description": "Postal code of the address\n\t * e.g. \"99660\"", "type": "string" }, "address": { "example": "708 Woodland Avenue", "nullable": true, "description": "First line of customer address\ne.g. \"708 Woodland Avenue\"", "type": "string" } } }, "ManualJournal": { "type": "object", "description": "Manual journal represents manually logged transactions", "properties": { "id": { "readOnly": true, "type": "string" }, "integration": { "example": "quickbooks", "nullable": false, "description": "The key of the integration source\ne.g. \"quickbooks\", or \"xero\"", "type": "string" }, "srcId": { "description": "Unique identifier for each manual journal", "type": "string" }, "date": { "description": "The date the journal was posted", "type": "string", "nullable": true }, "lineAmountTypes": { "description": "Type of line amount\ne.g. \"Inclusive\"\ne.g. \"Exclusive\",\ne.g. \"NoTax\"", "type": "string", "nullable": true }, "modified": { "description": "Last modified date", "type": "string", "nullable": true }, "narration": { "description": "Description of journal being posted", "type": "string" }, "journalLinesDescription": { "description": "Description for journal line", "type": "string", "nullable": true }, "journalLinesTaxType": { "description": "Tax type for journal line\ne.g. \"OUTPUT\"\ne.g. \"INPUT\"", "type": "string", "nullable": true }, "journalLinesTaxAmount": { "description": "Calculated tax amount for journal line", "type": "integer", "nullable": true }, "journalLinesLineAmount": { "description": "Total for journal line", "type": "integer", "nullable": true }, "journalLinesAccountCode": { "description": "Customer defined alpha numeric account code", "type": "string", "nullable": true }, "showOnCashBasisReports": { "description": "Whether to show cash basis report or not", "type": "boolean", "nullable": true }, "hasAttachments": { "description": "Whether the manual journal has an attachment", "type": "boolean", "nullable": true } } }, "Metrics": { "type": "object", "description": "provides a set of business metrics", "properties": { "end": { "type": "string", "format": "date", "example": "2021-04-31", "nullable": true }, "start": { "type": "string", "format": "date", "example": "2021-01-31", "nullable": true }, "metrics": { "type": "object", "items": { "type": "object" }, "example": { "gross_income": { "label": "Gross Income", "format": "\"$\"#,##0.00", "series": { "2022-01-31": 25973.45, "2022-02-28": 22573.45, "2022-03-31": 68001.9, "2022-04-30": 30973.45, "2022-05-31": 50973.45, "2022-06-30": 0 }, "comment": "", "description": "" }, "current_ratio": { "label": "Current Ratio", "format": "0.00", "series": { "2022-01-31": 6.444373122980516, "2022-02-28": 6.467820283927578, "2022-03-31": 3.022120085091376, "2022-04-30": 3.07833126725232, "2022-05-31": 3.2018274290984268, "2022-06-30": 1.6669570820900634 }, "comment": "", "description": "" } }, "nullable": true }, "sources": { "type": "array", "items": { "type": "string" }, "example": [ "quickbooks", "chargebee", "salesforce" ], "nullable": true }, "timestamp": { "type": "string", "format": "date-time", "example": "2022-03-16T00:39:31+00:00", "nullable": true }, "isReconciled": { "type": "boolean", "example": false }, "lastReconciled": { "type": "string", "format": "date", "example": "2021-01-31", "nullable": true } } }, "Order": { "type": "object", "description": "Order represents customer purchases made on defined products in the system", "properties": { "id": { "example": "quickbooks-726", "nullable": false, "readOnly": true, "description": "Unique identifier for this order\nnote that no particular pattern in this field is guaranteed, only that this field is unique\ne.g. \"quickbooks-726\"", "type": "string" }, "integration": { "example": "quickbooks", "nullable": false, "description": "The key of the integration source\ne.g. \"quickbooks\", or \"xero\"", "type": "string" }, "srcID": { "example": "GH2JK-67283H-YW82KHX-2883KK-KS78S", "nullable": false, "description": "The unique identifier of the source 3rd party integration\ne.g. \"GH2JK-67283H-YW82KHX-2883KK-KS78S\"", "type": "string" }, "name": { "example": "New order", "nullable": true, "description": "Order name\ne.g. \"New order\"", "type": "string" }, "orderDate": { "example": "2019-08-25T02:17:40.080Z", "nullable": true, "description": "Date and time the order is created\ne.g. \"2019-08-25T02:17:40.080Z\"", "type": "string", "format": "date-time" }, "orderStatus": { "example": "activated", "nullable": true, "description": "Status of the order\ne.g. \"activated\"", "type": "string" }, "description": { "example": "Monthly bundle", "nullable": true, "description": "Additional details about the order\ne.g. \"Monthly bundle\"", "type": "string" }, "amount": { "example": "1200", "nullable": true, "description": "Amount of the order\ne.g. \"1200\"", "type": "string" }, "quantity": { "example": 5, "nullable": true, "description": "The number of items included in the order\ne.g. 5", "type": "integer" }, "modified": { "example": "2019-08-25T02:17:40.080Z", "nullable": true, "description": "When the order was last modified\ne.g. \"2019-08-25T02:17:40.080Z\"", "type": "string", "format": "date-time" }, "customerId": { "example": "C005", "nullable": true, "description": "Id of the customer the order is by\ne.g. \"C005\"", "type": "string" }, "firstName": { "example": "Jane", "nullable": true, "description": "First name of the customer\ne.g. \"Jane\"", "type": "string" }, "lastName": { "example": "Doe", "nullable": true, "description": "Last name of the customer\ne.g. \"Doe\"", "type": "string" }, "currency": { "example": "USD", "nullable": true, "description": "The currency the order was made in\ne.g. \"USD\"", "type": "string" } } }, "OrderReturn": { "type": "object", "description": "Order return represents the full or partial return of a number of order items", "properties": { "id": { "readOnly": true, "type": "string" }, "integration": { "example": "quickbooks", "nullable": false, "description": "The key of the integration source\ne.g. \"quickbooks\", or \"xero\"", "type": "string" }, "srcId": { "description": "Unique identifier for each order return", "type": "string" }, "amount": { "description": "The total amount (price) for the returned order", "type": "integer", "nullable": true }, "created": { "description": "Date and time the order return was created", "type": "string", "format": "date-time", "nullable": true }, "currency": { "description": "The currency the refund will be paid in", "type": "string", "nullable": true }, "description": { "description": "A description of the order return", "type": "string", "nullable": true }, "quantity": { "description": "The number of items within the return order", "type": "integer", "nullable": true }, "orderId": { "description": "The ID of the original order", "type": "string", "nullable": true }, "refundId": { "description": "The ID of the refund issued for the order", "type": "string", "nullable": true } } }, "Organization": { "type": "object", "description": "", "properties": { "id": { "example": "quickbooks-726", "nullable": false, "readOnly": true, "type": "string" }, "integration": { "example": "quickbooks", "nullable": false, "description": "The key of the integration source\ne.g. \"quickbooks\", or \"xero\"", "type": "string" }, "name": { "example": "Bobs Sandwiches", "nullable": false, "description": "Company name", "type": "string" }, "legalName": { "example": "Bobs Sandwiches", "nullable": true, "description": "legal name", "type": "string" }, "primaryPhone": { "example": "4165769834", "nullable": true, "description": "Primary phone number of the company", "type": "string" }, "email": { "example": "bobs.sandwiches@gmail.com", "nullable": true, "description": "Primary email address associated to the company", "type": "string" }, "addressLine1": { "example": "23 berkly street", "nullable": true, "description": "Line1 address of the company", "type": "string" }, "addressLine2": { "example": "45 portland road", "nullable": true, "type": "string" }, "city": { "example": "Toronto", "nullable": true, "type": "string" }, "country": { "example": "Canada", "nullable": true, "description": "Country of the company location", "type": "string" }, "postalCode": { "example": "H7F5R3", "nullable": true, "description": "Postalcode of the company location", "type": "string" }, "startDate": { "example": "2021-06-25T20:39:32+00:00", "nullable": true, "type": "string" }, "created": { "example": "2021-06-25T20:39:32+00:00", "nullable": true, "type": "string" }, "modified": { "example": "2021-09-16T20:39:32+00:00", "nullable": true, "type": "string" }, "OrganisationType": { "example": "charity", "nullable": true, "description": "Type of the organization\ne.g: charity\ne.g: not_for_profit\ne.g: partnership", "type": "string" }, "employeeCount": { "example": 75, "nullable": true, "description": "Number of employees in the company", "type": "integer" }, "website": { "example": "bobssandwiches.com", "nullable": true, "description": "Website address of the comapny", "type": "string" }, "annualRevenue": { "example": "45000000000", "nullable": true, "type": "string" }, "description": { "example": "Best burgers in the world", "nullable": true, "description": "Further details about the company", "type": "string" }, "industry": { "example": "hospitality", "nullable": true, "description": "The industry company belongs to\ne.g: banking", "type": "string" }, "locationCount": { "example": 4, "nullable": true, "description": "Number of locations company has", "type": "integer" }, "industryCode": { "example": "441221", "nullable": true, "description": "NAICS/SIC industry code for the company", "type": "string" }, "organisationType": { "type": "string", "nullable": true } } }, "OtherIncome": { "type": "object", "description": "", "properties": { "id": { "readOnly": true, "type": "string" }, "integration": { "example": "quickbooks", "nullable": false, "description": "The key of the integration source\ne.g. \"quickbooks\", or \"xero\"", "type": "string" }, "srcId": { "type": "string" }, "totalAmount": { "type": "integer" }, "currencyCode": { "type": "string" }, "category": { "type": "string", "nullable": true }, "dateReceived": { "type": "string", "format": "date-time", "nullable": true }, "description": { "type": "string", "nullable": true }, "paymentType": { "type": "string", "nullable": true }, "source": { "type": "string" }, "created": { "type": "string", "format": "date-time" }, "modified": { "type": "string", "format": "date-time" } } }, "Owner": { "type": "object", "description": "Owner represents accounts in the system that are able to view and edit customer information.", "properties": { "id": { "readOnly": true, "type": "string" }, "integration": { "example": "quickbooks", "nullable": false, "description": "The key of the integration source\ne.g. \"quickbooks\", or \"xero\"", "type": "string" }, "srcId": { "description": "Unique identifier for the owner", "type": "string" }, "firstName": { "description": "The first name of the owner", "type": "string" }, "lastName": { "description": "The last name of the owner", "type": "string", "nullable": true }, "email": { "description": "The email address of the owner", "type": "string", "nullable": true }, "created": { "description": "The date and time the owner profile was created", "type": "string" }, "updated": { "description": "The date and time the owner profile was last modified", "type": "string", "nullable": true }, "isActive": { "description": "Whether the owner is active or not", "type": "boolean", "nullable": true } } }, "Payment": { "type": "object", "description": "", "properties": { "id": { "example": "706f68c5-46b2-43d8-9aa8-41d1cc2a317f", "nullable": false, "readOnly": true, "type": "string" }, "integration": { "example": "quickbooks", "nullable": false, "description": "The key of the integration source\ne.g. \"quickbooks\", or \"xero\"", "type": "string" }, "srcId": { "example": "706f68c5-46b2-43d8-9aa8-41d1cc2a317f", "nullable": false, "description": "The unique identifier of the source 3rd party integration", "type": "string" }, "paymentDate": { "example": "2020-10-22T19:30:17.697Z", "nullable": false, "description": "Date of the payment", "type": "string", "format": "date-time" }, "totalAmount": { "example": "8750", "nullable": true, "description": "Total amount listed in the payment in cents", "type": "string" }, "status": { "example": "PAID", "nullable": true, "description": "Status of the payment\ne.g. PAID\ne.g: AUTHORISED\ne.g: DELETED", "type": "string" }, "modified": { "example": "2020-10-09T14:52:50.550Z", "nullable": true, "description": "Date entry was last modified", "type": "string", "format": "date-time" }, "accountId": { "example": "562555f2-8cde-4ce9-8203-0363922537a4", "nullable": true, "description": "Account Id the payment was made from", "type": "string" }, "customerId": { "example": "1d80716b-427e-4cad-80c6-c4b3a18eb23d", "nullable": true, "description": "Customer Id", "type": "string" }, "customerName": { "example": "Gateway Motors", "nullable": true, "description": "Customer name", "type": "string" }, "linkedTxnId": { "example": "361a4980-7f53-4b68-820c-f6487f613284", "nullable": true, "description": "Transaction Id", "type": "string" }, "linkedTxnType": { "example": "Deposit", "nullable": true, "description": "Transaction type\ne.g. Deposit, Invoice", "type": "string" }, "created": { "example": "2021-10-22T19:30:17.697Z", "nullable": true, "description": "Date entry was created", "type": "string", "format": "date-time" }, "invoiceId": { "example": "129", "nullable": true, "description": "Invoice Id", "type": "string" }, "currencyCode": { "example": "USD", "nullable": true, "description": "Currency code", "type": "string" }, "paymentType": { "example": "PayPal", "nullable": true, "description": "Payment type\ne.g. CreditCard", "type": "string" } } }, "PaymentIntent": { "type": "object", "description": "Payment intent captures the process of collecting a payment from customers", "properties": { "id": { "readOnly": true, "type": "string" }, "integration": { "example": "quickbooks", "nullable": false, "description": "The key of the integration source\ne.g. \"quickbooks\", or \"xero\"", "type": "string" }, "srcId": { "description": "Unique identifier for each payment intent", "type": "string" }, "amount": { "description": "The amount intended to collected from the payment intent", "type": "integer" }, "amountCapturable": { "description": "The amount that can be captured from the payment intent", "type": "integer", "nullable": true }, "amountReceived": { "description": "Amount that was collected by the payment intent", "type": "integer", "nullable": true }, "clientSecret": { "description": "The client secret of the payment intent", "type": "string" }, "confirmationMethod": { "description": "The method of confirmation used.", "type": "string", "nullable": true }, "created": { "description": "The date and time the payment intent was created", "type": "string", "format": "date-time", "nullable": true }, "currency": { "description": "The currency used in the payment intent", "type": "string" }, "customerId": { "description": "The ID of the customer the payment intent belongs to", "type": "string", "nullable": true }, "description": { "description": "A description about the payment intent", "type": "string", "nullable": true }, "invoiceId": { "description": "The ID of the invoice that created this payment intent", "type": "string", "nullable": true }, "paymentMethodId": { "description": "The ID of the payment method used.", "type": "string", "nullable": true }, "email": { "description": "The email address that the receipt for the resulting payment will be sent to", "type": "string", "nullable": true }, "shippingName": { "description": "Recipient name", "type": "string", "nullable": true }, "shippingPhone": { "description": "Recipient phone number", "type": "string", "nullable": true }, "shippingAddress": { "description": "Shipping address for the payment intent", "type": "string", "nullable": true }, "status": { "description": "Status of the payment intent\ne.g. \"requires_payment_method\"\ne.g. \"requires_confirmation\"\ne.g. \"succeeded\"", "type": "string", "nullable": true } } }, "PaymentMethod": { "type": "object", "description": "", "properties": { "id": { "example": "706f68c5-46b2-43d8-9aa8-41d1cc2a317f", "nullable": false, "readOnly": true, "type": "string" }, "integration": { "example": "quickbooks", "nullable": false, "description": "The key of the integration source\ne.g. \"quickbooks\", or \"xero\"", "type": "string" }, "srcId": { "example": "706f68c5-46b2-43d8-9aa8-41d1cc2a317f", "nullable": false, "description": "The unique identifier of the source 3rd party integration", "type": "string" }, "name": { "example": "Diners Club", "nullable": true, "description": "Name for the payment method", "type": "string" }, "type": { "example": "CREDIT_CARD", "nullable": true, "description": "Type of the payment method", "type": "string" }, "created": { "example": "2021-10-22 19:30:17", "nullable": true, "description": "Date the payment method was created", "type": "string", "format": "date-time" }, "modified": { "example": "2021-10-22 19:30:17", "nullable": true, "description": "Date the payment method was last modified", "type": "string", "format": "date-time" } } }, "PaymentService": { "type": "object", "description": "Payment service represents services used that allow for online payments", "properties": { "id": { "readOnly": true, "type": "string" }, "integration": { "example": "quickbooks", "nullable": false, "description": "The key of the integration source\ne.g. \"quickbooks\", or \"xero\"", "type": "string" }, "srcId": { "description": "Unique identifier for each payment service", "type": "string" }, "name": { "description": "Name of payment service", "type": "string" }, "url": { "description": "The custom payment URL", "type": "string" }, "payNowText": { "description": "The text displayed on the Pay Now button", "type": "string" }, "type": { "description": "The type of payment service\ne.g. \"AwesomePay\"\ne.g. \"CUSTOM", "type": "string", "nullable": true } } }, "Payout": { "type": "object", "description": "Payout represents received funds made out to a bank account or debit card", "properties": { "id": { "example": "quickbooks-726", "nullable": false, "readOnly": true, "description": "Unique identifier for payout\nnote that no particular pattern in this field is guaranteed, only that this field is unique\ne.g. \"quickbooks-726\"", "type": "string" }, "integration": { "example": "quickbooks", "nullable": false, "description": "The key of the integration source\ne.g. \"quickbooks\", or \"xero\"", "type": "string" }, "srcId": { "example": "GH2JK-67283H-YW82KHX-2883KK-KS78S", "nullable": false, "description": "The unique identifier of the source 3rd party integration\ne.g. \"GH2JK-67283H-YW82KHX-2883KK-KS78S\"", "type": "string" }, "amount": { "example": 74753, "nullable": false, "description": "The amount to be transferred to a bank account or debit card in cents\ne.g. 74753", "type": "integer" }, "arrivalDate": { "example": "2020-11-03T02:17:40.080Z", "nullable": true, "description": "The date and time the payout is expected to arrive in the bank\ne.g. \"2020-11-03T02:17:40.080Z\"", "type": "string" }, "automatic": { "example": "true", "nullable": true, "description": "Whether the payout was created by an automated payout schedule or not\ne.g. \"true\"", "type": "string" }, "balanceTransactionId": { "example": "7464", "nullable": true, "description": "The ID of the balance transaction that describes the impact of this payout on the account balance\ne.g. \"7464\"", "type": "string" }, "created": { "example": "2020-11-03", "nullable": true, "description": "The date and time this payout was created\ne.g. \"2020-11-03\"", "type": "string" }, "currency": { "example": "USD", "nullable": true, "description": "Currency the payout is made in\ne.g. \"USD\"", "type": "string" }, "payoutDescription": { "example": "Payout description", "nullable": true, "description": "A description of the payout\ne.g. \"Payout description\"", "type": "string" }, "destinationId": { "example": "44", "nullable": true, "description": "The ID of the bank account or card the payout is sent to\ne.g. \"44\"", "type": "string" }, "failureBalanceTransactionId": { "example": "py_1L9D8G2eZgTElo2CaKQjce77", "nullable": true, "description": "The ID of the balance transaction if the payout failed or cancelled\ne.g. \"py_1L9D8G2eZgTElo2CaKQjce77\"", "type": "string" }, "failureCode": { "example": "error 43", "nullable": true, "description": "Error code explaining reason for payout failure.", "type": "string" }, "failureMessage": { "example": "payment failed", "nullable": true, "description": "Message to user further explaining reason for payout failure\ne.g. \"payment failed\"", "type": "string" }, "method": { "example": "Standard", "nullable": true, "description": "Method used to send this payout\ne.g. \"Standard\"\ne.g. \"Instant\"\ne.g. \"Standard\"", "type": "string" }, "sourceType": { "example": "card", "nullable": true, "description": "The source balance this payout came from\ne.g. \"card\"\ne.g. \"bank_account\"", "type": "string" }, "status": { "example": "pending", "nullable": true, "description": "Current status of the payout\ne.g. \"paid\"\ne.g. \"pending\"", "type": "string" }, "payoutType": { "example": "card", "nullable": true, "description": "Type of payout\ne.g. \"bank_account\"\ne.g. \"card\"", "type": "string" } } }, "Payroll": { "type": "object", "description": "", "properties": { "id": { "example": "1", "nullable": false }, "platform": { "example": "ADP", "nullable": false }, "dba": { "example": "Report: Earnings Record", "nullable": true }, "start": { "example": "2018-01-02", "nullable": true }, "end": { "example": "2018-05-15", "nullable": true }, "employee_number": { "example": "5", "nullable": true }, "employee_name": { "example": "Emily Wright", "nullable": true }, "employee_id": { "example": "6319", "nullable": true }, "pay_frequency": { "example": "", "nullable": true }, "hourly_rate": { "example": "37.5000", "nullable": true }, "salary": { "example": "400.00", "nullable": true }, "standard_hours": { "example": "Emily Wright", "nullable": true }, "check_date": { "example": "2018-01-12", "nullable": true }, "check_number": { "example": "50828", "nullable": true }, "coverage_start": { "example": "2018-01-02", "nullable": true }, "coverage_end": { "example": "2018-10-12", "nullable": true }, "gross_wages": { "example": "212.50", "nullable": true }, "social_security": { "example": "91.76", "nullable": true }, "medicare_tax": { "example": "110.40", "nullable": true }, "fica_tax": { "example": "16.26", "nullable": true }, "federal_tax": { "example": "120.78", "nullable": true }, "state_tax": { "example": "42.82", "nullable": true }, "other_tax": { "example": "0.0", "nullable": true }, "local_tax": { "example": "0.0", "nullable": true }, "dental_deductions": { "example": "0.0", "nullable": true }, "health_deductions": { "example": "0.0", "nullable": true }, "hsa_deductions": { "example": "0.0", "nullable": true }, "pre_tax_deductions": { "example": "103.60", "nullable": true }, "after_tax_deductions": { "example": "0.0", "nullable": true }, "voluntary_deductions": { "example": "103.60", "nullable": true }, "garnishment_deductions": { "example": "0.0", "nullable": true }, "description": { "example": "", "nullable": true }, "regular_hours": { "example": "103.60", "nullable": true }, "overtime_hours": { "example": "0.0", "nullable": true }, "holiday_hours": { "example": "0.0", "nullable": true }, "sick_hours": { "example": "0.0", "nullable": true }, "regular_wages": { "example": "1480.00", "nullable": true }, "overtime_wages": { "example": "0.0", "nullable": true }, "reimbursements": { "example": "0.0", "nullable": true }, "commission": { "example": "0.0", "nullable": true }, "bonus": { "example": "0.0", "nullable": true }, "net_pay": { "example": "1100.23", "nullable": true }, "company_futa_tax": { "example": "8.88", "nullable": true }, "company_suta_tax": { "example": "50.32", "nullable": true }, "company_social_security": { "example": "91.76", "nullable": true }, "company_medicare_tax": { "example": "21.46", "nullable": true }, "company_state_tax": { "example": "1.48", "nullable": true }, "company_other_tax": { "example": "0.0", "nullable": true }, "company_other_contributions": { "example": "59.20", "nullable": true } } }, "Plan": { "type": "object", "description": "Plan represents the base price, currency and billing cycle for subscriptions", "properties": { "id": { "example": "quickbooks-726", "nullable": false, "readOnly": true, "type": "string" }, "integration": { "example": "quickbooks", "nullable": false, "description": "The key of the integration source\ne.g. \"quickbooks\", or \"xero\"", "type": "string" }, "srcId": { "example": "706f68c5-46b2-43d8-9aa8-41d1cc2a317f", "nullable": true, "type": "string" }, "isActive": { "example": true, "nullable": true, "type": "boolean" }, "aggregateUsage": { "example": "sum", "nullable": true, "description": "A usage aggregation strategy for metered usage plans\ne.g. \"sum\"\ne.g. \"last_during_period\"\ne.g. \"max\"", "type": "string" }, "amount": { "example": 200, "nullable": true, "description": "price of the plan", "type": "integer" }, "billingScheme": { "example": "per_unit", "nullable": true, "description": "Describes how to compute the price per period\ne.g. \"per_unit\"\ne.g. \"tiered\"", "type": "string" }, "created": { "description": "The date and time the plan is first created", "type": "string", "format": "date-time" }, "currency": { "example": "USD", "nullable": true, "type": "string" }, "description": { "example": "Monthly streaming subscription", "nullable": true, "description": "plan description", "type": "string" }, "productId": { "example": "2", "nullable": true, "description": "id for the plan", "type": "string" }, "tiersMode": { "example": "volume", "nullable": true, "description": "Defines if the tier pricing should be graduated or volume\ne.g. \"graduated\"\ne.g. \"volume\"", "type": "string" }, "transformUsage": { "description": "Division transformation applied to the reported usage", "type": "integer", "nullable": true }, "usageType": { "example": "metered", "nullable": true, "description": "Configures how the quantity per period should be determined\ne.g. \"metered\"\ne.g. \"licensed\"", "type": "string" }, "intervalCount": { "type": "integer", "nullable": true }, "trialPeriodDays": { "type": "integer", "nullable": true } } }, "Product": { "type": "object", "description": "Any offered product or service. For example: a pair of shoes; a concert ticket; the rental of a car; a haircut; or an episode of a TV show streamed online.", "properties": { "id": { "readOnly": true, "type": "string" }, "integration": { "example": "quickbooks", "nullable": false, "description": "The key of the integration source\ne.g. \"quickbooks\", or \"xero\"", "type": "string" }, "additionalType": { "description": "An additional type for the item, typically used for adding more specific types from external vocabularies in microdata syntax. This is a relationship between something and a class that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof' attribute - for multiple types. Schema.org tools may have only weaker understanding of extra types, in particular those defined externally.", "externalDocs": { "url": "http://schema.org/additionalType" }, "type": "string", "nullable": true }, "alternateName": { "description": "an alias for the item", "externalDocs": { "url": "http://schema.org/alternateName" }, "type": "string", "nullable": true }, "award": { "description": "an award won by or for this item", "externalDocs": { "url": "http://schema.org/award" }, "type": "string", "nullable": true }, "categories": { "description": "A category for the item. Greater signs or slashes can be used to informally indicate a category hierarchy.", "externalDocs": { "url": "http://schema.org/category" }, "type": "array", "items": { "type": "string" }, "nullable": true }, "color": { "description": "the color of the product", "externalDocs": { "url": "http://schema.org/color" }, "type": "string", "nullable": true }, "description": { "description": "a description of the item", "externalDocs": { "url": "http://schema.org/description" }, "type": "string", "nullable": true }, "disambiguatingDescription": { "description": "A sub property of description. A short description of the item used to disambiguate from other, similar items. Information from other properties (in particular, name) may be necessary for the description to be useful for disambiguation.", "externalDocs": { "url": "http://schema.org/disambiguatingDescription" }, "type": "string", "nullable": true }, "gtin12": { "description": "The \\[GTIN-12\\](http://apps.gs1.org/GDD/glossary/Pages/GTIN-12.aspx) code of the product, or the product to which the offer refers. The GTIN-12 is the 12-digit GS1 Identification Key composed of a U.P.C. Company Prefix, Item Reference, and Check Digit used to identify trade items. See \\[GS1 GTIN Summary\\](http://www.gs1.org/barcodes/technical/idkeys/gtin) for more details.", "externalDocs": { "url": "http://schema.org/gtin12" }, "type": "string", "nullable": true }, "gtin13s": { "description": "The \\[GTIN-13\\](http://apps.gs1.org/GDD/glossary/Pages/GTIN-13.aspx) code of the product, or the product to which the offer refers. This is equivalent to 13-digit ISBN codes and EAN UCC-13. Former 12-digit UPC codes can be converted into a GTIN-13 code by simply adding a preceeding zero. See \\[GS1 GTIN Summary\\](http://www.gs1.org/barcodes/technical/idkeys/gtin) for more details.", "externalDocs": { "url": "http://schema.org/gtin13" }, "type": "array", "items": { "type": "string" }, "nullable": true }, "gtin14s": { "description": "The \\[GTIN-14\\](http://apps.gs1.org/GDD/glossary/Pages/GTIN-14.aspx) code of the product, or the product to which the offer refers. See \\[GS1 GTIN Summary\\](http://www.gs1.org/barcodes/technical/idkeys/gtin) for more details.", "externalDocs": { "url": "http://schema.org/gtin14" }, "type": "array", "items": { "type": "string" }, "nullable": true }, "gtin8s": { "description": "The \\[GTIN-8\\](http://apps.gs1.org/GDD/glossary/Pages/GTIN-8.aspx) code of the product, or the product to which the offer refers. This code is also known as EAN/UCC-8 or 8-digit EAN. See \\[GS1 GTIN Summary\\](http://www.gs1.org/barcodes/technical/idkeys/gtin) for more details.", "externalDocs": { "url": "http://schema.org/gtin8" }, "type": "array", "items": { "type": "string" }, "nullable": true }, "image": { "description": "An image of the item. This can be a \\[\\[URL\\]\\] or a fully described \\[\\[ImageObject\\]\\].", "externalDocs": { "url": "http://schema.org/image" }, "type": "string", "nullable": true }, "isAccessoryOrSparePartFors": { "description": "a pointer to another product (or multiple products) for which this product is an accessory or spare part", "externalDocs": { "url": "http://schema.org/isAccessoryOrSparePartFor" }, "type": "array", "items": { "type": "string", "format": "iri-reference" }, "nullable": true }, "isConsumableFors": { "description": "a pointer to another product (or multiple products) for which this product is a consumable", "externalDocs": { "url": "http://schema.org/isConsumableFor" }, "type": "array", "items": { "type": "string", "format": "iri-reference" }, "nullable": true }, "isRelatedTo": { "description": "a pointer to another, somehow related product (or multiple products)", "externalDocs": { "url": "http://schema.org/isRelatedTo" }, "type": "string", "format": "iri-reference", "nullable": true }, "isSimilarTos": { "description": "a pointer to another, functionally similar product (or multiple products)", "externalDocs": { "url": "http://schema.org/isSimilarTo" }, "type": "array", "items": { "type": "string", "format": "iri-reference" }, "nullable": true }, "itemCondition": { "description": "a predefined value from OfferItemCondition or a textual description of the condition of the product or service, or the products or services included in the offer", "externalDocs": { "url": "http://schema.org/itemCondition" }, "type": "string", "nullable": true }, "model": { "description": "The model of the product. Use with the URL of a ProductModel or a textual representation of the model identifier. The URL of the ProductModel can be from an external source. It is recommended to additionally provide strong product identifiers via the gtin8/gtin13/gtin14 and mpn properties.", "externalDocs": { "url": "http://schema.org/model" }, "type": "string", "nullable": true }, "mpns": { "description": "the Manufacturer Part Number (MPN) of the product, or the product to which the offer refers", "externalDocs": { "url": "http://schema.org/mpn" }, "type": "array", "items": { "type": "string" }, "nullable": true }, "manufacturer": { "description": "the manufacturer of the product", "externalDocs": { "url": "http://schema.org/manufacturer" }, "type": "string", "nullable": true }, "name": { "description": "the name of the item", "externalDocs": { "url": "http://schema.org/name" }, "type": "string", "nullable": true }, "productID": { "description": "The product identifier, such as ISBN. For example: ``` meta itemprop=\"productID\" content=\"isbn:123-456-789\" ```.", "externalDocs": { "url": "http://schema.org/productID" }, "type": "string", "nullable": true }, "releaseDate": { "description": "The release date of a product or product model. This can be used to distinguish the exact variant of a product.", "externalDocs": { "url": "http://schema.org/releaseDate" }, "type": "string", "format": "date-time", "nullable": true }, "sameA": { "description": "URL of a reference Web page that unambiguously indicates the item's identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or official website.", "externalDocs": { "url": "http://schema.org/sameAs" }, "type": "string", "nullable": true }, "skus": { "description": "The Stock Keeping Unit (SKU), i.e. a merchant-specific identifier for a product or service, or the product to which the offer refers.", "externalDocs": { "url": "http://schema.org/sku" }, "type": "array", "items": { "type": "string" }, "nullable": true }, "url": { "description": "URL of the item", "externalDocs": { "url": "http://schema.org/url" }, "type": "string", "nullable": true }, "material": { "description": "A material that something is made from, e.g. leather, wool, cotton, paper.", "externalDocs": { "url": "http://schema.org/material" }, "type": "string", "nullable": true }, "productionDate": { "description": "The date of production of the item, e.g. vehicle.", "externalDocs": { "url": "http://schema.org/productionDate" }, "type": "string", "format": "date-time", "nullable": true }, "purchaseDate": { "description": "The date the item e.g. vehicle was purchased by the current owner.", "externalDocs": { "url": "http://schema.org/purchaseDate" }, "type": "string", "format": "date-time", "nullable": true }, "identifier": { "description": "The identifier property represents any kind of identifier for any kind of \\[\\[Thing\\]\\], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for representing many of these, either as textual strings or as URL (URI) links. See \\[background notes\\](/docs/datamodel.html#identifierBg) for more details.", "externalDocs": { "url": "http://schema.org/identifier" }, "type": "string", "nullable": true }, "srcId": { "description": "Unique identifier for a product", "type": "string" }, "isActive": { "description": "Whether the product is active or not", "type": "string", "nullable": true }, "height": { "description": "The height of the product", "type": "integer", "nullable": true }, "width": { "description": "Width of the product", "type": "integer", "nullable": true }, "weight": { "description": "Weight of the product", "type": "integer", "nullable": true }, "quantity": { "description": "Quantity of product available", "type": "integer", "nullable": true }, "availableForPurchase": { "description": "Whether the product is available for purchase or not", "type": "boolean", "nullable": true }, "updated": { "description": "The date and time the product was last modified", "type": "string", "nullable": true }, "price": { "description": "The price of the product", "type": "integer", "nullable": true }, "weightUnit": { "description": "The unit weight is measured in", "type": "string", "nullable": true }, "heightUnit": { "description": "The unit height is measured in", "type": "string", "nullable": true }, "widthUnit": { "description": "The unit width is measured in", "type": "string", "nullable": true } } }, "ProfitAndLoss": { "type": "object", "description": "", "properties": { "id": { "readOnly": true, "type": "string" }, "integration": { "example": "quickbooks", "nullable": false, "description": "The key of the integration source\ne.g. \"quickbooks\", or \"xero\"", "type": "string" }, "reportTitle": { "example": "Profit and Loss Statement", "nullable": true, "description": "e.g: ProfitAndLoss", "type": "string" }, "companyName": { "example": "Flux Capacitors Inc", "nullable": true, "description": "e.g: the company legal name", "type": "string" }, "columns": { "description": "columns in profit and loss statement", "type": "array", "items": { "type": "string" }, "nullable": true }, "rows": { "description": "rows in profit and loss statement", "type": "array", "items": { "type": "string" }, "nullable": true }, "accountingMethod": { "example": "cash", "nullable": true, "description": "accounting method: a set of rules under which revenues and expenses are reported in financial statements\ne.g: cash", "type": "string" }, "start": { "description": "start datetime of the profit and loss statement coverage", "type": "string", "format": "date-time", "nullable": true }, "end": { "description": "end datetime of the profit and loss statement coverage", "type": "string", "format": "date-time", "nullable": true }, "currencyCode": { "example": "USD", "nullable": true, "type": "string" }, "totalIncome": { "example": "786532", "nullable": true, "description": "Total income in cents", "type": "integer" }, "totalExpenses": { "example": "756282", "nullable": true, "description": "Total expenses in cents", "type": "integer" } } }, "ProfitAndLossExcel": { "type": "object", "description": "provides an excel workbook of a series of mapped profit and loss reports", "properties": { "file": { "example": "This endpoint returns an .xlsx file." } } }, "ProfitAndLossReport": { "type": "object", "description": "provides a mapped profit and loss report", "properties": { "timestamp": { "type": "string", "format": "date-time", "example": "2021-08-25T15:40:22+00:00" }, "profit_loss": { "type": "string", "example": "INCOME
Sales: 148440.00
Total Income: 148440.00

EXPENSES
Advertising: 500.00
Repair and maintenance: 8000.00
Total Expenses: 8500.00

PROFIT: 139940.00

" }, "yoy_sales_growth": { "type": "number", "format": "float", "example": 1, "nullable": true }, "periods": { "type": "array", "items": { "type": "object" }, "example": [ { "rows": "[{\"type\": \"sectionheader\", \"cells\": [{\"value\": \"INCOME\"}, {\"value\": \"\"}]}, {\"type\": \"row\", \"cells\": [{\"id\": \"9\", \"value\": \"Sales\"}, {\"value\": \"22540.00\"}]}, {\"type\": \"sectionsummary\", \"cells\": [{\"value\": \"Total Income\"}, {\"value\": \"22540.00\"}]}, {\"type\": \"summaryrow\", \"cells\": [{\"value\": \"PROFIT\"}, {\"value\": \"22540.00\"}]}]", "start": "2021-01-01", "end": "2021-01-31", "totals": { "income": 22540, "expenses": 0, "profit": 22540 }, "details": [ { "id": "9", "name": "Sales", "value": 22540, "mapping": "Revenue" } ], "opex": 0, "ebitda": 22540, "adjusted_ebitda": 22540, "ebit": 22540, "gross_margin": 22540, "gross_income": 22540, "yoy_sales_growth": null, "year_ago_sales": null }, { "rows": "[{\"type\": \"sectionheader\", \"cells\": [{\"value\": \"INCOME\"}, {\"value\": \"\"}]}, {\"type\": \"row\", \"cells\": [{\"id\": \"9\", \"value\": \"Sales\"}, {\"value\": \"28000.00\"}]}, {\"type\": \"sectionsummary\", \"cells\": [{\"value\": \"Total Income\"}, {\"value\": \"28000.00\"}]}, {\"type\": \"summaryrow\", \"cells\": [{\"value\": \"PROFIT\"}, {\"value\": \"28000.00\"}]}]", "start": "2021-02-01", "end": "2021-02-28", "totals": { "income": 28000, "expenses": 0, "profit": 28000 }, "details": [ { "id": "9", "name": "Sales", "value": 28000, "mapping": "Revenue" } ], "opex": 0, "ebitda": 28000, "adjusted_ebitda": 28000, "ebit": 28000, "gross_margin": 28000, "gross_income": 28000, "yoy_sales_growth": null, "year_ago_sales": null }, { "rows": "[{\"type\": \"sectionheader\", \"cells\": [{\"value\": \"INCOME\"}, {\"value\": \"\"}]}, {\"type\": \"row\", \"cells\": [{\"id\": \"9\", \"value\": \"Sales\"}, {\"value\": \"24500.00\"}]}, {\"type\": \"sectionsummary\", \"cells\": [{\"value\": \"Total Income\"}, {\"value\": \"24500.00\"}]}, {\"type\": \"sectionheader\", \"cells\": [{\"value\": \"EXPENSES\"}, {\"value\": \"\"}]}, {\"type\": \"row\", \"cells\": [{\"id\": \"17\", \"value\": \"Advertising\"}, {\"value\": \"500.00\"}]}, {\"type\": \"sectionsummary\", \"cells\": [{\"value\": \"Total Expenses\"}, {\"value\": \"500.00\"}]}, {\"type\": \"summaryrow\", \"cells\": [{\"value\": \"PROFIT\"}, {\"value\": \"24000.00\"}]}]", "start": "2021-03-01", "end": "2021-03-31", "totals": { "income": 24500, "expenses": 500, "profit": 24000 }, "details": [ { "id": "9", "name": "Sales", "value": 24500, "mapping": "Revenue" }, { "id": "17", "name": "Advertising", "value": 500, "mapping": "Expenses" } ], "opex": 500, "ebitda": 24000, "adjusted_ebitda": 24000, "ebit": 24000, "gross_margin": 24000, "gross_income": 24500, "yoy_sales_growth": null, "year_ago_sales": null }, { "rows": "[{\"type\": \"sectionheader\", \"cells\": [{\"value\": \"INCOME\"}, {\"value\": \"\"}]}, {\"type\": \"row\", \"cells\": [{\"id\": \"9\", \"value\": \"Sales\"}, {\"value\": \"7500.00\"}]}, {\"type\": \"sectionsummary\", \"cells\": [{\"value\": \"Total Income\"}, {\"value\": \"7500.00\"}]}, {\"type\": \"summaryrow\", \"cells\": [{\"value\": \"PROFIT\"}, {\"value\": \"7500.00\"}]}]", "start": "2021-04-01", "end": "2021-04-30", "totals": { "income": 7500, "expenses": 0, "profit": 7500 }, "details": [ { "id": "9", "name": "Sales", "value": 7500, "mapping": "Revenue" } ], "opex": 0, "ebitda": 7500, "adjusted_ebitda": 7500, "ebit": 7500, "gross_margin": 7500, "gross_income": 7500, "yoy_sales_growth": null, "year_ago_sales": null }, { "rows": "[{\"type\": \"sectionheader\", \"cells\": [{\"value\": \"INCOME\"}, {\"value\": \"\"}]}, {\"type\": \"row\", \"cells\": [{\"id\": \"9\", \"value\": \"Sales\"}, {\"value\": \"22600.00\"}]}, {\"type\": \"sectionsummary\", \"cells\": [{\"value\": \"Total Income\"}, {\"value\": \"22600.00\"}]}, {\"type\": \"summaryrow\", \"cells\": [{\"value\": \"PROFIT\"}, {\"value\": \"22600.00\"}]}]", "start": "2021-05-01", "end": "2021-05-31", "totals": { "income": 22600, "expenses": 0, "profit": 22600 }, "details": [ { "id": "9", "name": "Sales", "value": 22600, "mapping": "Revenue" } ], "opex": 0, "ebitda": 22600, "adjusted_ebitda": 22600, "ebit": 22600, "gross_margin": 22600, "gross_income": 22600, "yoy_sales_growth": null, "year_ago_sales": null }, { "rows": "[{\"type\": \"sectionheader\", \"cells\": [{\"value\": \"INCOME\"}, {\"value\": \"\"}]}, {\"type\": \"row\", \"cells\": [{\"id\": \"9\", \"value\": \"Sales\"}, {\"value\": \"43300.00\"}]}, {\"type\": \"sectionsummary\", \"cells\": [{\"value\": \"Total Income\"}, {\"value\": \"43300.00\"}]}, {\"type\": \"sectionheader\", \"cells\": [{\"value\": \"EXPENSES\"}, {\"value\": \"\"}]}, {\"type\": \"row\", \"cells\": [{\"id\": \"35\", \"value\": \"Repair and maintenance\"}, {\"value\": \"8000.00\"}]}, {\"type\": \"sectionsummary\", \"cells\": [{\"value\": \"Total Expenses\"}, {\"value\": \"8000.00\"}]}, {\"type\": \"summaryrow\", \"cells\": [{\"value\": \"PROFIT\"}, {\"value\": \"35300.00\"}]}]", "start": "2021-06-01", "end": "2021-06-30", "totals": { "income": 43300, "expenses": 8000, "profit": 35300 }, "details": [ { "id": "9", "name": "Sales", "value": 43300, "mapping": "Revenue" }, { "id": "35", "name": "Repair and maintenance", "value": 8000, "mapping": "Expenses" } ], "opex": 8000, "ebitda": 35300, "adjusted_ebitda": 35300, "ebit": 35300, "gross_margin": 35300, "gross_income": 43300, "yoy_sales_growth": null, "year_ago_sales": null }, { "rows": "[{\"type\": \"row\", \"cells\": [{\"value\": \"PROFIT\"}]}]", "start": "2021-07-01", "end": "2021-07-31", "totals": { "income": 0, "expenses": 0, "profit": 0 }, "details": [], "opex": 0, "ebitda": 0, "adjusted_ebitda": 0, "ebit": 0, "gross_margin": 0, "gross_income": 0, "yoy_sales_growth": null, "year_ago_sales": null }, { "rows": "[{\"type\": \"row\", \"cells\": [{\"value\": \"PROFIT\"}]}]", "start": "2021-08-01", "end": "2021-08-31", "totals": { "income": 0, "expenses": 0, "profit": 0 }, "details": [], "opex": 0, "ebitda": 0, "adjusted_ebitda": 0, "ebit": 0, "gross_margin": 0, "gross_income": 0, "yoy_sales_growth": null, "year_ago_sales": null } ] }, "start": { "type": "string", "format": "date", "example": "2021-01-01" }, "end": { "type": "string", "format": "date", "example": "2021-08-25" }, "series": { "type": "array", "items": { "type": "array", "items": { "type": "number", "format": "float" } }, "example": { "inflow": [ 22.5, 28, 24.5, 7.5, 22.6, 43.3, 0, 0 ], "outflow": [ 0, 0, -0.5, 0, 0, -8, 0, 0 ], "net": [ 22.5, 28, 24, 7.5, 22.6, 35.3, 0, 0 ], "series_labels": [ "Jan 21", "Feb 21", "Mar 21", "Apr 21", "May 21", "Jun 21", "Jul 21", "Aug 21" ], "series_reconciled": [ false, false, false, false, false, false, false, false ], "series": [ "2021-01-01", "2021-02-01", "2021-03-01", "2021-04-01", "2021-05-01", "2021-06-01", "2021-07-01", "2021-08-01" ], "opex": [ 0, 0, 0.5, 0, 0, 8, 0, 0 ], "ebitda": [ 22.5, 28, 24, 7.5, 22.6, 35.3, 0, 0 ], "ebit": [ 22.5, 28, 24, 7.5, 22.6, 35.3, 0, 0 ], "gross_margin": [ 22.5, 28, 24, 7.5, 22.6, 35.3, 0, 0 ], "gross_income": [ 22.5, 28, 24.5, 7.5, 22.6, 43.3, 0, 0 ], "year_ago_sales": [ 0, 0, 0, 0, 0, 0, 0, 0 ] }, "nullable": true }, "lastReconciled": { "type": "string", "format": "date", "example": "1980-01-01", "nullable": true }, "lastReconciledLabel": { "type": "string", "example": "Dec 79", "nullable": true }, "isReconciled": { "type": "boolean", "example": false }, "hasCompleteData": { "type": "boolean", "example": true } } }, "Project": { "type": "object", "description": "", "properties": { "id": { "readOnly": true, "type": "string" }, "integration": { "example": "quickbooks", "nullable": false, "description": "The key of the integration source\ne.g. \"quickbooks\", or \"xero\"", "type": "string" }, "srcId": { "description": "the unique identifier of the source 3rd party integration\neg. \"460000000044019\"", "type": "string" }, "projectName": { "description": "Name of the project\neg. \"REAL TIME TRAFFIC FLUX\"", "type": "string", "nullable": true }, "customerId": { "description": "Unique identifier for the customer\neg. \"460000000044001\"", "type": "string", "nullable": true }, "customerName": { "description": "Name of customer\neg. \"SAF Instruments Inc\"", "type": "string", "nullable": true }, "currency": { "description": "Currency\neg. \"USD\"", "type": "string", "nullable": true }, "status": { "description": "Status of project\neg. \"active\"", "type": "string", "nullable": true }, "billingType": { "description": "The way you bill your customer\neg. fixed_cost_for_project,\nbased_on_project_hours,\nbased_on_staff_hours\nbased_on_task_hours", "type": "string", "nullable": true }, "rate": { "description": "Hourly rate for a task in cents\neg. \"5000\"", "type": "integer", "nullable": true }, "totalHours": { "description": "Total hours\neg. \"12.41\"", "type": "number", "nullable": true }, "billableHours": { "description": "Billable hours for the project\neg. \"12.41\"", "type": "number", "nullable": true }, "created": { "description": "Datetime when the project object was created\neg. \"2013-09-18 18:05:27\"", "type": "string", "format": "date-time", "nullable": true }, "modified": { "description": "Datetime when the project object was last updated\neg. \"2013-09-18 18:05:27\"", "type": "string", "format": "date-time", "nullable": true } } }, "ProxyRequest": { "type": "object", "description": "" }, "PublishingChannel": { "type": "object", "description": "Publishing channels represent all channels (e.g. Twitter account, Facebook page) connected to the portal that can be published to", "properties": { "id": { "readOnly": true, "type": "string" }, "integration": { "example": "quickbooks", "nullable": false, "description": "The key of the integration source\ne.g. \"quickbooks\", or \"xero\"", "type": "string" }, "srcId": { "description": "Unique identifier for publishing channel", "type": "string" }, "created": { "description": "The time and date the publishing channel was created", "type": "string" }, "updated": { "description": "The time and date the publishing channel was last modified", "type": "string", "nullable": true }, "isActive": { "description": "Whether the publishing channel is active or not", "type": "boolean", "nullable": true }, "shared": { "description": "Whether the publishing channel is shared or not", "type": "boolean", "nullable": true }, "type": { "description": "Type of publishing channel\ne.g. \"Facebook page\"", "type": "string" }, "accountType": { "description": "Type of account the publishing channel stems from.", "type": "string" }, "name": { "description": "The name of the publishing channel\ne.g. \"ABC Facebook page\"", "type": "string" }, "profileUrl": { "description": "The web address to the publishing channel", "type": "string", "nullable": true } } }, "Purchase": { "type": "object", "description": "", "properties": { "id": { "example": "stripe-5050", "nullable": false, "readOnly": true, "description": "Unique identifier for this purchase\nnote that no particular pattern in this field is guaranteed, only that this field is unique\ne.g: \"stripe-5050\"", "type": "string" }, "integration": { "example": "quickbooks", "nullable": false, "description": "The key of the integration source\ne.g. \"quickbooks\", or \"xero\"", "type": "string" }, "paymentType": { "example": "CreditCard", "nullable": true, "description": "Payment type\ne.g: \"CreditCard\"", "type": "string" }, "accountId": { "example": "1057", "nullable": false, "description": "ID of account associated with purchase\ne.g: \"1057\"", "type": "string" }, "currency": { "example": "USD", "nullable": true, "description": "Currency code\ne.g. USD", "type": "string" }, "txnDate": { "example": "2019-08-25", "nullable": true, "description": "Transaction date\ne.g. \"2019-08-25\"", "type": "string" }, "totalAmount": { "example": 450000, "nullable": false, "description": "Total amount purchased in cents\ne.g. 450000", "type": "integer" }, "created": { "example": "2019-08-25T02:17:40.080Z", "nullable": true, "description": "Date entry was created\ne.g. \"2019-08-25T02:17:40.080Z\"", "type": "string", "format": "date-time" }, "modified": { "example": "2019-08-26T02:17:40.080Z", "nullable": true, "description": "Date purchase was last modified\ne.g. \"2019-08-26T02:17:40.080Z\"", "type": "string", "format": "date-time" }, "srcId": { "example": "GH2JK-67283H-YW82KHX-2883KK-KS78S", "nullable": false, "description": "The unique identifier of the source 3rd party integration\ne.g. \"GH2JK-67283H-YW82KHX-2883KK-KS78S\"", "type": "string" }, "customerId": { "example": "C056", "nullable": true, "description": "Id of the customer who made the purchase\ne.g. \"C056\"", "type": "string" }, "name": { "example": "purchase name", "nullable": true, "description": "Name of the purchase\ne.g. \"purchase name\"", "type": "string" }, "status": { "example": "shipped", "nullable": true, "description": "Status of the product\ne.g. \"shipped\"", "type": "string" }, "quantity": { "example": 10, "nullable": true, "description": "Quantity purchased\ne.g. 10", "type": "integer" }, "amountPerUnit": { "example": "450", "nullable": true, "description": "Amount per unit\ne.g. \"450\"", "type": "string" }, "txnId": { "example": "4560", "nullable": true, "description": "Transaction Id\ne.g. \"4560\"", "type": "string" }, "accountName": { "example": "Cool Cars", "nullable": true, "description": "Name of the account associated with the purchase\ne.g. \"Cool Cars\"", "type": "string" }, "invoiceId": { "example": "9870028192", "nullable": true, "description": "ID of the invoice associated with the purchase\ne.g. \"9870028192\"", "type": "string" }, "contactId": { "example": "23", "nullable": true, "writeOnly": true, "description": "Id of the contact which is usually a payee\ne.g. \"23\"", "type": "string" }, "contactName": { "example": "Cool Cars", "nullable": true, "description": "Name of the contact which is usually a payee\ne.g. \"Cool Cars\"", "type": "string" }, "contactType": { "example": "Vendor", "nullable": true, "description": "Type of the contact which can be customer, vendor, or employee", "type": "string" }, "paymentMethodId": { "example": "1d80716b-427e-4cad-80c6-c4b3a18eb23d", "nullable": true, "description": "Reference to the related Payment Method object", "type": "string" } } }, "PurchaseCreditNote": { "type": "object", "description": "", "properties": { "id": { "readOnly": true, "type": "string" }, "integration": { "example": "quickbooks", "nullable": false, "description": "The key of the integration source\ne.g. \"quickbooks\", or \"xero\"", "type": "string" }, "created": { "type": "string", "format": "date-time", "nullable": true }, "modified": { "type": "string", "format": "date-time", "nullable": true }, "srcId": { "type": "string" }, "name": { "type": "string", "nullable": true }, "referenceNumber": { "type": "string", "nullable": true }, "totalAmount": { "type": "integer", "nullable": true }, "balance": { "type": "integer", "nullable": true }, "date": { "type": "string", "format": "date-time", "nullable": true }, "currency": { "type": "string", "nullable": true }, "status": { "type": "string", "nullable": true }, "notes": { "type": "string", "nullable": true }, "customerId": { "type": "string", "nullable": true }, "customerName": { "type": "string", "nullable": true } } }, "PurchaseOrder": { "type": "object", "description": "", "properties": { "id": { "readOnly": true, "type": "string" }, "integration": { "example": "quickbooks", "nullable": false, "description": "The key of the integration source\ne.g. \"quickbooks\", or \"xero\"", "type": "string" }, "srcId": { "type": "string" }, "vendorId": { "description": "Vendor Id", "type": "string" }, "vendorName": { "description": "Vendor name", "type": "string", "nullable": true }, "currency": { "description": "Currency code\ne.g. USD", "type": "string", "nullable": true }, "totalAmount": { "description": "Total amount of the purchase\ne.g. 1000", "type": "integer" }, "poStatus": { "description": "Purchase order status, either open or closed\ne.g. Open", "type": "string", "nullable": true }, "created": { "description": "Date entry was created", "type": "string", "format": "date-time", "nullable": true }, "modified": { "description": "Date entry was last modified", "type": "string", "format": "date-time", "nullable": true }, "referenceNumber": { "description": "Purchase order reference number", "type": "string", "nullable": true }, "deliveryDate": { "description": "Date purchase order was delivered", "type": "string", "nullable": true }, "subtotal": { "description": "Subtotal", "type": "integer", "nullable": true }, "txnStatus": { "description": "Transaction status", "type": "string", "nullable": true } } }, "Quote": { "type": "object", "description": "", "properties": { "id": { "example": "quickbooks-726", "nullable": false, "readOnly": true, "type": "string" }, "integration": { "example": "quickbooks", "nullable": false, "description": "The key of the integration source\ne.g. \"quickbooks\", or \"xero\"", "type": "string" }, "srcId": { "example": "90300000072369", "nullable": false, "description": "Unique identifier for the item", "type": "string" }, "created": { "example": "2021-07-28 00:00:00", "nullable": true, "description": "Datetime when the item was created", "type": "string", "format": "date-time" }, "modified": { "example": "2021-09-15 00:00:00", "nullable": true, "description": "Datetime when the item was last updated", "type": "string", "format": "date-time" }, "customerId": { "example": "0124", "nullable": true, "description": "Unique identifier for contact", "type": "string" }, "customerName": { "example": "John Doe", "nullable": true, "description": "Contact name", "type": "string" }, "quoteNumber": { "example": "99", "nullable": true, "description": "Generated quote number", "type": "string" }, "txnDate": { "example": "2021-07-28 00:00:00", "nullable": true, "description": "Date of the quote", "type": "string" }, "billingCity": { "example": "Toronto", "nullable": true, "description": "Main address city", "type": "string" }, "billingPostalcode": { "example": "H6F0R3", "nullable": true, "description": "Main address postalcode", "type": "string" }, "billingCountry": { "example": "Canada", "nullable": true, "description": "Main address country", "type": "string" }, "shippingCity": { "example": "Vancouver", "nullable": true, "description": "Delivery address city", "type": "string" }, "shippingCountry": { "example": "Canada", "nullable": true, "description": "Delivery address country", "type": "string" }, "totalAmount": { "example": 5000000, "nullable": true, "description": "Total amount of the quote", "type": "integer" }, "currency": { "example": "CAD", "nullable": true, "description": "Currency of the quote", "type": "string" }, "txnStatus": { "example": "2021-09-15 00:00:00", "nullable": true, "description": "Status of quote", "type": "string" }, "shippingPostalcode": { "example": "V5N7G4", "nullable": true, "description": "Delivery address postalcode", "type": "string" } } }, "RecurringCharge": { "type": "object", "description": "", "properties": { "id": { "readOnly": true, "type": "string" }, "integration": { "example": "quickbooks", "nullable": false, "description": "The key of the integration source\ne.g. \"quickbooks\", or \"xero\"", "type": "string" }, "name": { "example": "Monthly Rental", "nullable": true, "description": "Name of the recurring charge", "type": "string" }, "srcId": { "example": "982000000567240", "nullable": true, "description": "Unique identifier for each recurring charge", "type": "string" }, "apiClientId": { "example": "aa2e-87c43f2a32a9", "nullable": true, "description": "API key for the app the charge is associated with", "type": "string" }, "price": { "example": 1200, "nullable": true, "description": "The price of the recurring application charge", "type": "integer" }, "status": { "example": "Pending", "nullable": true, "description": "The status of the recurring charge\ne.g. \"Pending\"\ne.g. \"Accepted\"", "type": "string" }, "returnUrl": { "example": "www.example.com", "nullable": true, "description": "The URL where the merchant is redirected afteraccepting the charge", "type": "string" }, "billingDate": { "example": "2021-07-28", "nullable": true, "description": "The date and time when the customer is billed", "type": "string", "format": "date-time" }, "created": { "example": "2021-07-28 00:00:00", "nullable": true, "description": "The date and time when the recurring charge was created\neg. \"2021-11-18T02:17:40.080Z\"", "type": "string", "format": "date-time" }, "modified": { "example": "2021-07-28 00:00:00", "nullable": true, "description": "The date and time when the recurring charge was last modified\neg. \"2021-11-18T02:17:40.080Z\"", "type": "string", "format": "date-time" }, "activationDate": { "example": "2021-06-28", "nullable": true, "description": "The date and time when the customer activated the recurring charge", "type": "string", "format": "date-time" }, "cancellationDate": { "example": "2021-08-28", "nullable": true, "description": "The date and time when the merchant cancelled their recurring charge", "type": "string", "format": "date-time" }, "trialDays": { "example": 12, "nullable": true, "description": "The number of days that the customer is eligible for a free trial", "type": "integer" }, "trialEndsOn": { "example": "2021-07-09", "nullable": true, "description": "The date and time when the free trial ends", "type": "string", "format": "date-time" }, "decoratedReturnUrl": { "example": "https://www.example.com", "nullable": true, "description": "The display URL where the merchant is redirected after accepting a charge", "type": "string" } } }, "RecurringExpense": { "type": "object", "description": "", "properties": { "id": { "example": "xero-01e01427-6b48-4d5f-aa2e-87c43f2a32a9", "nullable": false, "readOnly": true, "type": "string" }, "integration": { "example": "quickbooks", "nullable": false, "description": "The key of the integration source\ne.g. \"quickbooks\", or \"xero\"", "type": "string" }, "srcId": { "example": "982000000567240", "nullable": false, "description": "Unique identifier of the source 3rd party integration\neg. 982000000567240", "type": "string" }, "recurrenceName": { "example": "Monthly Rental", "nullable": true, "description": "Name of the recurring-expense\neg. \"Monthly Rental\"", "type": "string" }, "startDate": { "example": "2020-11-19T00:00:00.000Z", "nullable": true, "description": "Start date of the recurring expense\neg. 2016-11-19T00:00:00.000Z", "type": "string" }, "endDate": { "example": "2024-11-19T00:00:00.000Z", "nullable": true, "description": "End date of the recurring expense\neg. 2016-11-19T00:00:00.000Z", "type": "string" }, "lastCreatedDate": { "example": "2021-11-18T00:00:00.000Z", "nullable": true, "description": "When expense was last generated\neg. \"2013-11-18T00:00:00.000Z\"", "type": "string" }, "recurrenceFrequency": { "example": "months", "nullable": true, "description": "The frequency of time interval at which the invoice is to be generated\neg. \"months\"", "type": "string" }, "repeatEvery": { "example": "2", "nullable": true, "description": "The period between every recurrency frequency\neg. \"2\"", "type": "string" }, "nextExpenseDate": { "example": "2021-12-18T00:00:00.000Z", "nullable": true, "description": "Date the next expense will be generated\neg. \"2013-12-18T00:00:00.000Z\"", "type": "string" }, "accountId": { "example": "982000000561057", "nullable": true, "description": "Unique identifier for the account associated with the recurring expense\n\"982000000561057\"", "type": "string" }, "accountName": { "example": "Rent", "nullable": true, "description": "Expense account name\neg. \"Rent\"", "type": "string" }, "currency": { "example": "USD", "nullable": true, "description": "Currency of the expense\neg. \"USD\"", "type": "string" }, "total": { "example": 100, "nullable": true, "description": "Total amount in cents\neg. \"1000\"", "type": "integer" }, "customerId": { "example": "982000000567001", "nullable": true, "description": "Customer ID of the customer for whom the recurring invoice is raised\neg. \"982000000567001\"", "type": "string" }, "status": { "example": "active", "nullable": true, "description": "Status of the recurring expense\neg. \"active\"", "type": "string" }, "created": { "example": "2021-07-28 00:00:00", "nullable": true, "description": "Time at which the recurring invoice was created\neg. \"2013-11-18T02:17:40.080Z\"", "type": "string", "format": "date-time" }, "modified": { "example": "2021-09-15 00:00:00", "nullable": true, "description": "Time at which the recurring invoice details were last updated\neg. \"2013-11-18T02:17:40.080Z\"", "type": "string", "format": "date-time" } } }, "Refund": { "type": "object", "description": "Refund captures funds that are refunded to a credit or debit card", "properties": { "id": { "example": "quickbooks-66", "nullable": false, "readOnly": true, "type": "string" }, "integration": { "example": "quickbooks", "nullable": false, "description": "The key of the integration source\ne.g. \"quickbooks\", or \"xero\"", "type": "string" }, "accountId": { "example": "35", "nullable": false, "type": "string" }, "currency": { "example": "USD", "nullable": true, "description": "Currency the refund was made in", "type": "string" }, "paymentRef": { "example": "USD", "nullable": true, "description": "Transaction number that appears on email receipts sent for this refund", "type": "string" }, "txnDate": { "example": "2021-06-24", "nullable": true, "description": "The date and time the refund was created", "type": "string" }, "totalAmount": { "example": 8750, "nullable": false, "description": "Total amount refunded", "type": "integer" }, "balance": { "example": 0, "nullable": true, "type": "integer" }, "customerId": { "example": "15", "nullable": true, "type": "string" }, "created": { "example": "2021-06-24T22:35:07+00:00", "nullable": true, "description": "The date and time the refund was created", "type": "string", "format": "date-time" }, "modified": { "example": "2021-06-24T22:35:07+00:00", "nullable": true, "type": "string", "format": "date-time" }, "srcId": { "example": "66", "nullable": false, "description": "Unique identifier for each refund", "type": "string" }, "reason": { "example": "bad item", "nullable": true, "description": "Reason for refund", "type": "string" }, "status": { "example": "succeeded", "nullable": true, "description": "Status of refund\ne.g. \"pending\"\ne.g. \"succeeded\"\ne.g. \"failed\"", "type": "string" } } }, "RepeatingInvoice": { "type": "object", "description": "Repeating invoice represents invoices that are automatically created at regular intervals", "properties": { "id": { "example": "xero-01e01427-6b48-4d5f-aa2e-87c43f2a32a9", "nullable": false, "readOnly": true, "type": "string" }, "integration": { "example": "quickbooks", "nullable": false, "description": "The key of the integration source\ne.g. \"quickbooks\", or \"xero\"", "type": "string" }, "srcId": { "example": "01e01427-6b48-4d5f-aa2e-87c43f2a32a9", "nullable": false, "description": "Unique identifier for each repeating invoice", "type": "string" }, "period": { "example": 1, "nullable": true, "description": "Number of times the invoice is charged per unit", "type": "integer" }, "unit": { "example": "MONTHLY", "nullable": true, "description": "Interval unit defining how often the invoice is charged\ne.g. WEEKLY\ne.g. MONTHLY", "type": "string" }, "dueDate": { "example": "0", "nullable": true, "description": "Number of days defining when the invoice is scheduled to be charged", "type": "string" }, "dueDateType": { "example": "DAYSAFTERBILLDATE", "nullable": true, "description": "The type of billing used together with due date\ne.g. \"DAYSAFTERBILLDATE\"\ne.g. \"DAYSAFTERBILLMONTH\"\ne.g. \"OFCURRENTMONTH\"\ne.g. \"OFFOLLOWINGMONTH\"", "type": "string" }, "startDate": { "example": "2021-02-27 00:00:00", "nullable": true, "description": "date on which the recurring invoice starts", "type": "string" }, "nextScheduledDate": { "example": "2021-07-28 00:00:00", "nullable": true, "description": "date at which next invoice is to be sent", "type": "string" }, "type": { "example": "ACCPAY", "nullable": true, "description": "The type of invoice\ne.g. \"ACCPAY\"\ne.g. \"ACCREC\"", "type": "string" }, "reference": { "example": "AP", "nullable": true, "description": "Order number of recurring invoice", "type": "string" }, "hasAttachments": { "example": false, "nullable": true, "description": "Whether the invoice has attachments or not", "type": "boolean" }, "contactId": { "example": "3b30a108-9156-4a42-a893-3bbbe7af1ef8", "nullable": true, "description": "Id of customer for whom recurring invoice is raised", "type": "string" }, "contactName": { "example": "Xero", "nullable": true, "description": "Full name of contact", "type": "string" }, "status": { "example": "AUTHORISED", "nullable": true, "description": "Status of the repeating invoice\ne.g. \"DRAFT\"\ne.g. \"AUTHORISED\"", "type": "string" }, "lineAmountTypes": { "example": "Exclusive", "nullable": true, "description": "Whether the line amount includes, excludes or doesn't have tax.", "type": "string" }, "lineItemDescription": { "example": "Monthly subscription", "nullable": true, "description": "A description of the line item", "type": "string" }, "lineItemUnitAmount": { "example": 29, "nullable": true, "description": "The unit amount of the line item", "type": "integer" }, "lineItemTaxType": { "example": "INPUT", "nullable": true, "description": "The type of tax applied to line items\ne.g. \"OUTPUT\"\ne.g. \"INPUT\"\ne.g. \"CAPEXINPUT\"", "type": "string" }, "lineAmount": { "example": 29, "nullable": true, "description": "The final amount for the line items", "type": "integer" }, "lineItemAccountCode": { "example": "412", "nullable": true, "description": "Account code for the line item", "type": "string" }, "lineItemQuantity": { "example": 1, "nullable": true, "description": "The quantity of the line items", "type": "integer" }, "lineItemId": { "example": "304e5b38-d62f-4c43-91d2-24786154c3c0", "nullable": true, "description": "Unique ID for the line item", "type": "string" }, "subTotal": { "example": 2900, "nullable": true, "description": "Total of invoice excluding taxes", "type": "integer" }, "totalTax": { "example": 239, "nullable": true, "description": "Total tax on invoice", "type": "integer" }, "total": { "example": 3139, "nullable": false, "description": "Total of invoice tax inclusive", "type": "integer" }, "currencyCode": { "example": "USD", "nullable": true, "description": "currency of invoice", "type": "string" }, "recurrenceName": { "example": "412", "nullable": true, "description": "Unique name for the recurring profile given by the user", "type": "string" }, "endDate": { "example": "2022-07-28 00:00:00", "nullable": true, "description": "date on which the recurring invoice expires", "type": "string" }, "lastSentDate": { "example": "2021-08-28 00:00:00", "nullable": true, "description": "date at which the last invoice was sent", "type": "string" }, "paidInvoicesTotal": { "example": 1000, "nullable": true, "description": "total amount paid to date", "type": "integer" }, "unpaidInvoicesBalance": { "example": 2139, "nullable": true, "description": "total amount left to be paid", "type": "integer" }, "discount": { "example": 412, "nullable": true, "type": "integer" }, "billingStreet": { "example": "123 lonecrest drive", "nullable": true, "type": "string" }, "billingStreet2": { "example": "412 fuller cres", "nullable": true, "type": "string" }, "billingCity": { "example": "Toronto", "nullable": true, "type": "string" }, "billingState": { "example": "Ontario", "nullable": true, "type": "string" }, "billingPostalCode": { "example": "H6F 3F6", "nullable": true, "type": "string" }, "billingCountry": { "example": "Canada", "nullable": true, "type": "string" }, "created": { "example": "2021-07-28 00:00:00", "nullable": true, "type": "string", "format": "date-time" }, "modified": { "example": "2021-09-15 00:00:00", "nullable": true, "type": "string", "format": "date-time" } } }, "Report": { "type": "object", "description": "", "properties": { "id": { "readOnly": true, "type": "string" }, "integration": { "example": "quickbooks", "nullable": false, "description": "The key of the integration source\ne.g. \"quickbooks\", or \"xero\"", "type": "string" }, "srcId": { "description": "Unique identifier for each report", "type": "string" }, "category": { "description": "Category for the report", "type": "string", "nullable": true }, "name": { "description": "Name of the report", "type": "string" }, "query": { "description": "Query that generates the report", "type": "string", "nullable": true }, "modified": { "description": "Date and time last modified", "type": "string", "nullable": true } } }, "Reservation": { "type": "object", "description": "Describes a reservation for travel, dining or an event. Some reservations require tickets. \\\\n\\\\nNote: This type is for information about actual reservations, e.g. in confirmation emails or HTML pages with individual confirmations of reservations. For offers of tickets, restaurant reservations, flights, or rental cars, use \\[\\[Offer\\]\\].", "properties": { "id": { "type": "string" }, "integration": { "example": "quickbooks", "nullable": false, "description": "The key of the integration source\ne.g. \"quickbooks\", or \"xero\"", "type": "string" }, "mainEntityOfPageId": { "type": "string", "nullable": true }, "reservationForId": { "type": "string", "nullable": true }, "underNameId": { "type": "string", "nullable": true }, "providerId": { "type": "string", "nullable": true }, "programMembershipUsedId": { "type": "string", "nullable": true }, "reservedTicketId": { "type": "string", "nullable": true }, "potentialActionId": { "type": "string", "nullable": true }, "additionalType": { "type": "string", "nullable": true }, "alternateName": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "disambiguatingDescription": { "type": "string", "nullable": true }, "image": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true }, "url": { "type": "string", "nullable": true }, "reservationId": { "type": "string", "nullable": true }, "reservationStatus": { "type": "string", "nullable": true }, "bookingTime": { "type": "string", "format": "date-time", "nullable": true }, "modifiedTime": { "type": "string", "format": "date-time", "nullable": true }, "totalPrice": { "type": "integer", "nullable": true }, "priceCurrency": { "type": "string", "nullable": true }, "brokerId": { "type": "string", "nullable": true } } }, "RevenueStat": { "type": "object", "description": "", "properties": { "id": { "readOnly": true, "type": "string" }, "integration": { "example": "quickbooks", "nullable": false, "description": "The key of the integration source\ne.g. \"quickbooks\", or \"xero\"", "type": "string" }, "srcId": { "description": "Unique identifier for the customer\ne.g. \"1\"", "type": "string" }, "sellerName": { "description": "Full name of seller", "type": "string", "nullable": true }, "siteName": { "description": "Site name", "type": "string", "nullable": true }, "currency": { "description": "Currency used for revenue\ne.g. USD", "type": "string", "nullable": true }, "totalSubscriptions": { "description": "Number of total subscriptions", "type": "string", "nullable": true }, "totalRevenue": { "description": "Total revenue", "type": "string", "nullable": true }, "revenueToday": { "description": "Revenue from today", "type": "string", "nullable": true }, "revenueThisMonth": { "description": "Revenue from current month", "type": "string", "nullable": true }, "revenueThisYear": { "description": "Revenue from current year", "type": "string", "nullable": true }, "siteId": { "type": "string", "nullable": true } } }, "SalesOrder": { "type": "object", "description": "", "properties": { "id": { "readOnly": true, "type": "string" }, "integration": { "example": "quickbooks", "nullable": false, "description": "The key of the integration source\ne.g. \"quickbooks\", or \"xero\"", "type": "string" }, "srcId": { "description": "Unique identifier of the source 3rd party integration\neg. \"460000000039129\"", "type": "string" }, "customerId": { "description": "ID of the customer to whom the sales order has to be created\neg. \"460000000017138\"", "type": "string", "nullable": true }, "Identifier": { "description": "Unique number generated (starts with SO) which will be displayed in the interface and sales orders\neg. \"SO-00001\"", "type": "string", "nullable": true }, "referenceNumber": { "description": "Reference number to sales-order\neg. \"REF-001\"", "type": "string", "nullable": true }, "txnDate": { "description": "The date, the sales order is created.", "type": "string", "nullable": true }, "txnStatus": { "description": "Status of sales-order\neg. \"open\"", "type": "string", "nullable": true }, "customerName": { "description": "Name of the customer associated with the Sales Order\neg. \"Bowman Furniture\"", "type": "string", "nullable": true }, "currency": { "description": "Code of the Currency involved in the Sales Order\neg. \"USD\"", "type": "string", "nullable": true }, "subtotal": { "description": "Subtotal of sales order\neg. 90", "type": "integer", "nullable": true }, "totalAmount": { "description": "Total of sales order\neg. 100", "type": "integer", "nullable": true }, "created": { "description": "Creation Time of the Sales Order\neg. 2014-07-28T08:29:07+0530", "type": "string", "format": "date-time", "nullable": true }, "modified": { "description": "Last modified time of the Sales Order\neg. 2014-07-28T08:29:07+0530", "type": "string", "format": "date-time", "nullable": true }, "billingCity": { "description": "Billing city\neg. Beijing", "type": "string", "nullable": true }, "billingCountry": { "description": "Billing country\neg. China", "type": "string", "nullable": true }, "billingPostalcode": { "description": "Billing postal code\neg. 1000881", "type": "string", "nullable": true }, "shippingCity": { "description": "Shipping city\neg Beijing", "type": "string", "nullable": true }, "shippingCountry": { "description": "Shipping country\neg China", "type": "string", "nullable": true }, "shippingPostalcode": { "description": "Shipping postal code\neg. 1000881", "type": "string", "nullable": true }, "identifier": { "type": "string", "nullable": true } } }, "SiteEvent": { "type": "object", "description": "", "properties": { "id": { "readOnly": true, "type": "string" }, "integration": { "example": "quickbooks", "nullable": false, "description": "The key of the integration source\ne.g. \"quickbooks\", or \"xero\"", "type": "string" }, "name": { "type": "string" }, "description": { "type": "string", "nullable": true }, "subscriptionId": { "type": "string", "nullable": true }, "created": { "type": "string", "nullable": true } } }, "Statement": { "type": "object", "description": "", "properties": { "id": { "readOnly": true, "type": "string" }, "integration": { "example": "quickbooks", "nullable": false, "description": "The key of the integration source\ne.g. \"quickbooks\", or \"xero\"", "type": "string" }, "srcId": { "description": "Unique identifier for the customer\ne.g. \"1\"", "type": "string" }, "customerFirstName": { "description": "First name", "type": "string", "nullable": true }, "customerLastName": { "description": "Last name", "type": "string", "nullable": true }, "customerCompany": { "description": "Company name", "type": "string", "nullable": true }, "subscriptionId": { "description": "Subscription Id", "type": "string", "nullable": true }, "description": { "description": "Description of the statement", "type": "string", "nullable": true }, "transactionId": { "description": "Transaction Id", "type": "string", "nullable": true }, "eventId": { "description": "Event Id", "type": "string", "nullable": true }, "created": { "description": "Date entry was created", "type": "string", "nullable": true } } }, "SubscriberLocation": { "type": "object", "description": "", "properties": { "id": { "readOnly": true, "type": "string" }, "integration": { "example": "quickbooks", "nullable": false, "description": "The key of the integration source\ne.g. \"quickbooks\", or \"xero\"", "type": "string" }, "srcId": { "type": "string" }, "totalItems": { "type": "integer", "nullable": true }, "country": { "type": "string", "nullable": true }, "percent": { "type": "string", "nullable": true }, "total": { "type": "integer", "nullable": true } } }, "Subscription": { "type": "object", "description": "", "properties": { "id": { "example": "quickbooks-726", "nullable": false, "readOnly": true, "description": "Unique identifier for this subscription\nnote that no particular pattern in this field is guaranteed, only that this field is unique\ne.g. \"quickbooks-726\"", "type": "string" }, "integration": { "example": "quickbooks", "nullable": false, "description": "The key of the integration source\ne.g. \"quickbooks\", or \"xero\"", "type": "string" }, "srcId": { "example": "GH2JK-67283H-YW82KHX-2883KK-KS78S", "nullable": false, "description": "The unique identifier of the source 3rd party integration\ne.g. \"GH2JK-67283H-YW82KHX-2883KK-KS78S\"", "type": "string" }, "status": { "example": true, "nullable": true, "description": "Status of the subscription\ne.g. expired", "type": "boolean" }, "balance": { "example": 500045, "nullable": true, "description": "Amount in balance for the subscription in cents\ne.g. 500045", "type": "integer" }, "totalRevenue": { "example": 387687, "nullable": true, "description": "Total revenue from this specific subscription in cents\ne.g. 387687", "type": "integer" }, "productPrice": { "example": 4999, "nullable": true, "description": "Price of the subscribed product in cents\ne.g. 4999", "type": "integer" }, "currencyCode": { "example": "EUR", "nullable": true, "description": "Currency code\ne.g. \"EUR\"", "type": "string" }, "currentPeriodStart": { "example": "1655792028", "nullable": true, "description": "Current period start datetime\ne.g. \"2014-11-18\"\ne.g. \"1655792028\"", "type": "string" }, "currentPeriodEnd": { "example": "1653977628", "nullable": true, "description": "Current period end datetime\ne.g. \"2014-11-18\"\ne.g. \"1653977628\"", "type": "string" }, "nextPeriodStart": { "example": "1653977628", "nullable": true, "description": "Date next period starts\ne.g. \"2014-11-18\"\ne.g. \"1653977628\"", "type": "string" }, "cancelAtEndOfPeriod": { "example": true, "nullable": true, "description": "Boolean on if plan is canelled at the end of the current period", "type": "boolean" }, "signupId": { "example": "user123", "nullable": true, "description": "Signup id\ne.g. \"user123\"", "type": "string" }, "signupRevenue": { "example": "250", "nullable": true, "description": "Signup revenue\ne.g. \"250\"", "type": "string" }, "couponCode": { "example": "PROMOCODE", "nullable": true, "description": "Coupon code\ne.g. \"PROMOCODE\"", "type": "string" }, "customerId": { "example": "123", "nullable": true, "description": "Customer id\ne.g. \"123\"", "type": "string" }, "productId": { "example": "321", "nullable": true, "description": "Id for the subscribed product\ne.g. \"321\"", "type": "string" }, "creditCardId": { "example": "4250", "nullable": true, "description": "Credit card id\ne.g. \"4250\"", "type": "string" }, "created": { "example": "2013-11-18T02:17:40.080Z", "nullable": true, "description": "The date and time the subscription is first created\ne.g. \"2013-11-18T02:17:40.080Z\"", "type": "string", "format": "date-time" }, "modified": { "example": "2013-11-18T02:17:40.080Z", "nullable": true, "description": "Date entry was last modified\ne.g. \"2013-11-18T02:17:40.080Z\"", "type": "string", "format": "date-time" }, "customerFirstName": { "example": "Jane", "nullable": true, "description": "Customer first name\ne.g. \"Jane\"", "type": "string" }, "customerLastName": { "example": "Doe", "nullable": true, "description": "Customer last name\ne.g. \"Doe\"", "type": "string" }, "startDate": { "example": "2013-11-18T02:17:40.080Z", "nullable": true, "description": "Start datetime of the subscription\ne.g. \"2013-11-18T02:17:40.080Z\"", "type": "string", "format": "date-time" }, "endDate": { "example": "2015-11-18T02:17:40.080Z", "nullable": true, "description": "End datetime of the subscription\ne.g. \"2015-11-18T02:17:40.080Z\"", "type": "string", "format": "date-time" }, "planName": { "example": "Basic Plan", "nullable": true, "description": "Name of the plan of which this subscription is an instance\ne.g. \"Basic Plan\"", "type": "string" }, "activated": { "example": "Jan 23 2023", "nullable": true, "description": "Indicates when the subscription was activated\ne.g. \"Jan 23 2023\"", "type": "string" }, "remainingIntervals": { "example": 12, "nullable": true, "description": "Number of remaining subscription intervals\ne.g. 12", "type": "integer" }, "monthlyRevenue": { "example": 500000, "nullable": true, "description": "Revenue per month in cents\ne.g. 500000", "type": "integer" }, "netMonthlyRevenue": { "example": 300000, "nullable": true, "description": "Monthly revenue after taxes\ne.g. 300000", "type": "integer" }, "contractStartDate": { "example": "2013-11-18T02:17:40.080Z", "nullable": true, "description": "Date contract starts\n\t * e.g. \"2013-11-18T02:17:40.080Z\"", "type": "string", "format": "date-time" }, "expiredTimestamp": { "example": "2013-11-18T02:17:40.080Z", "nullable": true, "description": "When the current subscription expires\ne.g. \"2013-11-18T02:17:40.080Z\"", "type": "string", "format": "date-time" }, "planInterval": { "example": "Monthly", "nullable": true, "description": "Length of each subscription plan\ne.g. \"Monthly\"", "type": "string" }, "numOfIntervals": { "example": 12, "nullable": true, "description": "Number of subscription intervals\ne.g. 12", "type": "integer" } } }, "SupportTicket": { "type": "object", "description": "Support tickets represent a customer request for help, support, service, or a response, and the responses generated in reply to the request.", "properties": { "id": { "readOnly": true, "type": "string" }, "integration": { "example": "quickbooks", "nullable": false, "description": "The key of the integration source\ne.g. \"quickbooks\", or \"xero\"", "type": "string" }, "srcId": { "description": "Unique identifier for the support ticket", "type": "string" }, "subject": { "description": "A short description of the ticket", "type": "string", "nullable": true }, "created": { "description": "When the ticket was created", "type": "string" }, "status": { "description": "The status of the ticket\ne.g. \"OPEN\"", "type": "string", "nullable": true } } }, "Task": { "type": "object", "description": "", "properties": { "id": { "readOnly": true, "type": "string" }, "integration": { "example": "quickbooks", "nullable": false, "description": "The key of the integration source\ne.g. \"quickbooks\", or \"xero\"", "type": "string" }, "srcId": { "description": "the unique identifier of the source 3rd party integration", "type": "string" }, "ownerId": { "description": "ID of the person the task is assigned to", "type": "string", "nullable": true }, "ownerName": { "description": "name of the person the task is assigned to", "type": "string", "nullable": true }, "subject": { "description": "subject of the task", "type": "string", "nullable": true }, "status": { "description": "status of the task\ne.g: done\ne.g: not started", "type": "string", "nullable": true }, "priority": { "description": "priority of the task\ne.g: high", "type": "string", "nullable": true }, "dueDate": { "description": "due date of the task", "type": "string", "format": "date-time", "nullable": true }, "description": { "description": "details about the task", "type": "string", "nullable": true }, "recurringActivity": { "description": "if it's a recurring activity", "type": "string", "nullable": true }, "created": { "description": "date and time the task is created", "type": "string", "format": "date-time", "nullable": true }, "modified": { "description": "date and time the task is modified", "type": "string", "format": "date-time", "nullable": true } } }, "TaxAgency": { "type": "object", "description": "", "properties": { "id": { "readOnly": true, "type": "string" }, "integration": { "example": "quickbooks", "nullable": false, "description": "The key of the integration source\ne.g. \"quickbooks\", or \"xero\"", "type": "string" }, "name": { "type": "string" }, "taxOnSales": { "description": "Boolean on if tax is applied to each sale", "type": "boolean" }, "taxOnPurchases": { "description": "Boolean on if tax is applied to each purchase", "type": "boolean" }, "taxRegistrationNum": { "description": "Tax registration number", "type": "string", "nullable": true }, "created": { "description": "Date entry was created", "type": "string", "format": "date-time", "nullable": true }, "modified": { "description": "Date entry was last modified", "type": "string", "format": "date-time", "nullable": true } } }, "TaxRate": { "type": "object", "description": "", "properties": { "id": { "readOnly": true, "type": "string" }, "integration": { "example": "quickbooks", "nullable": false, "description": "The key of the integration source\ne.g. \"quickbooks\", or \"xero\"", "type": "string" }, "name": { "type": "string" }, "taxRate": { "type": "string", "nullable": true }, "taxType": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "active": { "type": "boolean", "nullable": true }, "created": { "type": "string", "format": "date-time", "nullable": true }, "modified": { "type": "string", "format": "date-time", "nullable": true } } }, "Term": { "type": "object", "description": "", "properties": { "id": { "readOnly": true, "type": "string" }, "integration": { "example": "quickbooks", "nullable": false, "description": "The key of the integration source\ne.g. \"quickbooks\", or \"xero\"", "type": "string" }, "name": { "description": "Name for the term\ne.g. Net 30", "type": "string" }, "type": { "description": "Type of the Sales term\ne.g. STANDARD", "type": "string", "nullable": true }, "discountPercent": { "description": "Discount percentage available against an amount if paid with discount days.", "type": "string", "nullable": true }, "discountDays": { "description": "Discount applies if paid within this number of days", "type": "integer", "nullable": true }, "dayOfMonthDue": { "description": "Payment must be received by this day of the month", "type": "integer", "nullable": true }, "discountDayOfMonth": { "description": "Discount applies if paid before this day of month", "type": "integer", "nullable": true }, "dueNextMonthDays": { "description": "Payment due next month if issued that many days before the day of month due.", "type": "integer", "nullable": true }, "dueDays": { "description": "NUmber of days from delivery of goods/services until the payment is due", "type": "integer", "nullable": true }, "active": { "description": "Whether or not the entity is enabled for use by the application", "type": "boolean" }, "created": { "description": "Date and time the term was created", "type": "string", "nullable": true }, "modified": { "description": "Date and time the term was last modified", "type": "string", "nullable": true }, "directory": { "type": "string", "nullable": true } } }, "TrackingCategory": { "type": "object", "description": "Tracking category represents categories defined for report generation and tracking", "properties": { "id": { "readOnly": true, "type": "string" }, "integration": { "example": "quickbooks", "nullable": false, "description": "The key of the integration source\ne.g. \"quickbooks\", or \"xero\"", "type": "string" }, "srcId": { "description": "Unique identifier for each tracking category", "type": "string" }, "name": { "description": "Name of tracking category\ne.g. \"Department\"\ne.g. \"Region\"", "type": "string" }, "status": { "description": "Status of tracking category", "type": "string" }, "trackingOptionId": { "description": "Unique ID of tracking option", "type": "string", "nullable": true }, "trackingOptionName": { "description": "Name of tracking option\ne.g. \"Marketing\"", "type": "string", "nullable": true }, "trackingOptionStatus": { "description": "The status of a tracking option", "type": "string", "nullable": true } } }, "Transaction": { "type": "object", "description": "", "properties": { "id": { "readOnly": true, "type": "string" }, "integration": { "example": "quickbooks", "nullable": false, "description": "The key of the integration source\ne.g. \"quickbooks\", or \"xero\"", "type": "string" }, "srcId": { "description": "The unique identifier of the source 3rd party integration", "type": "string" }, "transactionType": { "description": "Transaction type\ne.g. Payment", "type": "string", "nullable": true }, "success": { "description": "True of false on if transaction went through", "type": "string", "nullable": true }, "amount": { "description": "Amount of the transaction in cents\ne.g: 870", "type": "integer", "nullable": true }, "description": { "description": "Transaction description", "type": "string", "nullable": true }, "transactionId": { "description": "Transaction Id", "type": "string", "nullable": true }, "paymentId": { "description": "Payment Id", "type": "string", "nullable": true }, "productId": { "description": "Product Id", "type": "string", "nullable": true }, "taxId": { "description": "Tax Id", "type": "string", "nullable": true }, "componentId": { "description": "Component Id", "type": "string", "nullable": true }, "statementId": { "description": "Statement Id", "type": "string", "nullable": true }, "customerId": { "description": "Id of the customer made he transaction", "type": "string", "nullable": true }, "created": { "description": "Date and time the transaction is first created", "type": "string", "format": "date-time", "nullable": true }, "status": { "description": "Status of the transaction\ne.g: success", "type": "string", "nullable": true }, "fee": { "description": "Transaction fees", "type": "integer", "nullable": true }, "netAmount": { "description": "Net amount of transaction", "type": "integer", "nullable": true }, "txnDate": { "description": "Transaction date", "type": "string", "format": "date-time", "nullable": true } } }, "TransactionMatchReport": { "type": "object", "description": "Provides a transaction match report showing which transactions match in banking data sources and accounting data sources", "properties": { "start": { "type": "string", "format": "date", "example": "2022-07-01" }, "end": { "type": "string", "format": "date", "example": "2022-08-31" }, "summary": { "type": "object", "properties": { "bankMatchedCount": { "type": "integer" }, "bankTotalCount": { "type": "integer" }, "bankMatchedAmount": { "type": "number", "format": "float" }, "bankTotalAmount": { "type": "number", "format": "float" }, "accountingMatchedCount": { "type": "integer" }, "accountingTotalCount": { "type": "integer" }, "accountingMatchedAmount": { "type": "number", "format": "float" }, "accountingTotalAmount": { "type": "number", "format": "float" }, "overallMatchedCount": { "type": "integer" }, "overallTotalCount": { "type": "integer" }, "overallMatchedAmount": { "type": "number", "format": "float" }, "overallTotalAmount": { "type": "number", "format": "float" } }, "example": { "bankMatchedCount": 1, "bankTotalCount": 2, "bankMatchedAmount": 316.85, "bankTotalAmount": 763.84, "accountingMatchedCount": 1, "accountingTotalCount": 2, "accountingMatchedAmount": 316.85, "accountingTotalAmount": 592.86, "overallMatchedCount": 2, "overallTotalCount": 4, "overallMatchedAmount": 633.7, "overallTotalAmount": 1356.7 } }, "details": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "BANK", "ACCOUNTING" ] }, "bank_transaction_id": { "type": "string" }, "bank_txn_type": { "type": "string", "enum": [ "DEBIT", "CREDIT" ] }, "bank_total_amount": { "type": "number", "format": "float" }, "bank_currency": { "type": "string" }, "bank_date": { "type": "string", "format": "date" }, "bank_merchant": { "type": "string" }, "bank_description": { "type": "string" }, "bank_category": { "type": "string" }, "accounting_table": { "type": "string" }, "accounting_table_id": { "type": "string" }, "accounting_txn_type": { "type": "string", "enum": [ "DEBIT", "CREDIT" ] }, "accounting_total_amount": { "type": "number", "format": "float" }, "accounting_currency": { "type": "string" }, "accounting_date": { "type": "string", "format": "date" }, "accounting_merchant": { "type": "string" }, "accounting_description": { "type": "string" }, "accounting_category": { "type": "string" }, "has_match": { "type": "boolean" } } }, "example": [ { "type": "BANK", "bank_transaction_id": "003dafbc-9d3a-4772-9a88-72c5d0786f83", "bank_txn_type": "CREDIT", "bank_total_amount": 446.99, "bank_currency": "USD", "bank_date": "2022-08-17", "bank_merchant": null, "bank_description": "Dolor sit amet", "bank_category": null, "accounting_table": null, "accounting_table_id": null, "accounting_txn_type": null, "accounting_total_amount": null, "accounting_currency": null, "accounting_date": null, "accounting_merchant": null, "accounting_description": null, "accounting_category": null, "has_match": false }, { "type": "ACCOUNTING", "bank_transaction_id": null, "bank_txn_type": null, "bank_total_amount": null, "bank_currency": null, "bank_date": null, "bank_merchant": null, "bank_description": null, "bank_category": null, "accounting_table": "expense", "accounting_table_id": "c851a382-f5ef-4ca5-9d4c-fe5afc52ce81", "accounting_txn_type": "DEBIT", "accounting_total_amount": 276.01, "accounting_currency": "USD", "accounting_date": "2022-07-11 00:00:00", "accounting_merchant": null, "accounting_description": "Yippee ki yay", "accounting_category": null, "has_match": false }, { "type": "ACCOUNTING", "bank_transaction_id": "0073ecc5-0158-48a9-b148-33cb082c156c", "bank_txn_type": "DEBIT", "bank_total_amount": 316.85, "bank_currency": "USD", "bank_date": "2022-03-22", "bank_merchant": null, "bank_description": "Lorem ipsum", "bank_category": null, "accounting_table": "expense", "accounting_table_id": "f7c7dd07-dfcf-4a65-8a69-cf6a00b54194", "accounting_txn_type": "DEBIT", "accounting_total_amount": 316.85, "accounting_currency": "USD", "accounting_date": "2022-03-22 00:00:00", "accounting_merchant": null, "accounting_description": "Lorem ipsum", "accounting_category": null, "has_match": true }, { "type": "BANK", "bank_transaction_id": "0073ecc5-0158-48a9-b148-33cb082c156c", "bank_txn_type": "DEBIT", "bank_total_amount": 316.85, "bank_currency": "USD", "bank_date": "2022-03-22", "bank_merchant": null, "bank_description": "Lorem ipsum", "bank_category": null, "accounting_table": "expense", "accounting_table_id": "f7c7dd07-dfcf-4a65-8a69-cf6a00b54194", "accounting_txn_type": "DEBIT", "accounting_total_amount": 316.85, "accounting_currency": "USD", "accounting_date": "2022-03-22 00:00:00", "accounting_merchant": null, "accounting_description": "Lorem ipsum", "accounting_category": null, "has_match": true } ] } } }, "TransactionMatchSeries": { "type": "object", "description": "Provides a monthly series of transaction match reports showing which transactions match in banking data sources and accounting data sources", "properties": { "start": { "type": "string", "format": "date", "example": "2022-07-01" }, "end": { "type": "string", "format": "date", "example": "2022-08-31" }, "series": { "type": "array", "items": { "type": "object", "properties": { "start": { "type": "string", "format": "date" }, "end": { "type": "string", "format": "date" }, "summary": { "type": "object", "properties": { "bankMatchedCount": { "type": "integer" }, "bankTotalCount": { "type": "integer" }, "bankMatchedAmount": { "type": "number", "format": "float" }, "bankTotalAmount": { "type": "number", "format": "float" }, "accountingMatchedCount": { "type": "integer" }, "accountingTotalCount": { "type": "integer" }, "accountingMatchedAmount": { "type": "number", "format": "float" }, "accountingTotalAmount": { "type": "number", "format": "float" }, "overallMatchedCount": { "type": "integer" }, "overallTotalCount": { "type": "integer" }, "overallMatchedAmount": { "type": "number", "format": "float" }, "overallTotalAmount": { "type": "number", "format": "float" } } }, "details": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "BANK", "ACCOUNTING" ] }, "bank_transaction_id": { "type": "string" }, "bank_txn_type": { "type": "string", "enum": [ "DEBIT", "CREDIT" ] }, "bank_total_amount": { "type": "number", "format": "float" }, "bank_currency": { "type": "string" }, "bank_date": { "type": "string", "format": "date" }, "bank_merchant": { "type": "string" }, "bank_description": { "type": "string" }, "bank_category": { "type": "string" }, "accounting_table": { "type": "string" }, "accounting_table_id": { "type": "string" }, "accounting_txn_type": { "type": "string", "enum": [ "DEBIT", "CREDIT" ] }, "accounting_total_amount": { "type": "number", "format": "float" }, "accounting_currency": { "type": "string" }, "accounting_date": { "type": "string", "format": "date" }, "accounting_merchant": { "type": "string" }, "accounting_description": { "type": "string" }, "accounting_category": { "type": "string" }, "has_match": { "type": "boolean" } } } } } }, "example": [ { "start": "2022-07-01", "end": "2022-07-31", "summary": { "bankMatchedCount": 0, "bankTotalCount": 1, "bankMatchedAmount": 0, "bankTotalAmount": 446.99, "accountingMatchedCount": 0, "accountingTotalCount": 1, "accountingMatchedAmount": 0, "accountingTotalAmount": 276.01, "overallMatchedCount": 0, "overallTotalCount": 2, "overallMatchedAmount": 0, "overallTotalAmount": 723 }, "details": [ { "type": "BANK", "bank_transaction_id": "003dafbc-9d3a-4772-9a88-72c5d0786f83", "bank_txn_type": "CREDIT", "bank_total_amount": 446.99, "bank_currency": "USD", "bank_date": "2022-08-17", "bank_merchant": null, "bank_description": "Dolor sit amet", "bank_category": null, "accounting_table": null, "accounting_table_id": null, "accounting_txn_type": null, "accounting_total_amount": null, "accounting_currency": null, "accounting_date": null, "accounting_merchant": null, "accounting_description": null, "accounting_category": null, "has_match": false }, { "type": "ACCOUNTING", "bank_transaction_id": null, "bank_txn_type": null, "bank_total_amount": null, "bank_currency": null, "bank_date": null, "bank_merchant": null, "bank_description": null, "bank_category": null, "accounting_table": "expense", "accounting_table_id": "c851a382-f5ef-4ca5-9d4c-fe5afc52ce81", "accounting_txn_type": "DEBIT", "accounting_total_amount": 276.01, "accounting_currency": "USD", "accounting_date": "2022-07-11 00:00:00", "accounting_merchant": null, "accounting_description": "Yippee ki yay", "accounting_category": null, "has_match": false } ] }, { "start": "2022-08-01", "end": "2022-08-31", "summary": { "bankMatchedCount": 1, "bankTotalCount": 1, "bankMatchedAmount": 316.85, "bankTotalAmount": 316.85, "accountingMatchedCount": 1, "accountingTotalCount": 1, "accountingMatchedAmount": 316.85, "accountingTotalAmount": 316.85, "overallMatchedCount": 2, "overallTotalCount": 2, "overallMatchedAmount": 633.7, "overallTotalAmount": 633.7 }, "details": [ { "type": "ACCOUNTING", "bank_transaction_id": "0073ecc5-0158-48a9-b148-33cb082c156c", "bank_txn_type": "DEBIT", "bank_total_amount": 316.85, "bank_currency": "USD", "bank_date": "2022-03-22", "bank_merchant": null, "bank_description": "Lorem ipsum", "bank_category": null, "accounting_table": "expense", "accounting_table_id": "f7c7dd07-dfcf-4a65-8a69-cf6a00b54194", "accounting_txn_type": "DEBIT", "accounting_total_amount": 316.85, "accounting_currency": "USD", "accounting_date": "2022-03-22 00:00:00", "accounting_merchant": null, "accounting_description": "Lorem ipsum", "accounting_category": null, "has_match": true }, { "type": "BANK", "bank_transaction_id": "0073ecc5-0158-48a9-b148-33cb082c156c", "bank_txn_type": "DEBIT", "bank_total_amount": 316.85, "bank_currency": "USD", "bank_date": "2022-03-22", "bank_merchant": null, "bank_description": "Lorem ipsum", "bank_category": null, "accounting_table": "expense", "accounting_table_id": "f7c7dd07-dfcf-4a65-8a69-cf6a00b54194", "accounting_txn_type": "DEBIT", "accounting_total_amount": 316.85, "accounting_currency": "USD", "accounting_date": "2022-03-22 00:00:00", "accounting_merchant": null, "accounting_description": "Lorem ipsum", "accounting_category": null, "has_match": true } ] } ] } } }, "TrialBalance": { "type": "object", "description": "", "properties": { "id": { "readOnly": true, "type": "string" }, "integration": { "example": "quickbooks", "nullable": false, "description": "The key of the integration source\ne.g. \"quickbooks\", or \"xero\"", "type": "string" }, "reportTitle": { "example": "Trial Balance", "nullable": true, "type": "string" }, "companyName": { "example": "Flux Capacitors Inc", "nullable": true, "type": "string" }, "columns": { "type": "array", "items": { "type": "string" }, "nullable": true }, "rows": { "type": "array", "items": { "type": "string" }, "nullable": true }, "accountingMethod": { "example": "cash", "nullable": true, "type": "string" }, "start": { "type": "string", "format": "date-time", "nullable": true }, "end": { "type": "string", "format": "date-time", "nullable": true }, "currencyCode": { "example": "USD", "nullable": true, "type": "string" }, "deleted": { "type": "boolean" } } }, "UnbilledCharge": { "type": "object", "description": "", "properties": { "id": { "readOnly": true, "type": "string" }, "integration": { "example": "quickbooks", "nullable": false, "description": "The key of the integration source\ne.g. \"quickbooks\", or \"xero\"", "type": "string" }, "srcId": { "description": "Unique identifier for the customer\ne.g. \"1\"", "type": "string" }, "amount": { "description": "Amount from unbilled charge", "type": "string", "nullable": true }, "currencyCode": { "description": "Currency code", "type": "string", "nullable": true }, "customerId": { "description": "Customer Id", "type": "string", "nullable": true }, "subscriptionId": { "description": "Subscription Id", "type": "string", "nullable": true }, "description": { "description": "Description of unbilled charge\ne.g. No Trial", "type": "string", "nullable": true }, "quantity": { "description": "Quantity of unbilled charges", "type": "integer", "nullable": true }, "created": { "description": "Date entry was created", "type": "string", "format": "date-time", "nullable": true }, "dueDate": { "description": "Due date on unbilled charge", "type": "string", "format": "date-time", "nullable": true } } }, "User": { "type": "object", "description": "", "properties": { "id": { "readOnly": true, "type": "string" }, "integration": { "example": "quickbooks", "nullable": false, "description": "The key of the integration source\ne.g. \"quickbooks\", or \"xero\"", "type": "string" }, "srcId": { "description": "the unique identifier of the source 3rd party integration", "type": "string" }, "email": { "description": "User email address", "type": "string", "nullable": true }, "lastName": { "description": "User last name", "type": "string", "nullable": true }, "firstName": { "description": "User first name", "type": "string", "nullable": true }, "modified": { "description": "Date and time user information last modified", "type": "string", "format": "date-time", "nullable": true }, "role": { "description": "User role in the company", "type": "string", "nullable": true }, "primaryPhone": { "description": "Piamry phone number", "type": "string", "nullable": true }, "addressLine1": { "description": "User location line1 address", "type": "string", "nullable": true }, "city": { "description": "User location line2 address", "type": "string", "nullable": true }, "country": { "description": "User location country address", "type": "string", "nullable": true }, "postalCode": { "description": "User location postalcode", "type": "string", "nullable": true }, "company": { "description": "The company user works in", "type": "string", "nullable": true }, "profileUrl": { "description": "A URL that can be used to view the user's information without logging in.", "type": "string", "nullable": true }, "department": { "description": "The department user works in", "type": "string", "nullable": true }, "created": { "description": "When the user objects created", "type": "string", "format": "date-time", "nullable": true }, "name": { "description": "Name of the user", "type": "string", "nullable": true } } }, "Vendor": { "type": "object", "description": "", "properties": { "id": { "example": "quickbooks-726", "nullable": false, "readOnly": true, "description": "Unique identifier for this vendor\nnote that no particular pattern in this field is guaranteed, only that this field is unique\ne.g: \"quickbooks-726\"", "type": "string" }, "integration": { "example": "quickbooks", "nullable": false, "description": "The key of the integration source\ne.g. \"quickbooks\", or \"xero\"", "type": "string" }, "srcId": { "example": "GH2JK-67283H-YW82KHX-2883KK-KS78S", "nullable": false, "description": "The unique identifier of the source 3rd party integration\ne.g. \"GH2JK-67283H-YW82KHX-2883KK-KS78S\"", "type": "string" }, "givenName": { "example": "Jane", "nullable": true, "description": "First name of the vendor\ne.g. \"Jane\"", "type": "string" }, "familyName": { "example": "Doe", "nullable": true, "description": "Last name of the vendor\ne.g. \"Doe\"", "type": "string" }, "companyName": { "example": "Doyle-Koch LLC", "nullable": true, "description": "Name of the company\ne.g. \"Doyle-Koch LLC\"", "type": "string" }, "displayName": { "example": "Doyle-Koch", "nullable": true, "description": "Name displayed for vendor\n e.g. \"Doyle-Koch\"", "type": "string" }, "contactName": { "example": "John Smith", "nullable": true, "description": "Name of the main contact for the vendor\n e.g. \"John Smith\"", "type": "string" }, "contactTitle": { "example": "Account Manager", "nullable": true, "description": "Title of the main contact for the vendor\n e.g. \"Account Manager\"", "type": "string" }, "accountNumber": { "example": "420042", "nullable": true, "description": "Account number for the vendor\n e.g. \"420042\"", "type": "string" }, "phone": { "example": "281-381-4241", "nullable": true, "description": "Phone number\n e.g. \"281-381-4241\"", "type": "string" }, "mobile": { "example": "786-258-0182", "nullable": true, "description": "Mobile number\n e.g. \"786-258-0182\"", "type": "string" }, "fax": { "example": "281-381-4255", "nullable": true, "description": "Fax number\n e.g. \"281-381-4255\"", "type": "string" }, "email": { "example": "doyle-koch@email.com", "nullable": true, "description": "Email address for the vendor\ne.g. \"doyle-koch@email.com\"", "type": "string" }, "website": { "example": "https://www.doylekoch.com", "nullable": true, "description": "Vendor website\n e.g. \"https://www.doylekoch.com\"", "type": "string" }, "address": { "example": "708 Woodland Avenue", "nullable": true, "description": "First line of vendor address\ne.g. \"708 Woodland Avenue\"", "type": "string" }, "addressLine2": { "example": "Unit 105", "nullable": true, "description": "Vendor address line 2\ne.g. \"Unit 105\"", "type": "string" }, "city": { "example": "St Paul", "nullable": true, "description": "City of the address\ne.g. \"St Paul\"", "type": "string" }, "state": { "example": "Alaska", "nullable": true, "description": "Vendor state address\ne.g. \"Alaska\"", "type": "string" }, "country": { "example": "United States", "nullable": true, "description": "Country of the address\n * e.g. \"United States\"", "type": "string" }, "postalCode": { "example": "99660", "nullable": true, "description": "Postal code of the address\n * e.g. \"99660\"", "type": "string" }, "currency": { "example": "USD", "nullable": true, "description": "Currency code used by vendor\ne.g. \"USD\"", "type": "string" }, "balance": { "example": 650000, "nullable": true, "description": "Balance in ledger for vendor in cents\ne.g. 650000", "type": "integer" }, "bankAccountName": { "example": "Business Bank Account", "nullable": true, "description": "Bank account name associated with the vendor\ne.g. \"Business Bank Account\"", "type": "string" }, "bankAccountNumber": { "example": "123654", "nullable": true, "description": "Bank acount number associated with the vendor\ne.g. \"123654\"", "type": "string" }, "notes": { "example": "Quality vendor", "nullable": true, "description": "Additional note attached to vendor\ne.g. \"Quality vendor\"", "type": "string" }, "taxType": { "example": "Global", "nullable": true, "description": "Type of tax applied to vendor\ne.g. \"Global\"", "type": "string" }, "isContractor": { "example": true, "nullable": true, "description": "Whether the vendor is a contractor", "type": "boolean" }, "active": { "example": true, "nullable": true, "description": "Whether the vendor is active", "type": "boolean" }, "created": { "example": "2013-11-18T02:17:40.080Z", "nullable": true, "description": "Date of vendor account creation\ne.g. \"2013-11-18T02:17:40.080Z\"", "type": "string", "format": "date-time" }, "modified": { "example": "2013-11-22T02:17:40.080Z", "nullable": true, "description": "Date entry was last modified\ne.g. \"2013-11-22T02:17:40.080Z\"", "type": "string", "format": "date-time" }, "termId": { "example": "1d80716b-427e-4cad-80c6-c4b3a18eb23d", "nullable": true, "description": "Reference to a Term object (payment terms) associated with this Vendor\ne.g. \"1d80716b-427e-4cad-80c6-c4b3a18eb23d\"", "type": "string" }, "termDays": { "example": "15", "nullable": true, "description": "The days value of the payment terms for this Vendor\ne.g. \"15\"", "type": "integer" }, "termType": { "example": "DAYSAFTERBILLDATE", "nullable": true, "description": "The type of the payment terms for this Vendor\ne.g. \"DAYSAFTERBILLDATE\"", "type": "string" } } }, "VendorCredit": { "type": "object", "description": "", "properties": { "id": { "example": "quickbooks-321", "nullable": false, "readOnly": true, "type": "string" }, "integration": { "example": "quickbooks", "nullable": false, "description": "The key of the integration source\ne.g. \"quickbooks\", or \"xero\"", "type": "string" }, "srcId": { "example": "3000000002075", "nullable": false, "description": "the unique identifier of the source 3rd party integration\ne.g. \"3000000002075\"", "type": "string" }, "date": { "example": "2014-08-28", "nullable": true, "description": "The date the vendor credit was created\ne.g. \"2014-08-28\"", "type": "string" }, "status": { "example": "open", "nullable": true, "description": "Status of recurring expense\ne.g. \"open\"", "type": "string" }, "vendorId": { "example": "460000000020029", "nullable": true, "description": "ID of the vendor the vendor credit is associated with\ne.g. \"460000000020029\"", "type": "string" }, "vendorName": { "example": "Bowman and Co", "nullable": true, "description": "Name of the vendor the vendor credit is associated with\ne.g. \"Bowman and Co\"", "type": "string" }, "currency": { "example": "USD", "nullable": true, "description": "Currency code\ne.g. \"USD\"", "type": "string" }, "subtotal": { "example": 3000, "nullable": true, "description": "Subtotal of the vendor credits in cents\ne.g. 3000", "type": "integer" }, "totalAmount": { "example": 3500, "nullable": true, "description": "Total amount of the vendor credits in cents\ne.g. 3500", "type": "integer" }, "balance": { "example": 2150, "nullable": true, "description": "Balance in the vendor credit in cents\ne.g. 2150", "type": "integer" }, "created": { "example": "2014-08-28T22:53:31-0700", "nullable": true, "description": "Time of the vendor credit creation\ne.g. \"2014-08-28T22:53:31-0700\"", "type": "string", "format": "date-time" }, "modified": { "example": "2014-08-28T22:53:31-0700", "nullable": true, "description": "Last modified time of vendor credit\ne.g. \"2014-08-28T22:53:31-0700\"", "type": "string", "format": "date-time" } }, "required": [ "totalAmount" ] }, "VendorPayment": { "type": "object", "description": "", "properties": { "id": { "example": "quickbooks-321", "nullable": false, "readOnly": true, "type": "string" }, "integration": { "example": "quickbooks", "nullable": false, "description": "The key of the integration source\ne.g. \"quickbooks\", or \"xero\"", "type": "string" }, "srcId": { "example": "460000000053219", "nullable": false, "description": "the unique identifier of the source 3rd party integration\ne.g. \"460000000053219\"", "type": "string" }, "vendorId": { "example": "460000000026049", "nullable": true, "description": "Unique identifier for the vendor\ne.g. \"460000000026049\"", "type": "string" }, "vendorName": { "example": "Bowman and Co", "nullable": true, "description": "Name of the vendor\ne.g. \"Bowman and Co\"", "type": "string" }, "paymentMode": { "example": "Stripe", "nullable": true, "description": "Mode of vendor payment\ne.g. \"Stripe\"", "type": "string" }, "txnDate": { "example": "2013-10-07", "nullable": true, "description": "Date the payment is made\ne.g. \"2013-10-07\"", "type": "string", "format": "date-time" }, "referenceNumber": { "example": "REF#912300", "nullable": true, "description": "Reference number for the vendor payment recorded\ne.g. REF#912300", "type": "string" }, "amount": { "example": 12500, "nullable": true, "description": "Total amount of the vendor payment in cents\ne.g. 12500", "type": "integer" }, "balance": { "example": 3500, "nullable": true, "description": "Balance due for the bill in cents\ne.g. 3500", "type": "integer" }, "currency": { "example": "USD", "nullable": true, "description": "Currency code\ne.g. \"USD\"", "type": "string" }, "created": { "example": "2016-12-16T00:18:42-0500", "nullable": true, "description": "Creation time of the vendor payment\ne.g. 2016-12-16T00:18:42-0500", "type": "string", "format": "date-time" }, "modified": { "example": "2016-12-16T00:18:42-0500", "nullable": true, "description": "Last modified time of the vendor payment\ne.g. 2016-12-16T00:18:42-0500", "type": "string", "format": "date-time" } }, "required": [ "amount" ] }, "Workflow": { "type": "object", "description": "Workflows represent sophisticated marketing automation campaigns that rely on triggering relevant and timely actions (like emails) for contacts in their database", "properties": { "id": { "readOnly": true, "type": "string" }, "integration": { "example": "quickbooks", "nullable": false, "description": "The key of the integration source\ne.g. \"quickbooks\", or \"xero\"", "type": "string" }, "srcId": { "description": "Unique identifier for each workflow", "type": "string" }, "created": { "description": "The time and date the workflow was created", "type": "string" }, "updated": { "description": "The time and date the workflow was last updated.", "type": "string", "nullable": true }, "isActive": { "description": "Whether the workflow is active or not", "type": "boolean", "nullable": true }, "type": { "description": "Whether the workflow is based on enrollment or revolves around a static/dynamic date.", "type": "string", "nullable": true } } } }, "responses": {}, "parameters": {}, "examples": {}, "requestBodies": {}, "headers": {}, "securitySchemes": { "BasicAuth": { "type": "http", "scheme": "basic" } } }, "security": [ { "BasicAuth": [] } ], "tags": [] }